diagnostics

Documentation

Index

• Constants
• Variables
• func AddAttributesToSpan(span *trace.Span, attributes map[string]string)
• func ConstructInputBindingSpanAttributes(bindingName, url string) map[string]string
• func ConstructSubscriptionSpanAttributes(topic string) map[string]string
• func GRPCTraceStreamServerInterceptor(appID string, spec config.TracingSpec) grpc.StreamServerInterceptor
• func GRPCTraceUnaryServerInterceptor(appID string, spec config.TracingSpec) grpc.UnaryServerInterceptor
• func HTTPTraceMiddleware(next fasthttp.RequestHandler, appID string, spec config.TracingSpec) fasthttp.RequestHandler
• func InitMetrics(appID string) error
• func SpanContextFromIncomingGRPCMetadata(ctx context.Context) (trace.SpanContext, bool)
• func SpanContextFromRequest(req *fasthttp.Request) (sc trace.SpanContext, ok bool)
• func SpanContextFromW3CString(h string) (sc trace.SpanContext, ok bool)
• func SpanContextToGRPCMetadata(ctx context.Context, spanContext trace.SpanContext) context.Context
• func SpanContextToHTTPHeaders(sc trace.SpanContext, setHeader func(string, string))
• func SpanContextToW3CString(sc trace.SpanContext) string
• func StartInternalCallbackSpan(ctx context.Context, spanName string, parent trace.SpanContext, ...) (context.Context, *trace.Span)
• func TraceStateFromW3CString(h string) *tracestate.Tracestate
• func TraceStateToW3CString(sc trace.SpanContext) string
• func UpdateSpanStatusFromGRPCError(span *trace.Span, err error)
• func UpdateSpanStatusFromHTTPStatus(span *trace.Span, code int)

Constants

const (
	GRPCProxyAppIDKey = "dapr-app-id"
)

Variables

var (
	KeyServerMethod = tag.MustNewKey("grpc_server_method")
	KeyServerStatus = tag.MustNewKey("grpc_server_status")

	KeyClientMethod = tag.MustNewKey("grpc_client_method")
	KeyClientStatus = tag.MustNewKey("grpc_client_status")
)

Tag key definitions for http requests.

var (
	// DefaultReportingPeriod is the default view reporting period.
	DefaultReportingPeriod = 1 * time.Minute

	// DefaultMonitoring holds service monitoring metrics definitions.
	DefaultMonitoring = newServiceMetrics()
	// DefaultGRPCMonitoring holds default gRPC monitoring handlers and middlewares.
	DefaultGRPCMonitoring = newGRPCMetrics()
	// DefaultHTTPMonitoring holds default HTTP monitoring handlers and middlewares.
	DefaultHTTPMonitoring = newHTTPMetrics()
)

Functions

func AddAttributesToSpan

func AddAttributesToSpan(span *trace.Span, attributes map[string]string)

AddAttributesToSpan adds the given attributes in the span.

func ConstructInputBindingSpanAttributes

func ConstructInputBindingSpanAttributes(bindingName, url string) map[string]string

ConstructInputBindingSpanAttributes creates span attributes for InputBindings.

func ConstructSubscriptionSpanAttributes

func ConstructSubscriptionSpanAttributes(topic string) map[string]string

ConstructSubscriptionSpanAttributes creates span attributes for Pubsub subscription.

func GRPCTraceStreamServerInterceptor

func GRPCTraceStreamServerInterceptor(appID string, spec config.TracingSpec) grpc.StreamServerInterceptor

GRPCTraceStreamServerInterceptor sets the trace context or starts the trace client span based on request.

func GRPCTraceUnaryServerInterceptor

func GRPCTraceUnaryServerInterceptor(appID string, spec config.TracingSpec) grpc.UnaryServerInterceptor

GRPCTraceUnaryServerInterceptor sets the trace context or starts the trace client span based on request.

func HTTPTraceMiddleware

func HTTPTraceMiddleware(next fasthttp.RequestHandler, appID string, spec config.TracingSpec) fasthttp.RequestHandler

HTTPTraceMiddleware sets the trace context or starts the trace client span based on request.

func InitMetrics

func InitMetrics(appID string) error

InitMetrics initializes metrics.

func SpanContextFromIncomingGRPCMetadata

func SpanContextFromIncomingGRPCMetadata(ctx context.Context) (trace.SpanContext, bool)

SpanContextFromIncomingGRPCMetadata returns the SpanContext stored in incoming metadata of context, or empty if there isn't one.

func SpanContextFromRequest

func SpanContextFromRequest(req *fasthttp.Request) (sc trace.SpanContext, ok bool)

SpanContextFromRequest extracts a span context from incoming requests.

func SpanContextFromW3CString

func SpanContextFromW3CString(h string) (sc trace.SpanContext, ok bool)

SpanContextFromW3CString extracts a span context from given string which got earlier from SpanContextToW3CString format.

func SpanContextToGRPCMetadata

func SpanContextToGRPCMetadata(ctx context.Context, spanContext trace.SpanContext) context.Context

SpanContextToGRPCMetadata appends binary serialized SpanContext to the outgoing GRPC context.

func SpanContextToHTTPHeaders

func SpanContextToHTTPHeaders(sc trace.SpanContext, setHeader func(string, string))

SpanContextToHTTPHeaders adds the spancontext in traceparent and tracestate headers.

func SpanContextToW3CString

func SpanContextToW3CString(sc trace.SpanContext) string

SpanContextToW3CString returns the SpanContext string representation.

func StartInternalCallbackSpan

func StartInternalCallbackSpan(ctx context.Context, spanName string, parent trace.SpanContext, spec config.TracingSpec) (context.Context, *trace.Span)

StartInternalCallbackSpan starts trace span for internal callback such as input bindings and pubsub subscription.

func TraceStateFromW3CString

func TraceStateFromW3CString(h string) *tracestate.Tracestate

TraceStateFromW3CString extracts a span tracestate from given string which got earlier from TraceStateFromW3CString format.

func TraceStateToW3CString

func TraceStateToW3CString(sc trace.SpanContext) string

TraceStateToW3CString extracts the TraceState from given SpanContext and returns its string representation.

func UpdateSpanStatusFromGRPCError

func UpdateSpanStatusFromGRPCError(span *trace.Span, err error)

UpdateSpanStatusFromGRPCError updates tracer span status based on error object.

func UpdateSpanStatusFromHTTPStatus

func UpdateSpanStatusFromHTTPStatus(span *trace.Span, code int)

UpdateSpanStatusFromHTTPStatus updates trace span status based on response code.