-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Documentation to run iast when apm is disabled #33042
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,8 +11,7 @@ | |||||
| Before setting up Runtime Code Analysis (IAST), ensure the following prerequisites are met: | ||||||
|
|
||||||
| 1. **Datadog Agent Installation:** The Datadog Agent is installed and configured for your application's operating system or container, cloud, or virtual environment. | ||||||
| 2. **Datadog APM Configuration:** Datadog APM is configured for your application or service, and web traces (`type:web`) are being received by Datadog. | ||||||
| 3. **Supported Tracing Library:** The Datadog Tracing Library used by your application or service supports Runtime Code Analysis (IAST) capabilities for the language of your application or service. For more details, see the **Compatibility Requirements** section below. | ||||||
| 2. **Supported Tracing Library:** The Datadog Tracing Library used by your application or service supports Runtime Code Analysis (IAST) capabilities for the language of your application or service. For more details, see the **Compatibility Requirements** section below. | ||||||
|
|
||||||
| ## Using Datadog Tracing Libraries | ||||||
|
|
||||||
|
|
@@ -87,6 +86,34 @@ | |||||
| ] | ||||||
| ``` | ||||||
|
|
||||||
| #### APM Tracing disabled | ||||||
|
|
||||||
| To disable APM tracing while keeping IAST enabled, you must set the APM tracing variable to false. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| {{< tabs >}} | ||||||
| {{% tab "Using system properties" %}} | ||||||
|
|
||||||
| Start your Java application with the Datadog agent and IAST enabled using system properties: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ```bash | ||||||
| java -javaagent:/path/to/dd-java-agent.jar -Ddd.iast.enabled=true -Ddd.apm.tracing.enabled=false -Ddd.service=<MY_SERVICE> -Ddd.env=<MY_ENV> -jar path/to/app.jar | ||||||
| ``` | ||||||
| {{% /tab %}} | ||||||
|
|
||||||
| {{% tab "Using environment variables" %}} | ||||||
|
|
||||||
| Set the required environment variables: | ||||||
|
|
||||||
| ```Dockerfile | ||||||
| DD_IAST_ENABLED=true | ||||||
| DD_APM_TRACING_ENABLED=false | ||||||
| DD_SERVICE=<YOUR_SERVICE_NAME> | ||||||
| DD_ENV=<YOUR_ENVIRONMENT> | ||||||
| ``` | ||||||
| {{% /tab %}} | ||||||
| {{< /tabs >}} | ||||||
|
|
||||||
|
|
||||||
| [1]: https://github.com/DataDog/dd-trace-java/releases | ||||||
| [2]: /security/code_security/iast/setup/ | ||||||
| [3]: /security/code_security/iast/setup/ | ||||||
|
|
@@ -199,6 +226,18 @@ | |||||
| ENV DD_IAST_ENABLED=true | ||||||
| ``` | ||||||
|
|
||||||
| #### APM Tracing disabled | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| To disable APM tracing while keeping IAST enabled, you must set the APM tracing variable to false. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ```Dockerfile | ||||||
| DD_IAST_ENABLED=true | ||||||
| DD_APM_TRACING_ENABLED=false | ||||||
| DD_SERVICE=<YOUR_SERVICE_NAME> | ||||||
| DD_ENV=<YOUR_ENVIRONMENT> | ||||||
| ``` | ||||||
|
|
||||||
|
|
||||||
| To see Runtime Code Analysis (IAST) in action, browse your service and find code-level vulnerabilities in the [Vulnerability Explorer][4]. | ||||||
|
|
||||||
| {{< img src="/security/application_security/Code-Level-Vulnerability-Details-New.mp4" alt="Video showing Code Vulnerabilities" video="true" >}} | ||||||
|
|
@@ -280,6 +319,17 @@ | |||||
| ] | ||||||
| ``` | ||||||
|
|
||||||
| #### APM Tracing disabled | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| To disable APM tracing while keeping IAST enabled, you must set the APM tracing variable to false. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ```Dockerfile | ||||||
| DD_IAST_ENABLED=true | ||||||
| DD_APM_TRACING_ENABLED=false | ||||||
| DD_SERVICE=<YOUR_SERVICE_NAME> | ||||||
| DD_ENV=<YOUR_ENVIRONMENT> | ||||||
| ``` | ||||||
|
|
||||||
| [1]: https://github.com/DataDog/dd-trace-js/blob/master/MIGRATING.md | ||||||
| [2]: /security/code_security/iast/setup/nodejs/ | ||||||
| [3]: /security/code_security/iast/setup/ | ||||||
|
|
@@ -357,6 +407,17 @@ | |||||
| ] | ||||||
| ``` | ||||||
|
|
||||||
| #### APM Tracing disabled | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| To disable APM tracing while keeping IAST enabled, you must set the APM tracing variable to false. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ```Dockerfile | ||||||
| DD_IAST_ENABLED=true | ||||||
| DD_APM_TRACING_ENABLED=false | ||||||
| DD_SERVICE=<YOUR_SERVICE_NAME> | ||||||
| DD_ENV=<YOUR_ENVIRONMENT> | ||||||
| ``` | ||||||
|
|
||||||
| #### Third-Party Library Compatibility Note | ||||||
|
|
||||||
| Runtime Code Analysis (IAST) modifies Python code at runtime. This could cause conflicts with other third-party Python libraries that perform similar code transformations, particularly with the following, though not limited to them: | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.