Skip to content

Commit 808eaac

Browse files
committed
last fixes before replacing ConfigurationKeys
1 parent 7f62e82 commit 808eaac

File tree

1 file changed

+85
-10
lines changed

1 file changed

+85
-10
lines changed

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

Lines changed: 85 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,80 @@ DD_APPSEC_RULES: |
5353
Override the default rules file provided. Must be a path to a valid JSON rules file.
5454
Default is value is null (do not override).
5555
56+
DD_APPSEC_KEEP_TRACES: |
57+
Specifies if the AppSec traces should be explicitly kept or dropped.
58+
Default is true, to keep all traces, false means drop all traces (by setting AutoReject as sampling priority).
59+
For internal testing only.
60+
61+
DD_APPSEC_TRACE_RATE_LIMIT: |
62+
Limits the amount of AppSec traces sent per second with an integer value, strictly positive.
63+
64+
DD_APPSEC_WAF_TIMEOUT: |
65+
WAF timeout in microseconds of each WAF execution (the timeout value passed to ddwaf_run).
66+
67+
DD_APPSEC_RASP_ENABLED: |
68+
default value to true. Set to false to disable exploit prevention.
69+
70+
DD_APPSEC_STACK_TRACE_ENABLED: |
71+
with a default value of true, it allows a customer to disable the generation of stack traces, for any ASM-specific purpose such as RASP.
72+
73+
DD_APPSEC_MAX_STACK_TRACES: |
74+
with a default value of 2, defines the maximum number of stack traces to be reported due to RASP events. 0 for unlimited.
75+
76+
DD_APPSEC_MAX_STACK_TRACE_DEPTH: |
77+
with a default value of 32, defines the maximum depth of a stack trace to be reported due to RASP events. O for unlimited.
78+
79+
DD_APPSEC_MAX_STACK_TRACE_DEPTH_TOP_PERCENT: |
80+
with a default value of 75, defines the percentage of frames taken from the top of the stack when trimming. Min 0, Max 100
81+
82+
DD_APPSEC_OBFUSCATION_PARAMETER_KEY_REGEXP: |
83+
The regex that will be used to obfuscate possible sensitive data in keys that are highlighted WAF as potentially malicious
84+
85+
DD_APPSEC_OBFUSCATION_PARAMETER_VALUE_REGEXP: |
86+
The regex that will be used to obfuscate possible sensitive data in values that are highlighted WAF as potentially malicious
87+
88+
DD_APPSEC_HTTP_BLOCKED_TEMPLATE_HTML: |
89+
Blocking response template for HTML content. This template is used in combination with the status code to craft and send a response upon blocking the request.
90+
91+
DD_APPSEC_HTTP_BLOCKED_TEMPLATE_JSON: |
92+
Blocking response template for Json content. This template is used in combination with the status code to craft and send a response upon blocking the request.
93+
94+
DD_APPSEC_AUTOMATED_USER_EVENTS_TRACKING: |
95+
Deprecate. Automatic tracking of user events mode. Values can be disabled, safe or extended.
96+
This config is in the process of being deprecated. Please use DD_APPSEC_AUTO_USER_INSTRUMENTATION_MODE
97+
instead.
98+
Values will be automatically translated:
99+
disabled = disabled
100+
safe = anon
101+
extended = ident
102+
103+
DD_APPSEC_AUTO_USER_INSTRUMENTATION_MODE: |
104+
Automatic instrumentation of user event mode. Values can be ident, disabled, anon.
105+
106+
DD_API_SECURITY_ENABLED: |
107+
When ASM is enabled, collects in spans endpoints apis schemas analyzed by the waf, default value is true.
108+
109+
DD_API_SECURITY_SAMPLE_DELAY: |
110+
Api security sample delay in seconds , should be a float. Set to 0 for testing purposes. default value of 30.
111+
112+
DD_API_SECURITY_ENDPOINT_COLLECTION_ENABLED: |
113+
with a default value of true, it allows a customer to disable the collection of endpoints for API Security.
114+
115+
DD_API_SECURITY_ENDPOINT_COLLECTION_MESSAGE_LIMIT: |
116+
with a default value of 300, it defines the maximum number of endpoints to be collected (serialized) for API Security.
117+
118+
DD_API_SECURITY_PARSE_RESPONSE_BODY: |
119+
Enables the parsing of the response body in the API Security module. Defaults to true
120+
121+
DD_EXPERIMENTAL_APPSEC_USE_UNSAFE_ENCODER: |
122+
Use new unsafe encoder for the waf
123+
124+
DD_APPSEC_WAF_DEBUG: |
125+
Activate debug logs for the WAF
126+
127+
DD_APPSEC_SCA_ENABLED: |
128+
Activate SCA (Software Composition Analysis), used in the backend
129+
56130
DD_CIVISIBILITY_AGENTLESS_ENABLED: |
57131
Configuration key for enabling or disabling Agentless in CI Visibility.
58132
Default value is false (disabled).
@@ -348,7 +422,7 @@ DD_INSTRUMENTATION_TELEMETRY_AGENTLESS_ENABLED: |
348422
DD_INSTRUMENTATION_TELEMETRY_AGENT_PROXY_ENABLED: |
349423
Configuration key for sending telemetry via agent proxy. If enabled, sends telemetry
350424
via agent proxy. Enabled by default. If disabled, or agent is not available, telemetry
351-
is sent to agentless endpoint, based on <see cref="Datadog.Trace.Configuration.ConfigurationKeys2.CIVisibility.AgentlessEnabled"/> setting.
425+
is sent to agentless endpoint, based on <see cref="Datadog.Trace.Configuration.ConfigurationKeys.CIVisibility.AgentlessEnabled"/> setting.
352426
353427
DD_INSTRUMENTATION_TELEMETRY_ENABLED: |
354428
Configuration key for enabling or disabling internal telemetry.
@@ -768,7 +842,8 @@ DD_TRACE_INJECT_CONTEXT_INTO_STORED_PROCEDURES_ENABLED: |
768842
Default value is <c>false</c> (enabled).
769843
When enabled, Datadog trace context will be injected into individual stored procedure calls when the following requirements are met:
770844
<ul>
771-
<li>The database is Microsoft SQL Server and <see cref="Tracer.DbmPropagationMode"/> is set to <c>service</c> or
845+
<li>The database is Microsoft SQL Server and <see cref="TracerSettings.DbmPropagationMode"/> is set to
846+
<c>service</c> or
772847
<c>full</c>.</li>
773848
<li>The stored procedure call does not have <c>Output</c>, <c>InputOutput</c>, or <c>Return</c> ADO.NET command parameters.</li>
774849
</ul>
@@ -972,30 +1047,30 @@ DD_VERSION: |
9721047
9731048
OTEL_EXPORTER_OTLP_ENDPOINT: |
9741049
Configuration key to set the OTLP endpoint URL (fallback for metrics-specific endpoint).
975-
Used when <see cref="OtelExporterOtlpMetricsEndpoint"/> is not set.
1050+
Used when <see cref="ExporterOtlpMetricsEndpoint"/> is not set.
9761051
Expects values like `unix:///path/to/socket.sock` for UDS, `\\.\pipename\` for Windows Named Pipes.
9771052
Default values: gRPC: http://localhost:4317, HTTP: http://localhost:4318
9781053
9791054
OTEL_EXPORTER_OTLP_HEADERS: |
9801055
Configuration key to set custom headers for OTLP export (fallback for metrics-specific headers).
981-
Used when <see cref="OtelExporterOtlpMetricsHeaders"/> is not set.
1056+
Used when <see cref="ExporterOtlpMetricsHeaders"/> is not set.
9821057
Format: api-key=key,other=value.
9831058
9841059
OTEL_EXPORTER_OTLP_METRICS_ENDPOINT: |
9851060
Configuration key to set the OTLP endpoint URL for metrics.
986-
Takes precedence over <see cref="OtelExporterOtlpEndpoint"/>.
1061+
Takes precedence over <see cref="ExporterOtlpEndpoint"/>.
9871062
This value typically ends with v1/metrics when using OTLP/HTTP.
9881063
Expects values like `unix:///path/to/socket.sock` for UDS, `\\.\pipename\` for Windows Named Pipes.
9891064
Default values: gRPC: http://localhost:4317, HTTP: http://localhost:4318/v1/metrics
9901065
9911066
OTEL_EXPORTER_OTLP_METRICS_HEADERS: |
9921067
Configuration key to set custom headers for OTLP metrics export.
993-
Takes precedence over <see cref="OtelExporterOtlpHeaders"/>.
1068+
Takes precedence over <see cref="ExporterOtlpHeaders"/>.
9941069
Format: api-key=key,other=value.
9951070
9961071
OTEL_EXPORTER_OTLP_METRICS_PROTOCOL: |
9971072
Configuration key to set the OTLP protocol for metrics export.
998-
Takes precedence over <see cref="OtelExporterOtlpProtocol"/>.
1073+
Takes precedence over <see cref="ExporterOtlpProtocol"/>.
9991074
Valid values: grpc, http/protobuf, http/json, defaults to http/protobuf.
10001075
10011076
OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE: |
@@ -1006,17 +1081,17 @@ OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE: |
10061081
10071082
OTEL_EXPORTER_OTLP_METRICS_TIMEOUT: |
10081083
Configuration key to set the request timeout for OTLP metrics export in milliseconds.
1009-
Takes precedence over <see cref="OtelExporterOtlpTimeout"/>.
1084+
Takes precedence over <see cref="ExporterOtlpTimeoutMs"/>.
10101085
Default value is 10000ms.
10111086
10121087
OTEL_EXPORTER_OTLP_PROTOCOL: |
10131088
Configuration key to set the OTLP protocol (fallback for metrics-specific protocol).
1014-
Used when <see cref="OtelExporterOtlpMetricsProtocol"/> is not set.
1089+
Used when <see cref="ExporterOtlpMetricsProtocol"/> is not set.
10151090
Valid values: grpc, http/protobuf, http/json, defaults to http/protobuf.
10161091
10171092
OTEL_EXPORTER_OTLP_TIMEOUT: |
10181093
Configuration key to set the request timeout for OTLP export (fallback for metrics-specific timeout).
1019-
Used when <see cref="OtelExporterOtlpMetricsTimeout"/> is not set.
1094+
Used when <see cref="ExporterOtlpMetricsTimeoutMs"/> is not set.
10201095
Default value is 10000ms.
10211096
10221097
OTEL_LOG_LEVEL: |

0 commit comments

Comments
 (0)