internal

Documentation

Index

• Constants
• func AgentURLFromEnv() *url.URL
• func BoolEnv(key string, def bool) bool
• func CleanGitMetadataTags(tags map[string]string)
• func ContainerID() string
• func DurationEnv(key string, def time.Duration) time.Duration
• func ForEachStringTag(str string, fn func(key string, val string))
• func GetGitMetadataTags() map[string]string
• func GetTracerGitMetadataTags() map[string]string
• func IntEnv(key string, def int) int
• func IsExecutionTraced(ctx context.Context) bool
• func ParseTagString(str string) map[string]string
• func ResetGitMetadataTags()
• func WithExecutionNotTraced(ctx context.Context) context.Context
• func WithExecutionTraced(ctx context.Context) context.Context

Constants

const (
	// EnvGitMetadataEnabledFlag specifies the environment variable name for enable/disable
	EnvGitMetadataEnabledFlag = "DD_TRACE_GIT_METADATA_ENABLED"
	// EnvGitRepositoryURL specifies the environment variable name for git repository URL
	EnvGitRepositoryURL = "DD_GIT_REPOSITORY_URL"
	// EnvGitCommitSha specifies the environment variable name git commit sha
	EnvGitCommitSha = "DD_GIT_COMMIT_SHA"
	// EnvDDTags specifies the environment variable name global tags
	EnvDDTags = "DD_TAGS"

	// TagRepositoryURL specifies the tag name for git repository URL
	TagRepositoryURL = "git.repository_url"
	// TagCommitSha specifies the tag name for git commit sha
	TagCommitSha = "git.commit.sha"
	// TagGoPath specifies the tag name for go module path
	TagGoPath = "go_path"

	// TraceTagRepositoryURL specifies the trace tag name for git repository URL
	TraceTagRepositoryURL = "_dd.git.repository_url"
	// TraceTagCommitSha specifies the trace tag name for git commit sha
	TraceTagCommitSha = "_dd.git.commit.sha"
	// TraceTagGoPath specifies the trace tag name for go module path
	TraceTagGoPath = "_dd.go_path"
)

Functions

func AgentURLFromEnv

func AgentURLFromEnv() *url.URL

AgentURLFromEnv determines the trace agent URL from environment variable DD_TRACE_AGENT_URL. If the determined value is valid and the scheme is supported (unix, http or https), it will return an *url.URL. Otherwise, it returns nil.

func BoolEnv

func BoolEnv(key string, def bool) bool

BoolEnv returns the parsed boolean value of an environment variable, or def otherwise.

func CleanGitMetadataTags

func CleanGitMetadataTags(tags map[string]string)

CleanGitMetadataTags cleans up tags from git metadata

func ContainerID

func ContainerID() string

ContainerID attempts to return the container ID from /proc/self/cgroup or empty on failure.

func DurationEnv

func DurationEnv(key string, def time.Duration) time.Duration

DurationEnv returns the parsed duration value of an environment variable, or def otherwise.

func ForEachStringTag

func ForEachStringTag(str string, fn func(key string, val string))

ForEachStringTag runs fn on every key:val pair encountered in str. str may contain multiple key:val pairs separated by either space or comma (but not a mixture of both).

func GetGitMetadataTags

func GetGitMetadataTags() map[string]string

GetGitMetadataTags returns git metadata tags

func GetTracerGitMetadataTags

func GetTracerGitMetadataTags() map[string]string

GetTracerGitMetadataTags returns git metadata tags for tracer NB: Currently tracer inject tags with some workaround (only with _dd prefix and only for the first span in payload) So we provide different tag names

func IntEnv

func IntEnv(key string, def int) int

IntEnv returns the parsed int value of an environment variable, or def otherwise.

func IsExecutionTraced

func IsExecutionTraced(ctx context.Context) bool

IsExecutionTraced returns whether ctx is associated with an execution trace task, as indicated via WithExecutionTraced

func ParseTagString

func ParseTagString(str string) map[string]string

ParseTagString returns tags parsed from string as map

func ResetGitMetadataTags

func ResetGitMetadataTags()

ResetGitMetadataTags reset cashed metadata tags

func WithExecutionNotTraced

func WithExecutionNotTraced(ctx context.Context) context.Context

WithExecutionNotTraced marks that the context is *not* covered by an execution trace task. This is intended to prevent child spans (which inherit information from ctx) from being considered covered by a task, when an integration may create its own child span with its own execution trace task.

func WithExecutionTraced

func WithExecutionTraced(ctx context.Context) context.Context

WithExecutionTraced marks ctx as being associated with an execution trace task. It is assumed that ctx already contains a trace task. The caller is responsible for ending the task.

This is intended for a specific case where the database/sql contrib package only creates spans *after* an operation, in case the operation was unavailable, and thus execution trace tasks tied to the span only capture the very end. This function enables creating a task *before* creating a span, and communicating to the APM tracer that it does not need to create a task. In general, APM instrumentation should prefer creating tasks around the operation rather than after the fact, if possible.