ConfigurationKeys.Telemetry.g.cs

// <copyright company="Datadog">
// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
// </copyright>
// <auto-generated/>

#nullable enable

namespace Datadog.Trace.Configuration;

/// <summary>
/// String constants for standard Datadog configuration keys.
/// Do not edit this file directly as it's auto-generated from supported-configurations.yaml
/// For more info, see docs/development/Configuration/AddingConfigurationKeys.md
/// </summary>
internal static partial class ConfigurationKeys
{
    internal static class Telemetry
    {
        /// <summary>
        /// Internal env var for propagating the root session ID to child processes.
        /// Set automatically by the tracer at init time; not user-configurable.
        /// </summary>
        public const string RootSessionId = "_DD_ROOT_DOTNET_SESSION_ID";

        /// <summary>
        /// SSI variable that provides a unique identifier for the instrumentation installation.
        /// Used for tracking and correlation purposes in telemetry.
        /// </summary>
        public const string InstrumentationInstallId = "DD_INSTRUMENTATION_INSTALL_ID";

        /// <summary>
        /// SSI variable that indicates when the instrumentation was installed.
        /// Used for tracking installation timeline in telemetry.
        /// </summary>
        public const string InstrumentationInstallTime = "DD_INSTRUMENTATION_INSTALL_TIME";

        /// <summary>
        /// SSI variable that indicates the installation type (e.g., dd_dotnet_launcher, dd_trace_tool, dotnet_msi, windows_fleet_installer).
        /// Used to determine the instrumentation source for telemetry.
        /// </summary>
        public const string InstrumentationInstallType = "DD_INSTRUMENTATION_INSTALL_TYPE";

        /// <summary>
        /// Configuration key for sending telemetry via agent proxy. If enabled, sends telemetry
        /// via agent proxy. Enabled by default. If disabled, or agent is not available, telemetry
        /// is sent to agentless endpoint, based on <see cref="Datadog.Trace.Configuration.ConfigurationKeys.CIVisibility.AgentlessEnabled"/> setting.
        /// </summary>
        public const string AgentProxyEnabled = "DD_INSTRUMENTATION_TELEMETRY_AGENT_PROXY_ENABLED";

        /// <summary>
        /// Configuration key for sending telemetry direct to telemetry intake. If enabled, and
        /// <see cref="ConfigurationKeys.ApiKey"/> is set, sends telemetry direct to intake if agent is not
        /// available. Enabled by default if <see cref="ConfigurationKeys.ApiKey"/> is available.
        /// </summary>
        public const string AgentlessEnabled = "DD_INSTRUMENTATION_TELEMETRY_AGENTLESS_ENABLED";

        /// <summary>
        /// Configuration key to allow telemetry compression.
        /// <see cref="Datadog.Trace.Telemetry.TelemetrySettings.CompressionMethod"/>
        /// </summary>
        public const string TelemetryCompressionMethod = "DD_INSTRUMENTATION_TELEMETRY_COMPRESSION_METHOD";

        /// <summary>
        /// Configuration key for enabling or disabling internal telemetry.
        /// Default value is <c>true</c> (enabled).
        /// </summary>
        public const string Enabled = "DD_INSTRUMENTATION_TELEMETRY_ENABLED";

        /// <summary>
        /// Configuration key for the telemetry URL where the Tracer sends telemetry. Only applies when agentless
        /// telemetry is in use (otherwise telemetry is sent to the agent using
        /// <see cref="Datadog.Trace.Configuration.ExporterSettings.AgentUri"/> instead)
        /// </summary>
        public const string Uri = "DD_INSTRUMENTATION_TELEMETRY_URL";

        /// <summary>
        /// Configuration key for whether to enable debug mode of telemetry.
        /// <see cref="Datadog.Trace.Telemetry.TelemetrySettings.DebugEnabled"/>
        /// </summary>
        public const string DebugEnabled = "DD_INTERNAL_TELEMETRY_DEBUG_ENABLED";

        /// <summary>
        /// Configuration key for whether dependency data is sent via telemetry.
        /// Required for some ASM features. Default value is <c>true</c> (enabled).
        /// <see cref="Datadog.Trace.Telemetry.TelemetrySettings.DependencyCollectionEnabled"/>
        /// </summary>
        public const string DependencyCollectionEnabled = "DD_TELEMETRY_DEPENDENCY_COLLECTION_ENABLED";

        /// <summary>
        /// Configuration key for how often the extended heartbeat telemetry should be sent, in seconds.
        /// Must be between 1 and 604800 (7 days). For testing purposes. Defaults to 86400 (24 hours).
        /// <see cref="Datadog.Trace.Telemetry.TelemetrySettings.ExtendedHeartbeatInterval"/>
        /// </summary>
        public const string ExtendedHeartbeatIntervalSeconds = "DD_TELEMETRY_EXTENDED_HEARTBEAT_INTERVAL";

        /// <summary>
        /// Configuration key for how often telemetry should be sent, in seconds. Must be between 1 and 3600.
        /// For testing purposes. Defaults to 60
        /// <see cref="Datadog.Trace.Telemetry.TelemetrySettings.HeartbeatInterval"/>
        /// </summary>
        public const string HeartbeatIntervalSeconds = "DD_TELEMETRY_HEARTBEAT_INTERVAL";

        /// <summary>
        /// Configuration key for whether to enable redacted error log collection.
        /// </summary>
        public const string TelemetryLogsEnabled = "DD_TELEMETRY_LOG_COLLECTION_ENABLED";

        /// <summary>
        /// Configuration key for whether telemetry metrics should be sent.
        /// <see cref="Datadog.Trace.Telemetry.TelemetrySettings.MetricsEnabled"/>
        /// </summary>
        public const string MetricsEnabled = "DD_TELEMETRY_METRICS_ENABLED";
    }
}