Skip to content

Commit de41d2a

Browse files
chore(aap): update doc (#14627)
Updating documentation for appsec env vars. APPSEC-58715 APPSEC-58683 ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
1 parent 415e0e8 commit de41d2a

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

docs/configuration.rst

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -461,8 +461,8 @@ Metrics
461461
version_added:
462462
v3.11.0:
463463

464-
AppSec
465-
------
464+
Application & API Security
465+
--------------------------
466466

467467
.. ddtrace-configuration-options::
468468

@@ -528,6 +528,29 @@ AppSec
528528
default: True
529529
description: Whether to enable stack traces in reports for ASM. Currently used for exploit prevention reports.
530530

531+
DD_APPSEC_WAF_TIMEOUT:
532+
type: Float
533+
default: 5.0 (unit:milliseconds)
534+
description: |
535+
Each time the WAF is run to analyze a possible threat, this timeout duration is used to limit the WAF analysis.
536+
You can increase this value if you're expecting large request payloads to be analyzed.
537+
Please note that the WAF can be queried multiple times in a single trace.
538+
539+
DD_API_SECURITY_MAX_DOWNSTREAM_REQUEST_BODY_ANALYSIS:
540+
type: Integer
541+
default: 1
542+
description: Maximum number of downstream requests per request whose (request and response) bodies will be analyzed by the WAF
543+
544+
DD_API_SECURITY_DOWNSTREAM_REQUEST_BODY_ANALYSIS_SAMPLE_RATE:
545+
type: Float
546+
default: 0.5 (between 0. and 1.)
547+
description: sampling rate for body analysis of downstream requests. Default value is 50%.
548+
549+
Code Security
550+
-------------
551+
552+
.. ddtrace-configuration-options::
553+
531554
DD_IAST_ENABLED:
532555
type: Boolean
533556
default: False

0 commit comments

Comments
 (0)