utils

Documentation

Index

• Constants
• Variables
• func CreateClient(APIKey string, endpoint string) *datadog.Client
• func DoWithRetries(maxRetries int, fn func() error) (i int, err error)
• func GetRoot(t *pb.APITrace) *pb.Span
• func NewHTTPClient(timeout time.Duration) *http.Client
• func NormalizeServiceName(service string) string
• func NormalizeSpanKind(kind pdata.SpanKind) string
• func NormalizeSpanName(tag string, isService bool) string
• func NormalizeTag(v string) string
• func SetDDHeaders(reqHeader http.Header, buildInfo component.BuildInfo, apiKey string)
• func SetExtraHeaders(h http.Header, extras map[string]string)
• func TruncateUTF8(s string, limit int) string
• func UserAgent(buildInfo component.BuildInfo) string
• func ValidateAPIKey(logger *zap.Logger, client *datadog.Client)

Constants

const (
	// maximum for tag string lengths
	MaxTagLength = 200
	// DefaultServiceName is the default name we assign a service if it's missing and we have no reasonable fallback
	// From: https://github.com/DataDog/datadog-agent/blob/eab0dde41fe3a069a65c33d82a81b1ef1cf6b3bc/pkg/trace/traceutil/normalize.go#L15
	DefaultServiceName string = "unnamed-otel-service"
)

constants for tags

Variables

var (
	// JSONHeaders headers for JSON requests.
	JSONHeaders = map[string]string{
		"Content-Type":     "application/json",
		"Content-Encoding": "gzip",
	}
	// ProtobufHeaders headers for protobuf requests.
	ProtobufHeaders = map[string]string{
		"Content-Type":     "application/x-protobuf",
		"Content-Encoding": "identity",
	}
)

Functions

func CreateClient

func CreateClient(APIKey string, endpoint string) *datadog.Client

CreateClient creates a new Datadog client

func DoWithRetries

func DoWithRetries(maxRetries int, fn func() error) (i int, err error)

DoWithRetries repeats a fallible action up to `maxRetries` times with exponential backoff

func GetRoot

func GetRoot(t *pb.APITrace) *pb.Span

GetRoot extracts the root span from a trace From: https://github.com/DataDog/datadog-agent/blob/a6872e436681ea2136cf8a67465e99fdb4450519/pkg/trace/traceutil/trace.go#L27

func NewHTTPClient

func NewHTTPClient(timeout time.Duration) *http.Client

NewHTTPClient returns a http.Client configured with the Agent options.

func NormalizeServiceName

func NormalizeServiceName(service string) string

NormalizeServiceName returns a span service name normalized to remove invalid characters TODO: we'd like to move to the datadog-agent traceutil version of this once it's available in the exportable package https://github.com/DataDog/datadog-agent/blob/eab0dde41fe3a069a65c33d82a81b1ef1cf6b3bc/pkg/trace/traceutil/normalize.go#L52

func NormalizeSpanKind

func NormalizeSpanKind(kind pdata.SpanKind) string

NormalizeSpanKind returns a span kind with the SPAN_KIND prefix trimmed off

func NormalizeSpanName

func NormalizeSpanName(tag string, isService bool) string

func NormalizeTag

func NormalizeTag(v string) string

NormalizeTag applies some normalization to ensure the tags match the backend requirements. Specifically used for env tag currently port from: https://github.com/DataDog/datadog-agent/blob/c87e93a75b1fc97f0691faf78ae8eb2c280d6f55/pkg/trace/traceutil/normalize.go#L89

func SetDDHeaders

func SetDDHeaders(reqHeader http.Header, buildInfo component.BuildInfo, apiKey string)

SetDDHeaders sets the Datadog-specific headers

func SetExtraHeaders

func SetExtraHeaders(h http.Header, extras map[string]string)

SetExtraHeaders appends a header map to HTTP headers.

func TruncateUTF8

func TruncateUTF8(s string, limit int) string

TruncateUTF8 truncates the given string to make sure it uses less than limit bytes. If the last character is an utf8 character that would be splitten, it removes it entirely to make sure the resulting string is not broken. from: https://github.com/DataDog/datadog-agent/blob/140a4ee164261ef2245340c50371ba989fbeb038/pkg/trace/traceutil/truncate.go#L34-L49

func UserAgent

func UserAgent(buildInfo component.BuildInfo) string

func ValidateAPIKey

func ValidateAPIKey(logger *zap.Logger, client *datadog.Client)

ValidateAPIKey checks that the provided client was given a correct API key.