internal/telemetry: revamp

.gitlab-ci.yml

@@ -9,8 +9,7 @@ variables:
   INDEX_FILE: index.txt
   KUBERNETES_SERVICE_ACCOUNT_OVERWRITE: dd-trace-go
   FF_USE_LEGACY_KUBERNETES_EXECUTION_STRATEGY: "true"
-  BENCHMARK_TARGETS: "BenchmarkStartRequestSpan|BenchmarkHttpServeTrace|BenchmarkTracerAddSpans|BenchmarkStartSpan|BenchmarkSingleSpanRetention|BenchmarkOTelApiWithCustomTags|BenchmarkInjectW3C|BenchmarkExtractW3C|BenchmarkPartialFlushing|BenchmarkGraphQL|BenchmarkSampleWAFContext|BenchmarkCaptureStackTrace|BenchmarkSetTagString|BenchmarkSetTagStringPtr|BenchmarkSetTagMetric|BenchmarkSetTagStringer|BenchmarkSerializeSpanLinksInMeta"
-
+  BENCHMARK_TARGETS: "BenchmarkStartRequestSpan|BenchmarkHttpServeTrace|BenchmarkTracerAddSpans|BenchmarkStartSpan|BenchmarkSingleSpanRetention|BenchmarkOTelApiWithCustomTags|BenchmarkInjectW3C|BenchmarkExtractW3C|BenchmarkPartialFlushing|BenchmarkGraphQL|BenchmarkSampleWAFContext|BenchmarkCaptureStackTrace|BenchmarkSetTagString|BenchmarkSetTagStringPtr|BenchmarkSetTagMetric|BenchmarkSetTagStringer|BenchmarkSerializeSpanLinksInMeta|BenchmarkLogs|BenchmarkWorstCaseScenarioFloodLogging|BenchmarkMetrics|BenchmarkWorstCaseScenarioFloodMetrics"
 include:
   - ".gitlab/benchmarks.yml"
   - ".gitlab/macrobenchmarks.yml"

internal/globalconfig/globalconfig.go

