Skip to content

Commit 9ac42fd

Browse files
authored
Update documentation to account for MutableSettings (#7867)
## Summary of changes - Fix broken `master` due to concurrent merges of conflicting ## Reason for change #7698 moved to defining references in yaml, and in #7723, some of those references moved, which broke the build ## Implementation details Update the YAML file and rebuild ## Test coverage If it builds, we're good!
1 parent 0941efa commit 9ac42fd

File tree

5 files changed

+115
-115
lines changed

5 files changed

+115
-115
lines changed

tracer/src/Datadog.Trace/Configuration/supported-configurations-docs.yaml

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ DD_DISABLED_INTEGRATIONS: |
239239
Configuration key for a list of integrations to disable. All other integrations remain enabled.
240240
Default is empty (all integrations are enabled).
241241
Supports multiple values separated with semi-colons.
242-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.DisabledIntegrationNames"/>
242+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.DisabledIntegrationNames"/>
243243
244244
DD_DOGSTATSD_ARGS: |
245245
Configuration key for arguments to pass to the DogStatsD process.
@@ -305,7 +305,7 @@ DD_DYNAMIC_INSTRUMENTATION_UPLOAD_FLUSH_INTERVAL: |
305305
306306
DD_ENV: |
307307
Configuration key for the application's environment. Sets the "env" tag on every <see cref="Span"/>.
308-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.Environment"/>
308+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.Environment"/>
309309
310310
DD_EXCEPTION_DEBUGGING_ENABLED: |
311311
The old configuration key for enabling or disabling Exception Replay.
@@ -332,19 +332,19 @@ DD_EXCEPTION_REPLAY_RATE_LIMIT_SECONDS: |
332332
333333
DD_GIT_COMMIT_SHA: |
334334
Configuration key for the application's git commit hash. Sets the "_dd.git.commit.sha" tag on every <see cref="Span"/>.
335-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.GitCommitSha"/>
335+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.GitCommitSha"/>
336336
337337
DD_GIT_REPOSITORY_URL: |
338338
Configuration key for the application's git repo URL. Sets the "_dd.git.repository_url" tag on every <see cref="Span"/>.
339-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.GitRepositoryUrl"/>
339+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.GitRepositoryUrl"/>
340340
341341
DD_HTTP_CLIENT_ERROR_STATUSES: |
342342
Configuration key for the application's client http statuses to set spans as errors by.
343-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.HttpClientErrorStatusCodes"/>
343+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.HttpClientErrorStatusCodes"/>
344344
345345
DD_HTTP_SERVER_ERROR_STATUSES: |
346346
Configuration key for the application's server http statuses to set spans as errors by.
347-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.HttpServerErrorStatusCodes"/>
347+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.HttpServerErrorStatusCodes"/>
348348
349349
DD_HTTP_SERVER_TAG_QUERY_STRING: |
350350
Configuration key for enabling/disabling reporting query string
@@ -506,7 +506,7 @@ DD_LOGS_DIRECT_SUBMISSION_URL: |
506506
DD_LOGS_INJECTION: |
507507
Configuration key for enabling or disabling the automatic injection
508508
of correlation identifiers into the logging context.
509-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.LogsInjectionEnabled"/>
509+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.LogsInjectionEnabled"/>
510510
511511
DD_MAX_LOGFILE_SIZE: |
512512
Configuration key for setting the approximate maximum size,
@@ -516,7 +516,7 @@ DD_MAX_LOGFILE_SIZE: |
516516
DD_MAX_TRACES_PER_SECOND: |
517517
Configuration key for setting the number of traces allowed
518518
to be submitted per second.
519-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.MaxTracesSubmittedPerSecond"/>
519+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.MaxTracesSubmittedPerSecond"/>
520520
521521
DD_METRICS_OTEL_ENABLED: |
522522
Enables experimental support for exporting OTLP metrics generated by the OpenTelemetry Metrics API.
@@ -551,7 +551,7 @@ DD_SERVICE: |
551551
Configuration key for the application's default service name.
552552
Used as the service name for top-level spans,
553553
and used to determine service name of some child spans.
554-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.ServiceName"/>
554+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.ServiceName"/>
555555
556556
DD_SITE: |
557557
Configuration key for setting the default Datadog destination site.
@@ -610,7 +610,7 @@ DD_TAGS: |
610610
Configuration key for a list of tags to be applied globally to spans.
611611
Supports multiple key key-value pairs which are comma-separated, and for which the key and
612612
value are colon-separated. For example Key1:Value1, Key2:Value2
613-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.GlobalTags"/>
613+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.GlobalTags"/>
614614
615615
DD_TELEMETRY_DEPENDENCY_COLLECTION_ENABLED: |
616616
Configuration key for whether dependency data is sent via telemetry.
@@ -684,7 +684,7 @@ DD_TRACE_AGENT_URL: |
684684
685685
DD_TRACE_ANALYTICS_ENABLED: |
686686
Configuration key for enabling or disabling default Analytics.
687-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.AnalyticsEnabled"/>
687+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.AnalyticsEnabled"/>
688688
689689
DD_TRACE_AWS_ADD_SPAN_POINTERS: |
690690
Configuration key for toggling span pointers on AWS requests.
@@ -808,7 +808,7 @@ DD_TRACE_DISABLED_ADONET_COMMAND_TYPES: |
808808
DD_TRACE_ENABLED: |
809809
Configuration key for enabling or disabling the Tracer.
810810
Default value is true (enabled).
811-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.TraceEnabled"/>
811+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.TraceEnabled"/>
812812
813813
DD_TRACE_EXPAND_ROUTE_TEMPLATES_ENABLED: |
814814
Configuration key for controlling whether route parameters in ASP.NET and ASP.NET Core resource names
@@ -832,12 +832,12 @@ DD_TRACE_GRAPHQL_ERROR_EXTENSIONS: |
832832
DD_TRACE_GRPC_TAGS: |
833833
Configuration key for a map of metadata keys to tag names.
834834
Automatically apply GRPC metadata values as tags on traces.
835-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.HeaderTags"/>
835+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.HeaderTags"/>
836836
837837
DD_TRACE_HEADER_TAGS: |
838838
Configuration key for a map of header keys to tag names.
839839
Automatically apply header values as tags on traces.
840-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.HeaderTags"/>
840+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.HeaderTags"/>
841841
842842
DD_TRACE_HEADER_TAG_NORMALIZATION_FIX_ENABLED: |
843843
Enables a fix for header tags normalization.
@@ -846,15 +846,15 @@ DD_TRACE_HEADER_TAG_NORMALIZATION_FIX_ENABLED: |
846846
847847
DD_TRACE_HTTP_CLIENT_ERROR_STATUSES: |
848848
Configuration key for the application's client http statuses to set spans as errors by.
849-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.HttpClientErrorStatusCodes"/>
849+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.HttpClientErrorStatusCodes"/>
850850
851851
DD_TRACE_HTTP_CLIENT_EXCLUDED_URL_SUBSTRINGS: |
852852
Configuration key for overriding which URLs are skipped by the tracer.
853853
<seealso cref="Datadog.Trace.Configuration.TracerSettings.HttpClientExcludedUrlSubstrings"/>
854854
855855
DD_TRACE_HTTP_SERVER_ERROR_STATUSES: |
856856
Configuration key for the application's server http statuses to set spans as errors by.
857-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.HttpServerErrorStatusCodes"/>
857+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.HttpServerErrorStatusCodes"/>
858858
859859
DD_TRACE_INJECT_CONTEXT_INTO_STORED_PROCEDURES_ENABLED: |
860860
Configuration key to enable or disable the injection of the Datadog trace context into stored procedures.
@@ -871,7 +871,7 @@ DD_TRACE_KAFKA_CREATE_CONSUMER_SCOPE_ENABLED: |
871871
Configuration key to enable or disable the creation of a span context on exiting a successful Kafka
872872
Consumer.Consume() call, and closing the scope on entering Consumer.Consume().
873873
Default value is <c>true</c> (enabled).
874-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.KafkaCreateConsumerScopeEnabled"/>
874+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.KafkaCreateConsumerScopeEnabled"/>
875875
876876
DD_TRACE_LOGFILE_RETENTION_DAYS: |
877877
Configuration key for setting in number of days when to delete log files based on their last writetime date.
@@ -975,7 +975,7 @@ DD_TRACE_PROPAGATION_STYLE_INJECT: |
975975
DD_TRACE_RATE_LIMIT: |
976976
Configuration key for setting the number of traces allowed
977977
to be submitted per second.
978-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.MaxTracesSubmittedPerSecond"/>
978+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.MaxTracesSubmittedPerSecond"/>
979979
980980
DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED: |
981981
Configuration key for unifying client service names when the span
@@ -1018,16 +1018,16 @@ DD_TRACE_SAMPLING_RULES: |
10181018
'[{"sample_rate":0.5, "service":"cart.*"}, {"sample_rate":0.2, "name":"http.request"}, {"sample_rate":1.0, "service":"background", "name":"sql.query"}, {"sample_rate":0.1}]'
10191019
10201020
If no rules are specified, or none match, default internal sampling logic will be used.
1021-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.CustomSamplingRules"/>
1021+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.CustomSamplingRules"/>
10221022
10231023
DD_TRACE_SAMPLING_RULES_FORMAT: |
1024-
Configuration key for setting the format of <see cref="Datadog.Trace.Configuration.TracerSettings.CustomSamplingRules"/>.
1024+
Configuration key for setting the format of <see cref="Datadog.Trace.Configuration.MutableSettings.CustomSamplingRules"/>.
10251025
Valid values are <c>regex</c> or <c>glob</c>.
10261026
If the value is not recognized, trace sampling rules are disabled.
10271027
10281028
DD_TRACE_SERVICE_MAPPING: |
10291029
Configuration key for a map of services to rename.
1030-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.ServiceNameMappings"/>
1030+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.ServiceNameMappings"/>
10311031
10321032
DD_TRACE_SPAN_ATTRIBUTE_SCHEMA: |
10331033
Configuration key for setting the schema version for service naming and span attributes
@@ -1036,7 +1036,7 @@ DD_TRACE_SPAN_ATTRIBUTE_SCHEMA: |
10361036
10371037
DD_TRACE_STARTUP_LOGS: |
10381038
Configuration key for enabling or disabling the diagnostic log at startup
1039-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.StartupDiagnosticLogEnabled"/>
1039+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.StartupDiagnosticLogEnabled"/>
10401040
10411041
DD_TRACE_STATS_COMPUTATION_ENABLED: |
10421042
Configuration key for enabling computation of stats (aka trace metrics) on the tracer side
@@ -1062,7 +1062,7 @@ DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH: |
10621062
10631063
DD_VERSION: |
10641064
Configuration key for the application's version. Sets the "version" tag on every <see cref="Span"/>.
1065-
<seealso cref="Datadog.Trace.Configuration.TracerSettings.ServiceVersion"/>
1065+
<seealso cref="Datadog.Trace.Configuration.MutableSettings.ServiceVersion"/>
10661066
10671067
OTEL_EXPORTER_OTLP_ENDPOINT: |
10681068
Configuration key to set the OTLP endpoint URL (fallback for metrics-specific endpoint).

0 commit comments

Comments
 (0)