mirror of
https://github.com/aljazceru/kata-containers.git
synced 2025-12-27 02:54:27 +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>
70 lines
2.3 KiB
Go
70 lines
2.3 KiB
Go
// Copyright (c) 2017 Uber Technologies, Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package jaeger
|
|
|
|
import (
|
|
"time"
|
|
)
|
|
|
|
// ReporterOption is a function that sets some option on the reporter.
|
|
type ReporterOption func(c *reporterOptions)
|
|
|
|
// ReporterOptions is a factory for all available ReporterOption's
|
|
var ReporterOptions reporterOptions
|
|
|
|
// reporterOptions control behavior of the reporter.
|
|
type reporterOptions struct {
|
|
// queueSize is the size of internal queue where reported spans are stored before they are processed in the background
|
|
queueSize int
|
|
// bufferFlushInterval is how often the buffer is force-flushed, even if it's not full
|
|
bufferFlushInterval time.Duration
|
|
// logger is used to log errors of span submissions
|
|
logger Logger
|
|
// metrics is used to record runtime stats
|
|
metrics *Metrics
|
|
}
|
|
|
|
// QueueSize creates a ReporterOption that sets the size of the internal queue where
|
|
// spans are stored before they are processed.
|
|
func (reporterOptions) QueueSize(queueSize int) ReporterOption {
|
|
return func(r *reporterOptions) {
|
|
r.queueSize = queueSize
|
|
}
|
|
}
|
|
|
|
// Metrics creates a ReporterOption that initializes Metrics in the reporter,
|
|
// which is used to record runtime statistics.
|
|
func (reporterOptions) Metrics(metrics *Metrics) ReporterOption {
|
|
return func(r *reporterOptions) {
|
|
r.metrics = metrics
|
|
}
|
|
}
|
|
|
|
// BufferFlushInterval creates a ReporterOption that sets how often the queue
|
|
// is force-flushed.
|
|
func (reporterOptions) BufferFlushInterval(bufferFlushInterval time.Duration) ReporterOption {
|
|
return func(r *reporterOptions) {
|
|
r.bufferFlushInterval = bufferFlushInterval
|
|
}
|
|
}
|
|
|
|
// Logger creates a ReporterOption that initializes the logger used to log
|
|
// errors of span submissions.
|
|
func (reporterOptions) Logger(logger Logger) ReporterOption {
|
|
return func(r *reporterOptions) {
|
|
r.logger = logger
|
|
}
|
|
}
|