mirror of
https://gitee.com/johng/gf.git
synced 2024-12-03 20:58:47 +08:00
129 lines
4.2 KiB
Go
129 lines
4.2 KiB
Go
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
// Package gtrace provides convenience wrapping functionality for tracing feature using OpenTelemetry.
|
|
package gtrace
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"github.com/gogf/gf/container/gmap"
|
|
"github.com/gogf/gf/container/gvar"
|
|
"github.com/gogf/gf/net/gipv4"
|
|
"github.com/gogf/gf/os/gcmd"
|
|
"go.opentelemetry.io/otel"
|
|
"go.opentelemetry.io/otel/attribute"
|
|
"go.opentelemetry.io/otel/propagation"
|
|
"go.opentelemetry.io/otel/trace"
|
|
"os"
|
|
"strings"
|
|
)
|
|
|
|
const (
|
|
tracingCommonKeyIpIntranet = `ip.intranet`
|
|
tracingCommonKeyIpHostname = `hostname`
|
|
cmdEnvKey = "gf.gtrace" // Configuration key for command argument or environment.
|
|
)
|
|
|
|
var (
|
|
intranetIps, _ = gipv4.GetIntranetIpArray()
|
|
intranetIpStr = strings.Join(intranetIps, ",")
|
|
hostname, _ = os.Hostname()
|
|
tracingMaxContentLogSize = 256 * 1024 // Max log size for request and response body, especially for HTTP/RPC request.
|
|
// defaultTextMapPropagator is the default propagator for context propagation between peers.
|
|
defaultTextMapPropagator = propagation.NewCompositeTextMapPropagator(
|
|
propagation.TraceContext{},
|
|
propagation.Baggage{},
|
|
)
|
|
)
|
|
|
|
func init() {
|
|
if maxContentLogSize := gcmd.GetOptWithEnv(fmt.Sprintf("%s.maxcontentlogsize", cmdEnvKey)).Int(); maxContentLogSize > 0 {
|
|
tracingMaxContentLogSize = maxContentLogSize
|
|
}
|
|
CheckSetDefaultTextMapPropagator()
|
|
}
|
|
|
|
// MaxContentLogSize returns the max log size for request and response body, especially for HTTP/RPC request.
|
|
func MaxContentLogSize() int {
|
|
return tracingMaxContentLogSize
|
|
}
|
|
|
|
// CommonLabels returns common used attribute labels:
|
|
// ip.intranet, hostname.
|
|
func CommonLabels() []attribute.KeyValue {
|
|
return []attribute.KeyValue{
|
|
attribute.String(tracingCommonKeyIpHostname, hostname),
|
|
attribute.String(tracingCommonKeyIpIntranet, intranetIpStr),
|
|
}
|
|
}
|
|
|
|
// IsActivated checks and returns if tracing feature is activated.
|
|
func IsActivated(ctx context.Context) bool {
|
|
return GetTraceId(ctx) != ""
|
|
}
|
|
|
|
// CheckSetDefaultTextMapPropagator sets the default TextMapPropagator if it is not set previously.
|
|
func CheckSetDefaultTextMapPropagator() {
|
|
p := otel.GetTextMapPropagator()
|
|
if len(p.Fields()) == 0 {
|
|
otel.SetTextMapPropagator(GetDefaultTextMapPropagator())
|
|
}
|
|
}
|
|
|
|
// GetDefaultTextMapPropagator returns the default propagator for context propagation between peers.
|
|
func GetDefaultTextMapPropagator() propagation.TextMapPropagator {
|
|
return defaultTextMapPropagator
|
|
}
|
|
|
|
// GetTraceId retrieves and returns TraceId from context.
|
|
// It returns an empty string is tracing feature is not activated.
|
|
func GetTraceId(ctx context.Context) string {
|
|
if ctx == nil {
|
|
return ""
|
|
}
|
|
traceId := trace.SpanContextFromContext(ctx).TraceID()
|
|
if traceId.IsValid() {
|
|
return traceId.String()
|
|
}
|
|
return ""
|
|
}
|
|
|
|
// GetSpanId retrieves and returns SpanId from context.
|
|
// It returns an empty string is tracing feature is not activated.
|
|
func GetSpanId(ctx context.Context) string {
|
|
if ctx == nil {
|
|
return ""
|
|
}
|
|
spanId := trace.SpanContextFromContext(ctx).SpanID()
|
|
if spanId.IsValid() {
|
|
return spanId.String()
|
|
}
|
|
return ""
|
|
}
|
|
|
|
// SetBaggageValue is a convenient function for adding one key-value pair to baggage.
|
|
// Note that it uses attribute.Any to set the key-value pair.
|
|
func SetBaggageValue(ctx context.Context, key string, value interface{}) context.Context {
|
|
return NewBaggage(ctx).SetValue(key, value)
|
|
}
|
|
|
|
// SetBaggageMap is a convenient function for adding map key-value pairs to baggage.
|
|
// Note that it uses attribute.Any to set the key-value pair.
|
|
func SetBaggageMap(ctx context.Context, data map[string]interface{}) context.Context {
|
|
return NewBaggage(ctx).SetMap(data)
|
|
}
|
|
|
|
// GetBaggageMap retrieves and returns the baggage values as map.
|
|
func GetBaggageMap(ctx context.Context) *gmap.StrAnyMap {
|
|
return NewBaggage(ctx).GetMap()
|
|
}
|
|
|
|
// GetBaggageVar retrieves value and returns a *gvar.Var for specified key from baggage.
|
|
func GetBaggageVar(ctx context.Context, key string) *gvar.Var {
|
|
return NewBaggage(ctx).GetVar(key)
|
|
}
|