@@ -9,6 +9,7 @@ package globalconfig
 
 import (
 	"math"
+	"os"
 	"sync"
 
 	"gopkg.in/DataDog/dd-trace-go.v1/internal"
@@ -130,3 +131,18 @@ func HeaderTagsLen() int {
 func ClearHeaderTags() {
 	cfg.headersAsTags.Clear()
 }
+
+// InstrumentationInstallID returns the install ID as described in DD_INSTRUMENTATION_INSTALL_ID
+func InstrumentationInstallID() string {
+	return os.Getenv("DD_INSTRUMENTATION_INSTALL_ID")
+}
+
+// InstrumentationInstallType returns the install type as described in DD_INSTRUMENTATION_INSTALL_TYPE
+func InstrumentationInstallType() string {
+	return os.Getenv("DD_INSTRUMENTATION_INSTALL_TYPE")
+}
+
+// InstrumentationInstallTime returns the install time as described in DD_INSTRUMENTATION_INSTALL_TIME
+func InstrumentationInstallTime() string {
+	return os.Getenv("DD_INSTRUMENTATION_INSTALL_TIME")
+}

internal/newtelemetry/api.go

@@ -0,0 +1,152 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2024 Datadog, Inc.
+
+package newtelemetry
+
+import (
+	"io"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal/newtelemetry/internal/transport"
+)
+
+// Namespace describes a product to distinguish telemetry coming from
+// different products used by the same application
+type Namespace = transport.Namespace
+
+// Goland is having a hard time with the following const block, it keeps deleting the type
+//
+//goland:noinspection GoVarAndConstTypeMayBeOmitted
+const (
+	NamespaceGeneral      Namespace = transport.NamespaceGeneral
+	NamespaceTracers      Namespace = transport.NamespaceTracers
+	NamespaceProfilers    Namespace = transport.NamespaceProfilers
+	NamespaceAppSec       Namespace = transport.NamespaceAppSec
+	NamespaceIAST         Namespace = transport.NamespaceIAST
+	NamespaceCIVisibility Namespace = transport.NamespaceCIVisibility
+	NamespaceMLOps        Namespace = transport.NamespaceMLOps
+	NamespaceRUM          Namespace = transport.NamespaceRUM
+)
+
+// Origin describes the source of a configuration change
+type Origin = transport.Origin
+
+// Goland is having a hard time with the following const block, it keeps deleting the type
+//
+//goland:noinspection GoVarAndConstTypeMayBeOmitted
+const (
+	OriginDefault      Origin = transport.OriginDefault
+	OriginCode         Origin = transport.OriginCode
+	OriginDDConfig     Origin = transport.OriginDDConfig
+	OriginEnvVar       Origin = transport.OriginEnvVar
+	OriginRemoteConfig Origin = transport.OriginRemoteConfig
+)
+
+// LogLevel describes the level of a log message
+type LogLevel = transport.LogLevel
+
+// Goland is having a hard time with the following const block, it keeps deleting the type
+//
+//goland:noinspection GoVarAndConstTypeMayBeOmitted
+const (
+	LogDebug LogLevel = transport.LogLevelDebug
+	LogWarn  LogLevel = transport.LogLevelWarn
+	LogError LogLevel = transport.LogLevelError
+)
+
+// MetricHandle can be used to submit different values for the same metric.
+// MetricHandle is used to reduce lock contention when submitting metrics.
+// This can also be used ephemerally to submit a single metric value like this:
+//
+// ```go
+// telemetry.metric(telemetry.Appsec, "my-count", map[string]string{"tag1": "true", "tag2": "1.0"}).Submit(1.0)
+// ```
+type MetricHandle interface {
+	// Submit submits a value to the metric handle.
+	Submit(value float64)
+	// Get returns the last value submitted to the metric handle.
+	Get() float64
+}
+
+// Integration is an integration that is configured to be traced.
+type Integration struct {
+	// Name is an arbitrary string that must stay constant for the integration.
+	Name string
+	// Version is the version of the integration/dependency that is being loaded.
+	Version string
+	// Error is the error that occurred while loading the integration. If this field is specified, the integration is
+	// considered to be having been forcefully disabled because of the error.
+	Error string
+}
+
+// Configuration is a key-value pair that is used to configure the application.
+type Configuration struct {
+	// Key is the key of the configuration.
+	Name string
+	// Value is the value of the configuration. Need to be json serializable.
+	Value any
+	// Origin is the source of the configuration change.
+	Origin Origin
+}
+
+// LogOption is a function that modifies the log message that is sent to the telemetry.
+type LogOption func(key *loggerKey, value *loggerValue)
+
+// Client constitutes all the functions available concurrently for the telemetry users. All methods are thread-safe
+// This is an interface for easier testing but all functions will be mirrored at the package level to call
+// the global client.
+type Client interface {
+	io.Closer
+
+	// Count obtains the metric handle for the given parameters, or creates a new one if none was created just yet.
+	// Tags cannot contain commas.
+	Count(namespace Namespace, name string, tags []string) MetricHandle
+
+	// Rate obtains the metric handle for the given parameters, or creates a new one if none was created just yet.
+	// Tags cannot contain commas.
+	Rate(namespace Namespace, name string, tags []string) MetricHandle
+
+	// Gauge obtains the metric handle for the given parameters, or creates a new one if none was created just yet.
+	// Tags cannot contain commas.
+	Gauge(namespace Namespace, name string, tags []string) MetricHandle
+
+	// Distribution obtains the metric handle for the given parameters, or creates a new one if none was created just yet.
+	// Tags cannot contain commas.
+	Distribution(namespace Namespace, name string, tags []string) MetricHandle
+
+	// Log sends a telemetry log at the desired level with the given text and options.
+	// Options include sending key-value pairs as tags, and a stack trace frozen from inside the Log function.
+	Log(level LogLevel, text string, options ...LogOption)
+
+	// ProductStarted declares a product to have started at the customer’s request
+	ProductStarted(product Namespace)
+
+	// ProductStopped declares a product to have being stopped by the customer
+	ProductStopped(product Namespace)
+
+	// ProductStartError declares that a product could not start because of the following error
+	ProductStartError(product Namespace, err error)
+
+	// RegisterAppConfig adds a key value pair to the app configuration and send the change to telemetry
+	// value has to be json serializable and the origin is the source of the change.
+	RegisterAppConfig(key string, value any, origin Origin)
+
+	// RegisterAppConfigs adds a list of key value pairs to the app configuration and sends the change to telemetry.
+	// Same as AddAppConfig but for multiple values.
+	RegisterAppConfigs(kvs ...Configuration)
+
+	// MarkIntegrationAsLoaded marks an integration as loaded in the telemetry
+	MarkIntegrationAsLoaded(integration Integration)
+
+	// Flush closes the client and flushes any remaining data.
+	Flush()
+
+	// AppStart sends the telemetry necessary to signal that the app is starting.
+	// Preferred use via StartApp package level function
+	AppStart()
+
+	// AppStop sends the telemetry necessary to signal that the app is stopping.
+	// Preferred use via StopApp package level function
+	AppStop()
+}