observability

Documentation

Index

• Constants
• Variables
• func CalcRequestDurations(ctx *gin.Context, start time.Time)
• func CalcRequests(ctx *gin.Context)
• func EndTracingOtel(span trace.Span, code codes.Code, message string)
• func GetTraceIDFromContext(ctx context.Context) string
• func GetTraceIDXRay(span trace.Span) string
• func GetTraceIDXRaySegment(ctx context.Context, path string) (context.Context, *xray.Segment)
• func InitMetrics(router *gin.Engine)
• func InitObservability(router *gin.Engine)
• func InitOtel(router *gin.Engine) error
• func InitTracingOtel(router *gin.Engine)
• func InitTracingXRay(router *gin.Engine)
• func SetDuration(ctx *gin.Context, start time.Time)
• func SetMetrics(ctx *gin.Context)
• func SetTracingOtel() gin.HandlerFunc
• func StartTracingOtel(ctx context.Context, name string) (context.Context, trace.Span)
• func WriteResponseXRay(span trace.Span, w http.ResponseWriter)
• func WriteResponseXRaySegment(segment *xray.Segment, w http.ResponseWriter)
• func XrayMiddleware() gin.HandlerFunc

Constants

const CpuUsage = "cpu_usage"

const LatencyTime = "latency_time"

const ServiceName = "bookstore-adot"

const ThreadsActive = "threads_active"

const TimeAlive = "time_alive"

Names for metric instruments

const TotalApiRequests = "total_api_requests"

const TotalBytesSent = "total_bytes_sent"

const TotalHeapSize = "total_heap_size"

Variables

var RandomMetricCommonLabels = []attribute.KeyValue{
	attribute.String("signal", "metric"),
	attribute.String("language", ServiceName),
	attribute.String("metricType", "random"),
}

var RequestMetricCommonLabels = []attribute.KeyValue{
	attribute.String("signal", "metric"),
	attribute.String("language", ServiceName),
	attribute.String("metricType", "request"),
}

Common attributes for traces and metrics (random, request)

var TestingId = ""

var TraceCommonLabels = []attribute.KeyValue{
	attribute.String("signal", "trace"),
	attribute.String("language", ServiceName),
}

var Tracer = otel.Tracer("github.com/devopscorner/golang-adot/src/observability")

Functions

func CalcRequestDurations

func CalcRequestDurations(ctx *gin.Context, start time.Time)

func CalcRequests

func CalcRequests(ctx *gin.Context)

func EndTracingOtel

func EndTracingOtel(span trace.Span, code codes.Code, message string)

func GetTraceIDFromContext

func GetTraceIDFromContext(ctx context.Context) string

GetTraceIDFromContext returns the trace ID from the provided context

func GetTraceIDXRay

func GetTraceIDXRay(span trace.Span) string

GetXrayTraceID generates a trace ID in Xray format from the span context.

func GetTraceIDXRaySegment

func GetTraceIDXRaySegment(ctx context.Context, path string) (context.Context, *xray.Segment)

func InitMetrics

func InitMetrics(router *gin.Engine)

func InitObservability

func InitObservability(router *gin.Engine)

func InitOtel

func InitOtel(router *gin.Engine) error

func InitTracingOtel

func InitTracingOtel(router *gin.Engine)

func InitTracingXRay

func InitTracingXRay(router *gin.Engine)

func SetDuration

func SetDuration(ctx *gin.Context, start time.Time)

func SetMetrics

func SetMetrics(ctx *gin.Context)

func SetTracingOtel

func SetTracingOtel() gin.HandlerFunc

func StartTracingOtel

func StartTracingOtel(ctx context.Context, name string) (context.Context, trace.Span)

func WriteResponseXRay

func WriteResponseXRay(span trace.Span, w http.ResponseWriter)

func WriteResponseXRaySegment

func WriteResponseXRaySegment(segment *xray.Segment, w http.ResponseWriter)

func XrayMiddleware

func XrayMiddleware() gin.HandlerFunc