mirror of
https://github.com/aljazceru/kata-containers.git
synced 2025-12-27 02:54:27 +01:00
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>
180 lines
4.8 KiB
Go
180 lines
4.8 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"
|
|
|
|
"github.com/opentracing/opentracing-go"
|
|
|
|
j "github.com/uber/jaeger-client-go/thrift-gen/jaeger"
|
|
"github.com/uber/jaeger-client-go/utils"
|
|
)
|
|
|
|
// BuildJaegerThrift builds jaeger span based on internal span.
|
|
func BuildJaegerThrift(span *Span) *j.Span {
|
|
span.Lock()
|
|
defer span.Unlock()
|
|
startTime := utils.TimeToMicrosecondsSinceEpochInt64(span.startTime)
|
|
duration := span.duration.Nanoseconds() / int64(time.Microsecond)
|
|
jaegerSpan := &j.Span{
|
|
TraceIdLow: int64(span.context.traceID.Low),
|
|
TraceIdHigh: int64(span.context.traceID.High),
|
|
SpanId: int64(span.context.spanID),
|
|
ParentSpanId: int64(span.context.parentID),
|
|
OperationName: span.operationName,
|
|
Flags: int32(span.context.flags),
|
|
StartTime: startTime,
|
|
Duration: duration,
|
|
Tags: buildTags(span.tags),
|
|
Logs: buildLogs(span.logs),
|
|
References: buildReferences(span.references),
|
|
}
|
|
return jaegerSpan
|
|
}
|
|
|
|
// BuildJaegerProcessThrift creates a thrift Process type.
|
|
func BuildJaegerProcessThrift(span *Span) *j.Process {
|
|
span.Lock()
|
|
defer span.Unlock()
|
|
return buildJaegerProcessThrift(span.tracer)
|
|
}
|
|
|
|
func buildJaegerProcessThrift(tracer *Tracer) *j.Process {
|
|
process := &j.Process{
|
|
ServiceName: tracer.serviceName,
|
|
Tags: buildTags(tracer.tags),
|
|
}
|
|
if tracer.process.UUID != "" {
|
|
process.Tags = append(process.Tags, &j.Tag{Key: TracerUUIDTagKey, VStr: &tracer.process.UUID, VType: j.TagType_STRING})
|
|
}
|
|
return process
|
|
}
|
|
|
|
func buildTags(tags []Tag) []*j.Tag {
|
|
jTags := make([]*j.Tag, 0, len(tags))
|
|
for _, tag := range tags {
|
|
jTag := buildTag(&tag)
|
|
jTags = append(jTags, jTag)
|
|
}
|
|
return jTags
|
|
}
|
|
|
|
func buildLogs(logs []opentracing.LogRecord) []*j.Log {
|
|
jLogs := make([]*j.Log, 0, len(logs))
|
|
for _, log := range logs {
|
|
jLog := &j.Log{
|
|
Timestamp: utils.TimeToMicrosecondsSinceEpochInt64(log.Timestamp),
|
|
Fields: ConvertLogsToJaegerTags(log.Fields),
|
|
}
|
|
jLogs = append(jLogs, jLog)
|
|
}
|
|
return jLogs
|
|
}
|
|
|
|
func buildTag(tag *Tag) *j.Tag {
|
|
jTag := &j.Tag{Key: tag.key}
|
|
switch value := tag.value.(type) {
|
|
case string:
|
|
vStr := truncateString(value)
|
|
jTag.VStr = &vStr
|
|
jTag.VType = j.TagType_STRING
|
|
case []byte:
|
|
if len(value) > maxAnnotationLength {
|
|
value = value[:maxAnnotationLength]
|
|
}
|
|
jTag.VBinary = value
|
|
jTag.VType = j.TagType_BINARY
|
|
case int:
|
|
vLong := int64(value)
|
|
jTag.VLong = &vLong
|
|
jTag.VType = j.TagType_LONG
|
|
case uint:
|
|
vLong := int64(value)
|
|
jTag.VLong = &vLong
|
|
jTag.VType = j.TagType_LONG
|
|
case int8:
|
|
vLong := int64(value)
|
|
jTag.VLong = &vLong
|
|
jTag.VType = j.TagType_LONG
|
|
case uint8:
|
|
vLong := int64(value)
|
|
jTag.VLong = &vLong
|
|
jTag.VType = j.TagType_LONG
|
|
case int16:
|
|
vLong := int64(value)
|
|
jTag.VLong = &vLong
|
|
jTag.VType = j.TagType_LONG
|
|
case uint16:
|
|
vLong := int64(value)
|
|
jTag.VLong = &vLong
|
|
jTag.VType = j.TagType_LONG
|
|
case int32:
|
|
vLong := int64(value)
|
|
jTag.VLong = &vLong
|
|
jTag.VType = j.TagType_LONG
|
|
case uint32:
|
|
vLong := int64(value)
|
|
jTag.VLong = &vLong
|
|
jTag.VType = j.TagType_LONG
|
|
case int64:
|
|
vLong := int64(value)
|
|
jTag.VLong = &vLong
|
|
jTag.VType = j.TagType_LONG
|
|
case uint64:
|
|
vLong := int64(value)
|
|
jTag.VLong = &vLong
|
|
jTag.VType = j.TagType_LONG
|
|
case float32:
|
|
vDouble := float64(value)
|
|
jTag.VDouble = &vDouble
|
|
jTag.VType = j.TagType_DOUBLE
|
|
case float64:
|
|
vDouble := float64(value)
|
|
jTag.VDouble = &vDouble
|
|
jTag.VType = j.TagType_DOUBLE
|
|
case bool:
|
|
vBool := value
|
|
jTag.VBool = &vBool
|
|
jTag.VType = j.TagType_BOOL
|
|
default:
|
|
vStr := truncateString(stringify(value))
|
|
jTag.VStr = &vStr
|
|
jTag.VType = j.TagType_STRING
|
|
}
|
|
return jTag
|
|
}
|
|
|
|
func buildReferences(references []Reference) []*j.SpanRef {
|
|
retMe := make([]*j.SpanRef, 0, len(references))
|
|
for _, ref := range references {
|
|
if ref.Type == opentracing.ChildOfRef {
|
|
retMe = append(retMe, spanRef(ref.Context, j.SpanRefType_CHILD_OF))
|
|
} else if ref.Type == opentracing.FollowsFromRef {
|
|
retMe = append(retMe, spanRef(ref.Context, j.SpanRefType_FOLLOWS_FROM))
|
|
}
|
|
}
|
|
return retMe
|
|
}
|
|
|
|
func spanRef(ctx SpanContext, refType j.SpanRefType) *j.SpanRef {
|
|
return &j.SpanRef{
|
|
RefType: refType,
|
|
TraceIdLow: int64(ctx.traceID.Low),
|
|
TraceIdHigh: int64(ctx.traceID.High),
|
|
SpanId: int64(ctx.spanID),
|
|
}
|
|
}
|