public SecuritySettings(IConfigurationSource source)
{
// both should default to false
Enabled = source?.GetBool(ConfigurationKeys.AppSecEnabled) ?? false;
Rules = source?.GetString(ConfigurationKeys.AppSecRules);
CustomIpHeader = source?.GetString(ConfigurationKeys.AppSecCustomIpHeader);
var extraHeaders = source?.GetString(ConfigurationKeys.AppSecExtraHeaders);
ExtraHeaders = !string.IsNullOrEmpty(extraHeaders) ? extraHeaders.Split(',') : Array.Empty <string>();
KeepTraces = source?.GetBool(ConfigurationKeys.AppSecKeepTraces) ?? true;
// empty or junk values to default to 100, any number is valid, with zero or less meaning limit off
TraceRateLimit = source?.GetInt32(ConfigurationKeys.AppSecTraceRateLimit) ?? 100;
// Default timeout of 100 ms, only extreme conditions should cause timeout
const int defaultWafTimeout = 100_000;
var wafTimeout = source?.GetInt32(ConfigurationKeys.AppSecWafTimeout) ?? defaultWafTimeout;
if (wafTimeout <= 0)
{
wafTimeout = defaultWafTimeout;
Log.Warning <string, int>("Ignoring '{WafTimeoutKey}' of '{WafTimeout}' because it was zero or less", ConfigurationKeys.AppSecWafTimeout, wafTimeout);
}
WafTimeoutMicroSeconds = (ulong)wafTimeout;
}
public DirectLogSubmissionSettings(IConfigurationSource source)
{
DirectLogSubmissionHost = source?.GetString(ConfigurationKeys.DirectLogSubmission.Host)
?? HostMetadata.Instance.Hostname;
DirectLogSubmissionSource = source?.GetString(ConfigurationKeys.DirectLogSubmission.Source) ?? DefaultSource;
var overriddenSubmissionUrl = source?.GetString(ConfigurationKeys.DirectLogSubmission.Url);
if (!string.IsNullOrEmpty(overriddenSubmissionUrl))
{
// if they provide a url, use it
DirectLogSubmissionUrl = overriddenSubmissionUrl;
}
else
{
// They didn't provide a URL, use the default (With DD_SITE if provided)
var specificSite = source?.GetString(ConfigurationKeys.Site);
var ddSite = string.IsNullOrEmpty(specificSite)
? DefaultSite
: specificSite;
DirectLogSubmissionUrl = $"{IntakePrefix}{ddSite}{IntakeSuffix}";
}
DirectLogSubmissionMinimumLevel = DirectSubmissionLogLevelExtensions.Parse(
source?.GetString(ConfigurationKeys.DirectLogSubmission.MinimumLevel), DefaultMinimumLevel);
DirectLogSubmissionGlobalTags = source?.GetDictionary(ConfigurationKeys.DirectLogSubmission.GlobalTags)
?.Where(kvp => !string.IsNullOrWhiteSpace(kvp.Key) && !string.IsNullOrWhiteSpace(kvp.Value))
.ToDictionary(kvp => kvp.Key.Trim(), kvp => kvp.Value.Trim())
?? new Dictionary <string, string>();
var logSubmissionIntegrations = source?.GetString(ConfigurationKeys.DirectLogSubmission.EnabledIntegrations)
?.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries) ??
Enumerable.Empty <string>();
DirectLogSubmissionEnabledIntegrations = new HashSet <string>(logSubmissionIntegrations, StringComparer.OrdinalIgnoreCase);
var batchSizeLimit = source?.GetInt32(ConfigurationKeys.DirectLogSubmission.BatchSizeLimit);
DirectLogSubmissionBatchSizeLimit = batchSizeLimit is null or <= 0
? DefaultBatchSizeLimit
: batchSizeLimit.Value;
var queueSizeLimit = source?.GetInt32(ConfigurationKeys.DirectLogSubmission.QueueSizeLimit);
DirectLogSubmissionQueueSizeLimit = queueSizeLimit is null or <= 0
? DefaultQueueSizeLimit
: queueSizeLimit.Value;
var seconds = source?.GetInt32(ConfigurationKeys.DirectLogSubmission.BatchPeriodSeconds);
DirectLogSubmissionBatchPeriod = TimeSpan.FromSeconds(
seconds is null or <= 0
? DefaultBatchPeriodSeconds
: seconds.Value);
ApiKey = source?.GetString(ConfigurationKeys.ApiKey);
}
/// <summary>
/// Initializes a new instance of the <see cref="TracerSettings"/> class
/// using the specified <see cref="IConfigurationSource"/> to initialize values.
/// </summary>
/// <param name="source">The <see cref="IConfigurationSource"/> to use when retrieving configuration values.</param>
public TracerSettings(IConfigurationSource source)
{
Environment = source?.GetString(ConfigurationKeys.Environment);
ServiceName = source?.GetString(ConfigurationKeys.ServiceName) ??
// backwards compatibility for names used in the past
source?.GetString("DD_SERVICE_NAME");
ServiceVersion = source?.GetString(ConfigurationKeys.ServiceVersion);
TraceEnabled = source?.GetBool(ConfigurationKeys.TraceEnabled) ??
// default value
true;
if (AzureAppServices.Metadata.IsRelevant && AzureAppServices.Metadata.IsUnsafeToTrace)
{
TraceEnabled = false;
}
var disabledIntegrationNames = source?.GetString(ConfigurationKeys.DisabledIntegrations)
?.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries) ??
Enumerable.Empty <string>();
DisabledIntegrationNames = new HashSet <string>(disabledIntegrationNames, StringComparer.OrdinalIgnoreCase);
var adonetExcludedTypes = source?.GetString(ConfigurationKeys.AdoNetExcludedTypes)
?.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries) ??
Enumerable.Empty <string>();
AdoNetExcludedTypes = new HashSet <string>(adonetExcludedTypes, StringComparer.OrdinalIgnoreCase);
Integrations = new IntegrationSettingsCollection(source);
var agentHost = source?.GetString(ConfigurationKeys.AgentHost) ??
// backwards compatibility for names used in the past
source?.GetString("DD_TRACE_AGENT_HOSTNAME") ??
source?.GetString("DATADOG_TRACE_AGENT_HOSTNAME") ??
// default value
DefaultAgentHost;
var agentPort = source?.GetInt32(ConfigurationKeys.AgentPort) ??
// backwards compatibility for names used in the past
source?.GetInt32("DATADOG_TRACE_AGENT_PORT") ??
// default value
DefaultAgentPort;
var agentUri = source?.GetString(ConfigurationKeys.AgentUri) ??
// default value
$"http://{agentHost}:{agentPort}";
AgentUri = new Uri(agentUri);
TracesPipeName = source?.GetString(ConfigurationKeys.TracesPipeName);
TracesPipeTimeoutMs = source?.GetInt32(ConfigurationKeys.TracesPipeTimeoutMs)
#if DEBUG
?? 20_000;
/// <summary>
/// Initializes a new instance of the <see cref="TracerSettings"/> class
/// using the specified <see cref="IConfigurationSource"/> to initialize values.
/// </summary>
/// <param name="source">The <see cref="IConfigurationSource"/> to use when retrieving configuration values.</param>
public TracerSettings(IConfigurationSource source)
{
Environment = source?.GetString(ConfigurationKeys.Environment);
ServiceName = source?.GetString(ConfigurationKeys.ServiceName);
TraceEnabled = source?.GetBool(ConfigurationKeys.TraceEnabled) ??
// default value
true;
DebugEnabled = source?.GetBool(ConfigurationKeys.DebugEnabled) ??
// default value
false;
var disabledIntegrationNames = source?.GetString(ConfigurationKeys.DisabledIntegrations)
?.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries) ??
Enumerable.Empty <string>();
DisabledIntegrationNames = new HashSet <string>(disabledIntegrationNames, StringComparer.OrdinalIgnoreCase);
var agentHost = source?.GetString(ConfigurationKeys.AgentHost) ??
// backwards compatibility for names used in the past
source?.GetString("DD_TRACE_AGENT_HOSTNAME") ??
source?.GetString("DATADOG_TRACE_AGENT_HOSTNAME") ??
DefaultAgentHost;
var agentPort = source?.GetInt32(ConfigurationKeys.AgentPort) ??
// backwards compatibility for names used in the past
source?.GetInt32("DATADOG_TRACE_AGENT_PORT") ??
DefaultAgentPort;
var agentUri = source?.GetString(ConfigurationKeys.AgentUri) ??
$"http://{agentHost}:{agentPort}";
AgentUri = new Uri(agentUri);
AnalyticsEnabled = source?.GetBool(ConfigurationKeys.GlobalAnalyticsEnabled) ??
false;
LogsInjectionEnabled = source?.GetBool(ConfigurationKeys.LogsInjectionEnabled) ??
false;
Integrations = new IntegrationSettingsCollection(source);
}
/// <summary>
/// Initializes a new instance of the <see cref="ExporterSettings"/> class.
/// Direct use in tests only.
/// </summary>
internal ExporterSettings(IConfigurationSource source, Func <string, bool> fileExists)
{
_fileExists = fileExists;
ConfigureTraceTransport(source, out var shouldUseUdpForMetrics);
ConfigureMetricsTransport(source, shouldUseUdpForMetrics);
PartialFlushEnabled = source?.GetBool(ConfigurationKeys.PartialFlushEnabled)
// default value
?? false;
var partialFlushMinSpans = source?.GetInt32(ConfigurationKeys.PartialFlushMinSpans);
if ((partialFlushMinSpans ?? 0) <= 0)
{
partialFlushMinSpans = 500;
}
PartialFlushMinSpans = partialFlushMinSpans.Value;
}
/// <summary>
/// Tries to read Int32 from configuration source. In case of:
/// Null source default is returned,
/// Empty configuration default is returned,
/// Invalid configuration error is logged and default is returned.
/// </summary>
/// <param name="source">Configuration source.</param>
/// <param name="key">Configuration key.</param>
/// <param name="defaultTo">In case of failure, default to this value.</param>
/// <param name="validators">Value validators.</param>
/// <returns>Config value or default.</returns>
public static int SafeReadInt32(this IConfigurationSource source, string key, int defaultTo, params Predicate <int>[] validators)
{
int?csValue = source?.GetInt32(key);
if (!csValue.HasValue)
{
return(defaultTo);
}
if (validators.Length > 0)
{
foreach (var validator in validators)
{
if (!validator(csValue.Value))
{
Log.Error($"[{key}]: Invalid configuration value '{csValue}'. Defaulting to '{defaultTo}'");
return(defaultTo);
}
}
}
return(csValue.Value);
}
/// <summary>
/// Initializes a new instance of the <see cref="TracerSettings"/> class
/// using the specified <see cref="IConfigurationSource"/> to initialize values.
/// </summary>
/// <param name="source">The <see cref="IConfigurationSource"/> to use when retrieving configuration values.</param>
public TracerSettings(IConfigurationSource source)
{
Environment = source?.GetString(ConfigurationKeys.Environment);
ServiceName = source?.GetString(ConfigurationKeys.ServiceName) ??
// backwards compatibility for names used in the past
source?.GetString("DD_SERVICE_NAME");
ServiceVersion = source?.GetString(ConfigurationKeys.ServiceVersion);
TraceEnabled = source?.GetBool(ConfigurationKeys.TraceEnabled) ??
// default value
true;
var disabledIntegrationNames = source?.GetString(ConfigurationKeys.DisabledIntegrations)
?.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries) ??
Enumerable.Empty <string>();
DisabledIntegrationNames = new HashSet <string>(disabledIntegrationNames, StringComparer.OrdinalIgnoreCase);
var agentHost = source?.GetString(ConfigurationKeys.AgentHost) ??
// backwards compatibility for names used in the past
source?.GetString("DD_TRACE_AGENT_HOSTNAME") ??
source?.GetString("DATADOG_TRACE_AGENT_HOSTNAME") ??
// default value
DefaultAgentHost;
var agentPort = source?.GetInt32(ConfigurationKeys.AgentPort) ??
// backwards compatibility for names used in the past
source?.GetInt32("DATADOG_TRACE_AGENT_PORT") ??
// default value
DefaultAgentPort;
var agentUri = source?.GetString(ConfigurationKeys.AgentUri) ??
// default value
$"http://{agentHost}:{agentPort}";
AgentUri = new Uri(agentUri);
if (string.Equals(AgentUri.Host, "localhost", StringComparison.OrdinalIgnoreCase))
{
// Replace localhost with 127.0.0.1 to avoid DNS resolution.
// When ipv6 is enabled, localhost is first resolved to ::1, which fails
// because the trace agent is only bound to ipv4.
// This causes delays when sending traces.
var builder = new UriBuilder(agentUri)
{
Host = "127.0.0.1"
};
AgentUri = builder.Uri;
}
AnalyticsEnabled = source?.GetBool(ConfigurationKeys.GlobalAnalyticsEnabled) ??
// default value
false;
LogsInjectionEnabled = source?.GetBool(ConfigurationKeys.LogsInjectionEnabled) ??
// default value
false;
MaxTracesSubmittedPerSecond = source?.GetInt32(ConfigurationKeys.MaxTracesSubmittedPerSecond) ??
// default value
100;
Integrations = new IntegrationSettingsCollection(source);
GlobalTags = source?.GetDictionary(ConfigurationKeys.GlobalTags) ??
// backwards compatibility for names used in the past
source?.GetDictionary("DD_TRACE_GLOBAL_TAGS") ??
// default value (empty)
new ConcurrentDictionary <string, string>();
// Filter out tags with empty keys or empty values, and trim whitespace
GlobalTags = GlobalTags.Where(kvp => !string.IsNullOrEmpty(kvp.Key) && !string.IsNullOrEmpty(kvp.Value))
.ToDictionary(kvp => kvp.Key.Trim(), kvp => kvp.Value.Trim());
HeaderTags = source?.GetDictionary(ConfigurationKeys.HeaderTags) ??
// default value (empty)
new ConcurrentDictionary <string, string>();
// Filter out tags with empty keys or empty values, and trim whitespace
HeaderTags = HeaderTags.Where(kvp => !string.IsNullOrEmpty(kvp.Key) && !string.IsNullOrEmpty(kvp.Value))
.ToDictionary(kvp => kvp.Key.Trim(), kvp => kvp.Value.Trim());
DogStatsdPort = source?.GetInt32(ConfigurationKeys.DogStatsdPort) ??
// default value
8125;
TracerMetricsEnabled = source?.GetBool(ConfigurationKeys.TracerMetricsEnabled) ??
// default value
false;
RuntimeMetricsEnabled = source?.GetBool(ConfigurationKeys.RuntimeMetricsEnabled) ??
false;
CustomSamplingRules = source?.GetString(ConfigurationKeys.CustomSamplingRules);
GlobalSamplingRate = source?.GetDouble(ConfigurationKeys.GlobalSamplingRate);
StartupDiagnosticLogEnabled = source?.GetBool(ConfigurationKeys.StartupDiagnosticLogEnabled) ??
// default value
true;
TraceQueueSize = source?.GetInt32(ConfigurationKeys.QueueSize)
?? 1000;
}
/// <summary>
/// Initializes a new instance of the <see cref="ExporterSettings"/> class.
/// Direct use in tests only.
/// </summary>
/// <param name="source">The <see cref="IConfigurationSource"/> to use when retrieving configuration values.</param>
public ExporterSettings(IConfigurationSource source)
{
ValidationWarnings = new List <string>();
// Get values from the config
var endpointUrl = source?.GetString(ConfigurationKeys.EndpointUrl);
var tracesPipeName = source?.GetString(ConfigurationKeys.TracesPipeName);
var tracesPipeTimeoutMs = source?.GetInt32(ConfigurationKeys.TracesPipeTimeoutMs) ?? 0;
var agentPort = source?.GetInt32(ConfigurationKeys.AgentPort);
var ingestRealm = source?.GetString(ConfigurationKeys.IngestRealm) ??
LocalIngestRealm;
var dogStatsdPort = source?.GetInt32(ConfigurationKeys.DogStatsdPort) ?? 0;
var metricsPipeName = source?.GetString(ConfigurationKeys.MetricsPipeName);
ConfigureTraceTransport(endpointUrl, tracesPipeName, agentPort, ingestRealm);
MetricsExporter = source.GetTypedValue <MetricsExporterType>(ConfigurationKeys.MetricsExporter);
if (MetricsExporter == MetricsExporterType.SignalFx)
{
MetricsEndpointUrl = source.SafeReadUri(
key: ConfigurationKeys.MetricsEndpointUrl,
defaultTo: GetConfiguredMetricsEndpoint(ingestRealm),
out _);
}
else
{
ConfigureStatsdMetricsTransport(endpointUrl, dogStatsdPort, metricsPipeName);
}
ConfigureLogsTransport(source);
TracesPipeTimeoutMs = tracesPipeTimeoutMs > 0 ? tracesPipeTimeoutMs : 500;
PartialFlushEnabled = source?.GetBool(ConfigurationKeys.PartialFlushEnabled) ?? false;
PartialFlushMinSpans = source.SafeReadInt32(
key: ConfigurationKeys.PartialFlushMinSpans,
defaultTo: 500,
validators: (val) => val > 0);
SyncExport = source?.GetBool(ConfigurationKeys.TraceSyncExport) ?? false;
var stringProfileExportFormat = source?.GetString(ConfigurationKeys.AlwaysOnProfiler.ExportFormat);
if (string.IsNullOrEmpty(stringProfileExportFormat))
{
ProfilerExportFormat = ProfilerExportFormat.Pprof;
}
else if (Enum.TryParse(stringProfileExportFormat, out ProfilerExportFormat profilerExportFormat))
{
ProfilerExportFormat = profilerExportFormat;
}
else
{
Log.Logger.Warning("Unknown {0} passed: {1}, using {2} as a default", ConfigurationKeys.AlwaysOnProfiler.ExportFormat, stringProfileExportFormat, ProfilerExportFormat.Pprof);
ProfilerExportFormat = ProfilerExportFormat.Pprof;
}
}
/// <summary>
/// Initializes a new instance of the <see cref="TracerSettings"/> class
/// using the specified <see cref="IConfigurationSource"/> to initialize values.
/// </summary>
/// <param name="source">The <see cref="IConfigurationSource"/> to use when retrieving configuration values.</param>
public TracerSettings(IConfigurationSource source)
{
Environment = source?.GetString(ConfigurationKeys.Environment);
ServiceName = source?.GetString(ConfigurationKeys.ServiceName);
TraceEnabled = source?.GetBool(ConfigurationKeys.TraceEnabled) ??
// default value
true;
var disabledIntegrationNames = source?.GetString(ConfigurationKeys.DisabledIntegrations)
?.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries) ??
Enumerable.Empty <string>();
DisabledIntegrationNames = new HashSet <string>(disabledIntegrationNames, StringComparer.OrdinalIgnoreCase);
var agentHost = source?.GetString(ConfigurationKeys.AgentHost) ??
// backwards compatibility for names used in the past
source?.GetString("DD_TRACE_AGENT_HOSTNAME") ??
source?.GetString("DATADOG_TRACE_AGENT_HOSTNAME") ??
// default value
DefaultAgentHost;
var agentPort = source?.GetInt32(ConfigurationKeys.AgentPort) ??
// backwards compatibility for names used in the past
source?.GetInt32("DATADOG_TRACE_AGENT_PORT") ??
// default value
DefaultAgentPort;
var agentUri = source?.GetString(ConfigurationKeys.AgentUri) ??
// default value
$"http://{agentHost}:{agentPort}";
AgentUri = new Uri(agentUri);
AnalyticsEnabled = source?.GetBool(ConfigurationKeys.GlobalAnalyticsEnabled) ??
// default value
false;
LogsInjectionEnabled = source?.GetBool(ConfigurationKeys.LogsInjectionEnabled) ??
// default value
false;
var maxTracesPerSecond = source?.GetInt32(ConfigurationKeys.MaxTracesSubmittedPerSecond);
if (maxTracesPerSecond != null)
{
// Ensure our flag for the rate limiter is enabled
RuleBasedSampler.OptInTracingWithoutLimits();
}
else
{
maxTracesPerSecond = 100; // default
}
MaxTracesSubmittedPerSecond = maxTracesPerSecond.Value;
Integrations = new IntegrationSettingsCollection(source);
GlobalTags = source?.GetDictionary(ConfigurationKeys.GlobalTags) ??
// default value (empty)
new ConcurrentDictionary <string, string>();
DogStatsdPort = source?.GetInt32(ConfigurationKeys.DogStatsdPort) ??
// default value
8125;
TracerMetricsEnabled = source?.GetBool(ConfigurationKeys.TracerMetricsEnabled) ??
// default value
false;
CustomSamplingRules = source?.GetString(ConfigurationKeys.CustomSamplingRules);
GlobalSamplingRate = source?.GetDouble(ConfigurationKeys.GlobalSamplingRate);
DiagnosticSourceEnabled = source?.GetBool(ConfigurationKeys.DiagnosticSourceEnabled) ??
// default value
true;
}
/// <summary>
/// Initializes a new instance of the <see cref="TracerSettings"/> class
/// using the specified <see cref="IConfigurationSource"/> to initialize values.
/// </summary>
/// <param name="source">The <see cref="IConfigurationSource"/> to use when retrieving configuration values.</param>
public TracerSettings(IConfigurationSource source)
{
Environment = source?.GetString(ConfigurationKeys.Environment);
ServiceName = source?.GetString(ConfigurationKeys.ServiceName);
ServiceNamePerSpanEnabled = source?.GetBool(ConfigurationKeys.ServiceNamePerSpan) ??
false;
SignalFxAccessToken = source?.GetString(ConfigurationKeys.SignalFxAccessToken);
TraceEnabled = source?.GetBool(ConfigurationKeys.TraceEnabled) ??
true;
SynchronousSend = source?.GetBool(ConfigurationKeys.SynchronousSend) ??
false;
var disabledIntegrationNames = source?.GetString(ConfigurationKeys.DisabledIntegrations)
?.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries) ??
Enumerable.Empty <string>();
DisabledIntegrationNames = new HashSet <string>(disabledIntegrationNames, StringComparer.OrdinalIgnoreCase);
var endpointUrl = source?.GetString(ConfigurationKeys.EndpointUrl) ?? DefaultEndpointUrl;
EndpointUrl = new Uri(endpointUrl);
var agentHost = source?.GetString(ConfigurationKeys.AgentHost) ??
// backwards compatibility for names used in the past
source?.GetString("SIGNALFX_TRACE_AGENT_HOSTNAME") ??
source?.GetString("DATADOG_TRACE_AGENT_HOSTNAME") ??
// default value
EndpointUrl.Host;
var agentPort = source?.GetInt32(ConfigurationKeys.AgentPort) ??
// backwards compatibility for names used in the past
source?.GetInt32("DATADOG_TRACE_AGENT_PORT") ??
// default value
EndpointUrl.Port;
var agentUri = source?.GetString(ConfigurationKeys.AgentUri) ??
// default value
$"{EndpointUrl.Scheme}://{agentHost}:{agentPort}";
AgentUri = new Uri(agentUri);
var endpointPath = EndpointUrl.PathAndQuery != "/"
? EndpointUrl.PathAndQuery
: FallbackUriPath;
var agentPath = source?.GetString(ConfigurationKeys.AgentPath) ?? endpointPath;
// We still want tests and users to be able to configure Uri elements, so reform Endpoint Url
EndpointUrl = new Uri(AgentUri, agentPath);
ApiType = source?.GetString(ConfigurationKeys.ApiType) ?? DefaultApiType;
AnalyticsEnabled = source?.GetBool(ConfigurationKeys.GlobalAnalyticsEnabled) ??
// default value
false;
LogsInjectionEnabled = source?.GetBool(ConfigurationKeys.LogsInjectionEnabled) ??
// default value
false;
var maxTracesPerSecond = source?.GetInt32(ConfigurationKeys.MaxTracesSubmittedPerSecond);
if (maxTracesPerSecond != null)
{
// Ensure our flag for the rate limiter is enabled
RuleBasedSampler.OptInTracingWithoutLimits();
}
else
{
maxTracesPerSecond = 100; // default
}
MaxTracesSubmittedPerSecond = maxTracesPerSecond.Value;
Integrations = new IntegrationSettingsCollection(source);
GlobalTags = source?.GetDictionary(ConfigurationKeys.GlobalTags);
DogStatsdPort = source?.GetInt32(ConfigurationKeys.DogStatsdPort) ??
// default value
8125;
TracerMetricsEnabled = source?.GetBool(ConfigurationKeys.TracerMetricsEnabled) ??
// default value
false;
CustomSamplingRules = source?.GetString(ConfigurationKeys.CustomSamplingRules);
GlobalSamplingRate = source?.GetDouble(ConfigurationKeys.GlobalSamplingRate);
DiagnosticSourceEnabled = source?.GetBool(ConfigurationKeys.DiagnosticSourceEnabled) ??
// default value
true;
TagMongoCommands = source?.GetBool(ConfigurationKeys.TagMongoCommands) ?? true;
TagElasticsearchQueries = source?.GetBool(ConfigurationKeys.TagElasticsearchQueries) ?? true;
TagRedisCommands = source?.GetBool(ConfigurationKeys.TagRedisCommands) ?? true;
SanitizeSqlStatements = source?.GetBool(ConfigurationKeys.SanitizeSqlStatements) ?? true;
AdditionalDiagnosticListeners = source?.GetString(ConfigurationKeys.AdditionalDiagnosticListeners)
?.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries)
.Select(s => s.Trim()).ToArray() ??
new string[0];
AppendUrlPathToName = source?.GetBool(ConfigurationKeys.AppendUrlPathToName) ?? false;
UseWebServerResourceAsOperationName = source?.GetBool(ConfigurationKeys.UseWebServerResourceAsOperationName) ?? true;
AddClientIpToServerSpans = source?.GetBool(ConfigurationKeys.AddClientIpToServerSpans) ?? false;
RecordedValueMaxLength = source?.GetInt32(ConfigurationKeys.RecordedValueMaxLength) ?? DefaultRecordedValueMaxLength;
if (RecordedValueMaxLength < 0)
{
RecordedValueMaxLength = DefaultRecordedValueMaxLength;
}
}
/// <summary>
/// Initializes a new instance of the <see cref="TracerSettings"/> class
/// using the specified <see cref="IConfigurationSource"/> to initialize values.
/// </summary>
/// <param name="source">The <see cref="IConfigurationSource"/> to use when retrieving configuration values.</param>
public TracerSettings(IConfigurationSource source)
{
Environment = source?.GetString(ConfigurationKeys.Environment);
ServiceName = source?.GetString(ConfigurationKeys.ServiceName);
ServiceVersion = source?.GetString(ConfigurationKeys.ServiceVersion);
SignalFxAccessToken = source?.GetString(ConfigurationKeys.SignalFxAccessToken);
TraceEnabled = source?.GetBool(ConfigurationKeys.TraceEnabled) ??
// default value
true;
if (AzureAppServices.Metadata.IsRelevant && AzureAppServices.Metadata.IsUnsafeToTrace)
{
TraceEnabled = false;
}
DisabledIntegrationNames = new HashSet <string>(source.GetStrings(ConfigurationKeys.DisabledIntegrations), StringComparer.OrdinalIgnoreCase);
Integrations = new IntegrationSettingsCollection(source);
ExporterSettings = new ExporterSettings(source);
#pragma warning disable 618 // App analytics is deprecated, but still used
AnalyticsEnabled = source?.GetBool(ConfigurationKeys.GlobalAnalyticsEnabled) ??
// default value
false;
#pragma warning restore 618
MaxTracesSubmittedPerSecond = source?.GetInt32(ConfigurationKeys.TraceRateLimit) ??
// default value
100;
GlobalTags = source?.GetDictionary(ConfigurationKeys.GlobalTags) ??
// default value (empty)
new ConcurrentDictionary <string, string>();
// Filter out tags with empty keys or empty values, and trim whitespace
GlobalTags = GlobalTags.Where(kvp => !string.IsNullOrWhiteSpace(kvp.Key) && !string.IsNullOrWhiteSpace(kvp.Value))
.ToDictionary(kvp => kvp.Key.Trim(), kvp => kvp.Value.Trim());
var inputHeaderTags = source?.GetDictionary(ConfigurationKeys.HeaderTags, allowOptionalMappings: true) ??
// default value (empty)
new Dictionary <string, string>();
var headerTagsNormalizationFixEnabled = source?.GetBool(ConfigurationKeys.FeatureFlags.HeaderTagsNormalizationFixEnabled) ?? true;
// Filter out tags with empty keys or empty values, and trim whitespaces
HeaderTags = InitializeHeaderTags(inputHeaderTags, headerTagsNormalizationFixEnabled);
var serviceNameMappings = source?.GetDictionary(ConfigurationKeys.ServiceNameMappings)
?.Where(kvp => !string.IsNullOrWhiteSpace(kvp.Key) && !string.IsNullOrWhiteSpace(kvp.Value))
?.ToDictionary(kvp => kvp.Key.Trim(), kvp => kvp.Value.Trim());
ServiceNameMappings = new ServiceNames(serviceNameMappings);
TracerMetricsEnabled = source?.GetBool(ConfigurationKeys.TracerMetricsEnabled) ??
// default value
false;
TagRedisCommands = source?.GetBool(ConfigurationKeys.TagRedisCommands) ??
// default value
true;
RuntimeMetricsEnabled = source?.GetBool(ConfigurationKeys.RuntimeMetricsEnabled) ??
false;
CustomSamplingRules = source?.GetString(ConfigurationKeys.CustomSamplingRules);
GlobalSamplingRate = source?.GetDouble(ConfigurationKeys.GlobalSamplingRate);
StartupDiagnosticLogEnabled = source?.GetBool(ConfigurationKeys.StartupDiagnosticLogEnabled) ??
// default value
true;
Exporter = source.GetTypedValue <ExporterType>(ConfigurationKeys.Exporter);
Convention = source.GetTypedValue <ConventionType>(ConfigurationKeys.Convention);
var urlSubstringSkips = source?.GetString(ConfigurationKeys.HttpClientExcludedUrlSubstrings) ??
// default value
(AzureAppServices.Metadata.IsRelevant ? AzureAppServices.Metadata.DefaultHttpClientExclusions : null);
if (urlSubstringSkips != null)
{
HttpClientExcludedUrlSubstrings = TrimSplitString(urlSubstringSkips.ToUpperInvariant(), ',').ToArray();
}
var httpServerErrorStatusCodes = source?.GetString(ConfigurationKeys.HttpServerErrorStatusCodes) ??
// Default value
"500-599";
HttpServerErrorStatusCodes = ParseHttpCodesToArray(httpServerErrorStatusCodes);
var httpClientErrorStatusCodes = source?.GetString(ConfigurationKeys.HttpClientErrorStatusCodes) ??
// Default value
"400-599";
HttpClientErrorStatusCodes = ParseHttpCodesToArray(httpClientErrorStatusCodes);
TraceBufferSize = source?.GetInt32(ConfigurationKeys.BufferSize)
?? 1024 * 1024 * 10; // 10MB
TraceBatchInterval = source?.GetInt32(ConfigurationKeys.SerializationBatchInterval)
?? 100;
RecordedValueMaxLength = source.SafeReadInt32(
key: ConfigurationKeys.RecordedValueMaxLength,
defaultTo: DefaultRecordedValueMaxLength,
validators: (value) => value >= 0);
RouteTemplateResourceNamesEnabled = source?.GetBool(ConfigurationKeys.FeatureFlags.RouteTemplateResourceNamesEnabled)
?? true;
TraceResponseHeaderEnabled = source?.GetBool(ConfigurationKeys.TraceResponseHeaderEnabled)
?? true;
ExpandRouteTemplatesEnabled = source?.GetBool(ConfigurationKeys.ExpandRouteTemplatesEnabled)
// disabled by default if route template resource names enabled
?? !RouteTemplateResourceNamesEnabled;
KafkaCreateConsumerScopeEnabled = source?.GetBool(ConfigurationKeys.KafkaCreateConsumerScopeEnabled)
?? true; // default
TagMongoCommands = source?.GetBool(ConfigurationKeys.TagMongoCommands) ?? true;
DelayWcfInstrumentationEnabled = source?.GetBool(ConfigurationKeys.FeatureFlags.DelayWcfInstrumentationEnabled)
?? false;
PropagationStyleInject = TrimSplitString(source?.GetString(ConfigurationKeys.Propagators) ?? $"{nameof(Propagators.ContextPropagators.Names.B3)},{nameof(Propagators.ContextPropagators.Names.W3C)}", ',').ToArray();
PropagationStyleExtract = PropagationStyleInject;
TagElasticsearchQueries = source?.GetBool(ConfigurationKeys.TagElasticsearchQueries) ?? true;
// If you change this, change environment_variables.h too
ThreadSamplingEnabled = source?.GetBool(ConfigurationKeys.AlwaysOnProfiler.Enabled) ?? false;
ThreadSamplingPeriod = GetThreadSamplingPeriod(source);
LogSubmissionSettings = new DirectLogSubmissionSettings(source);
TraceMethods = source?.GetString(ConfigurationKeys.TraceMethods) ??
// Default value
string.Empty;
var grpcTags = source?.GetDictionary(ConfigurationKeys.GrpcTags, allowOptionalMappings: true) ??
// default value (empty)
new Dictionary <string, string>();
// Filter out tags with empty keys or empty values, and trim whitespaces
GrpcTags = InitializeHeaderTags(grpcTags, headerTagsNormalizationFixEnabled: true);
IsActivityListenerEnabled = source?.GetBool(ConfigurationKeys.FeatureFlags.ActivityListenerEnabled) ??
// default value
false;
if (IsActivityListenerEnabled)
{
// If the activities support is activated, we must enable W3C propagators
if (!Array.Exists(PropagationStyleExtract, key => string.Equals(key, nameof(Propagators.ContextPropagators.Names.W3C), StringComparison.OrdinalIgnoreCase)))
{
PropagationStyleExtract = PropagationStyleExtract.Concat(nameof(Propagators.ContextPropagators.Names.W3C));
}
if (!Array.Exists(PropagationStyleInject, key => string.Equals(key, nameof(Propagators.ContextPropagators.Names.W3C), StringComparison.OrdinalIgnoreCase)))
{
PropagationStyleInject = PropagationStyleInject.Concat(nameof(Propagators.ContextPropagators.Names.W3C));
}
}
}
/// <summary>
/// Initializes a new instance of the <see cref="TracerSettings"/> class
/// using the specified <see cref="IConfigurationSource"/> to initialize values.
/// </summary>
/// <param name="source">The <see cref="IConfigurationSource"/> to use when retrieving configuration values.</param>
public TracerSettings(IConfigurationSource source)
{
Environment = source?.GetString(ConfigurationKeys.Environment);
ServiceName = source?.GetString(ConfigurationKeys.ServiceName) ??
// backwards compatibility for names used in the past
source?.GetString("DD_SERVICE_NAME");
ServiceVersion = source?.GetString(ConfigurationKeys.ServiceVersion);
TraceEnabled = source?.GetBool(ConfigurationKeys.TraceEnabled) ??
// default value
true;
if (AzureAppServices.Metadata.IsRelevant && AzureAppServices.Metadata.IsUnsafeToTrace)
{
TraceEnabled = false;
}
var disabledIntegrationNames = source?.GetString(ConfigurationKeys.DisabledIntegrations)
?.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries) ??
Enumerable.Empty <string>();
DisabledIntegrationNames = new HashSet <string>(disabledIntegrationNames, StringComparer.OrdinalIgnoreCase);
Integrations = new IntegrationSettingsCollection(source);
Exporter = new ExporterSettings(source);
#pragma warning disable 618 // App analytics is deprecated, but still used
AnalyticsEnabled = source?.GetBool(ConfigurationKeys.GlobalAnalyticsEnabled) ??
// default value
false;
#pragma warning restore 618
LogsInjectionEnabled = source?.GetBool(ConfigurationKeys.LogsInjectionEnabled) ??
// default value
false;
MaxTracesSubmittedPerSecond = source?.GetInt32(ConfigurationKeys.TraceRateLimit) ??
#pragma warning disable 618 // this parameter has been replaced but may still be used
source?.GetInt32(ConfigurationKeys.MaxTracesSubmittedPerSecond) ??
#pragma warning restore 618
// default value
100;
GlobalTags = source?.GetDictionary(ConfigurationKeys.GlobalTags) ??
// backwards compatibility for names used in the past
source?.GetDictionary("DD_TRACE_GLOBAL_TAGS") ??
// default value (empty)
new ConcurrentDictionary <string, string>();
// Filter out tags with empty keys or empty values, and trim whitespace
GlobalTags = GlobalTags.Where(kvp => !string.IsNullOrWhiteSpace(kvp.Key) && !string.IsNullOrWhiteSpace(kvp.Value))
.ToDictionary(kvp => kvp.Key.Trim(), kvp => kvp.Value.Trim());
var inputHeaderTags = source?.GetDictionary(ConfigurationKeys.HeaderTags, allowOptionalMappings: true) ??
// default value (empty)
new Dictionary <string, string>();
var headerTagsNormalizationFixEnabled = source?.GetBool(ConfigurationKeys.FeatureFlags.HeaderTagsNormalizationFixEnabled) ?? true;
// Filter out tags with empty keys or empty values, and trim whitespaces
HeaderTags = InitializeHeaderTags(inputHeaderTags, headerTagsNormalizationFixEnabled);
var serviceNameMappings = source?.GetDictionary(ConfigurationKeys.ServiceNameMappings)
?.Where(kvp => !string.IsNullOrWhiteSpace(kvp.Key) && !string.IsNullOrWhiteSpace(kvp.Value))
?.ToDictionary(kvp => kvp.Key.Trim(), kvp => kvp.Value.Trim());
ServiceNameMappings = new ServiceNames(serviceNameMappings);
TracerMetricsEnabled = source?.GetBool(ConfigurationKeys.TracerMetricsEnabled) ??
// default value
false;
RuntimeMetricsEnabled = source?.GetBool(ConfigurationKeys.RuntimeMetricsEnabled) ??
false;
CustomSamplingRules = source?.GetString(ConfigurationKeys.CustomSamplingRules);
GlobalSamplingRate = source?.GetDouble(ConfigurationKeys.GlobalSamplingRate);
StartupDiagnosticLogEnabled = source?.GetBool(ConfigurationKeys.StartupDiagnosticLogEnabled) ??
// default value
true;
var urlSubstringSkips = source?.GetString(ConfigurationKeys.HttpClientExcludedUrlSubstrings) ??
// default value
(AzureAppServices.Metadata.IsRelevant ? AzureAppServices.Metadata.DefaultHttpClientExclusions : null);
if (urlSubstringSkips != null)
{
HttpClientExcludedUrlSubstrings = TrimSplitString(urlSubstringSkips.ToUpperInvariant(), ',').ToArray();
}
var httpServerErrorStatusCodes = source?.GetString(ConfigurationKeys.HttpServerErrorStatusCodes) ??
// Default value
"500-599";
HttpServerErrorStatusCodes = ParseHttpCodesToArray(httpServerErrorStatusCodes);
var httpClientErrorStatusCodes = source?.GetString(ConfigurationKeys.HttpClientErrorStatusCodes) ??
// Default value
"400-499";
HttpClientErrorStatusCodes = ParseHttpCodesToArray(httpClientErrorStatusCodes);
TraceBufferSize = source?.GetInt32(ConfigurationKeys.BufferSize)
?? 1024 * 1024 * 10; // 10MB
TraceBatchInterval = source?.GetInt32(ConfigurationKeys.SerializationBatchInterval)
?? 100;
RouteTemplateResourceNamesEnabled = source?.GetBool(ConfigurationKeys.FeatureFlags.RouteTemplateResourceNamesEnabled)
?? true;
ExpandRouteTemplatesEnabled = source?.GetBool(ConfigurationKeys.ExpandRouteTemplatesEnabled)
// disabled by default if route template resource names enabled
?? !RouteTemplateResourceNamesEnabled;
KafkaCreateConsumerScopeEnabled = source?.GetBool(ConfigurationKeys.KafkaCreateConsumerScopeEnabled)
?? true; // default
DelayWcfInstrumentationEnabled = source?.GetBool(ConfigurationKeys.FeatureFlags.DelayWcfInstrumentationEnabled)
?? false;
PropagationStyleInject = TrimSplitString(source?.GetString(ConfigurationKeys.PropagationStyleInject) ?? nameof(Propagators.ContextPropagators.Names.Datadog), ',').ToArray();
PropagationStyleExtract = TrimSplitString(source?.GetString(ConfigurationKeys.PropagationStyleExtract) ?? nameof(Propagators.ContextPropagators.Names.Datadog), ',').ToArray();
LogSubmissionSettings = new DirectLogSubmissionSettings(source);
}
