mirror of
https://github.com/aljazceru/kata-containers.git
synced 2026-02-22 15:04:32 +01:00
3a1bbd0271
Add initial support for opentracing by using the `jaeger` package.
Since opentracing uses the `context` package, add a `context.Context`
as the first parameter to all the functions that we might want to
trace. Trace "spans" (trace points) are then added by extracting the
trace details from the specified context parameter.
Notes:
- Although the tracer is created in `main()`, the "root span"
(aka the first trace point) is not added until `beforeSubcommands()`.
This is by design and is a compromise: by delaying the creation of the
root span, the spans become much more readable since using the web-based
JaegerUI, you will see traces like this:
```
kata-runtime: kata-runtime create
------------ -------------------
^ ^
| |
Trace name First span name
(which clearly shows the CLI command that was run)
```
Creating the span earlier means it is necessary to expand 'n' spans in
the UI before you get to see the name of the CLI command that was run.
In adding support, this became very tedious, hence my design decision to
defer the creation of the root span until after signal handling has been
setup and after CLI options have been parsed, but still very early in
the code path.
- At this stage, the tracing stops at the `virtcontainers` call
boundary.
- Tracing is "always on" as there doesn't appear to be a way to toggle
it. However, its resolves to a "nop" unless the tracer can talk to a
jaeger agent.
Note that this commit required a bit of rework to `beforeSubcommands()`
to reduce the cyclomatic complexity.
Fixes #557.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
197 lines
7.4 KiB
TOML
197 lines
7.4 KiB
TOML
# Copyright (c) 2017-2018 Intel Corporation
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
|
|
# XXX: WARNING: this file is auto-generated.
|
|
# XXX:
|
|
# XXX: Source file: "@CONFIG_IN@"
|
|
# XXX: Project:
|
|
# XXX: Name: @PROJECT_NAME@
|
|
# XXX: Type: @PROJECT_TYPE@
|
|
|
|
[hypervisor.qemu]
|
|
path = "@QEMUPATH@"
|
|
kernel = "@KERNELPATH@"
|
|
initrd = "@INITRDPATH@"
|
|
image = "@IMAGEPATH@"
|
|
machine_type = "@MACHINETYPE@"
|
|
|
|
# Optional space-separated list of options to pass to the guest kernel.
|
|
# For example, use `kernel_params = "vsyscall=emulate"` if you are having
|
|
# trouble running pre-2.15 glibc.
|
|
#
|
|
# WARNING: - any parameter specified here will take priority over the default
|
|
# parameter value of the same name used to start the virtual machine.
|
|
# Do not set values here unless you understand the impact of doing so as you
|
|
# may stop the virtual machine from booting.
|
|
# To see the list of default parameters, enable hypervisor debug, create a
|
|
# container and look for 'default-kernel-parameters' log entries.
|
|
kernel_params = "@KERNELPARAMS@"
|
|
|
|
# Path to the firmware.
|
|
# If you want that qemu uses the default firmware leave this option empty
|
|
firmware = "@FIRMWAREPATH@"
|
|
|
|
# Machine accelerators
|
|
# comma-separated list of machine accelerators to pass to the hypervisor.
|
|
# For example, `machine_accelerators = "nosmm,nosmbus,nosata,nopit,static-prt,nofw"`
|
|
machine_accelerators="@MACHINEACCELERATORS@"
|
|
|
|
# Default number of vCPUs per SB/VM:
|
|
# unspecified or 0 --> will be set to @DEFVCPUS@
|
|
# < 0 --> will be set to the actual number of physical cores
|
|
# > 0 <= number of physical cores --> will be set to the specified number
|
|
# > number of physical cores --> will be set to the actual number of physical cores
|
|
default_vcpus = 1
|
|
|
|
# Default maximum number of vCPUs per SB/VM:
|
|
# unspecified or == 0 --> will be set to the actual number of physical cores or to the maximum number
|
|
# of vCPUs supported by KVM if that number is exceeded
|
|
# > 0 <= number of physical cores --> will be set to the specified number
|
|
# > number of physical cores --> will be set to the actual number of physical cores or to the maximum number
|
|
# of vCPUs supported by KVM if that number is exceeded
|
|
# WARNING: Depending of the architecture, the maximum number of vCPUs supported by KVM is used when
|
|
# the actual number of physical cores is greater than it.
|
|
# WARNING: Be aware that this value impacts the virtual machine's memory footprint and CPU
|
|
# the hotplug functionality. For example, `default_maxvcpus = 240` specifies that until 240 vCPUs
|
|
# can be added to a SB/VM, but the memory footprint will be big. Another example, with
|
|
# `default_maxvcpus = 8` the memory footprint will be small, but 8 will be the maximum number of
|
|
# vCPUs supported by the SB/VM. In general, we recommend that you do not edit this variable,
|
|
# unless you know what are you doing.
|
|
default_maxvcpus = @DEFMAXVCPUS@
|
|
|
|
# Bridges can be used to hot plug devices.
|
|
# Limitations:
|
|
# * Currently only pci bridges are supported
|
|
# * Until 30 devices per bridge can be hot plugged.
|
|
# * Until 5 PCI bridges can be cold plugged per VM.
|
|
# This limitation could be a bug in qemu or in the kernel
|
|
# Default number of bridges per SB/VM:
|
|
# unspecified or 0 --> will be set to @DEFBRIDGES@
|
|
# > 1 <= 5 --> will be set to the specified number
|
|
# > 5 --> will be set to 5
|
|
default_bridges = @DEFBRIDGES@
|
|
|
|
# Default memory size in MiB for SB/VM.
|
|
# If unspecified then it will be set @DEFMEMSZ@ MiB.
|
|
#default_memory = @DEFMEMSZ@
|
|
|
|
# Disable block device from being used for a container's rootfs.
|
|
# In case of a storage driver like devicemapper where a container's
|
|
# root file system is backed by a block device, the block device is passed
|
|
# directly to the hypervisor for performance reasons.
|
|
# This flag prevents the block device from being passed to the hypervisor,
|
|
# 9pfs is used instead to pass the rootfs.
|
|
disable_block_device_use = @DEFDISABLEBLOCK@
|
|
|
|
# Block storage driver to be used for the hypervisor in case the container
|
|
# rootfs is backed by a block device. This is either virtio-scsi or
|
|
# virtio-blk.
|
|
block_device_driver = "@DEFBLOCKSTORAGEDRIVER@"
|
|
|
|
# Enable iothreads (data-plane) to be used. This causes IO to be
|
|
# handled in a separate IO thread. This is currently only implemented
|
|
# for SCSI.
|
|
#
|
|
enable_iothreads = @DEFENABLEIOTHREADS@
|
|
|
|
# Enable pre allocation of VM RAM, default false
|
|
# Enabling this will result in lower container density
|
|
# as all of the memory will be allocated and locked
|
|
# This is useful when you want to reserve all the memory
|
|
# upfront or in the cases where you want memory latencies
|
|
# to be very predictable
|
|
# Default false
|
|
#enable_mem_prealloc = true
|
|
|
|
# Enable huge pages for VM RAM, default false
|
|
# Enabling this will result in the VM memory
|
|
# being allocated using huge pages.
|
|
# This is useful when you want to use vhost-user network
|
|
# stacks within the container. This will automatically
|
|
# result in memory pre allocation
|
|
#enable_hugepages = true
|
|
|
|
# Enable swap of vm memory. Default false.
|
|
# The behaviour is undefined if mem_prealloc is also set to true
|
|
#enable_swap = true
|
|
|
|
# This option changes the default hypervisor and kernel parameters
|
|
# to enable debug output where available. This extra output is added
|
|
# to the proxy logs, but only when proxy debug is also enabled.
|
|
#
|
|
# Default false
|
|
#enable_debug = true
|
|
|
|
# Disable the customizations done in the runtime when it detects
|
|
# that it is running on top a VMM. This will result in the runtime
|
|
# behaving as it would when running on bare metal.
|
|
#
|
|
#disable_nesting_checks = true
|
|
|
|
# This is the msize used for 9p shares. It is the number of bytes
|
|
# used for 9p packet payload.
|
|
#msize_9p = @DEFMSIZE9P@
|
|
|
|
# If true and vsocks are supported, use vsocks to communicate directly
|
|
# with the agent and no proxy is started, otherwise use unix
|
|
# sockets and start a proxy to communicate with the agent.
|
|
# Default false
|
|
#use_vsock = true
|
|
|
|
[factory]
|
|
# VM templating support. Once enabled, new VMs are created from template
|
|
# using vm cloning. They will share the same initial kernel, initramfs and
|
|
# agent memory by mapping it readonly. It helps speeding up new container
|
|
# creation and saves a lot of memory if there are many kata containers running
|
|
# on the same host.
|
|
#
|
|
# When disabled, new VMs are created from scratch.
|
|
#
|
|
# Default false
|
|
#enable_template = true
|
|
|
|
[proxy.@PROJECT_TYPE@]
|
|
path = "@PROXYPATH@"
|
|
|
|
# If enabled, proxy messages will be sent to the system log
|
|
# (default: disabled)
|
|
#enable_debug = true
|
|
|
|
[shim.@PROJECT_TYPE@]
|
|
path = "@SHIMPATH@"
|
|
|
|
# If enabled, shim messages will be sent to the system log
|
|
# (default: disabled)
|
|
#enable_debug = true
|
|
|
|
[agent.@PROJECT_TYPE@]
|
|
# There is no field for this section. The goal is only to be able to
|
|
# specify which type of agent the user wants to use.
|
|
|
|
[runtime]
|
|
# If enabled, the runtime will log additional debug messages to the
|
|
# system log
|
|
# (default: disabled)
|
|
#enable_debug = true
|
|
#
|
|
# Internetworking model
|
|
# Determines how the VM should be connected to the
|
|
# the container network interface
|
|
# Options:
|
|
#
|
|
# - bridged
|
|
# Uses a linux bridge to interconnect the container interface to
|
|
# the VM. Works for most cases except macvlan and ipvlan.
|
|
#
|
|
# - macvtap
|
|
# Used when the Container network interface can be bridged using
|
|
# macvtap.
|
|
internetworking_model="@DEFNETWORKMODEL@"
|
|
|
|
# If enabled, the runtime will create opentracing.io traces and spans.
|
|
# (See https://www.jaegertracing.io/docs/getting-started).
|
|
# (default: disabled)
|
|
#enable_tracing = true
|