Update SSI injector guide with process selection details #32340
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add comprehensive overview of what processes SSI instruments and excludes - Document location, language, process type, and context-based selection criteria - List specific examples of excluded processes (build tools, CLIs, IDEs, system utilities) - Add language-specific instrumentation behavior for Java, .NET, Node.js, Python, Ruby - Include links to open-source requirements files for transparency - Remove marketing language and focus on technical accuracy
Preview links (active after the
|
| ### Location | ||
| Applications deployed in standard application directories are instrumented: | ||
| - `/opt/myapp`, `/app`, `/home/user/app` (instrumented) | ||
| - `/bin`, `/sbin`, `/usr/bin` (system utilities, not instrumented) |
There was a problem hiding this comment.
these have exceptions:
{
"description": "Allowed Python targets from system directories",
"values": [
{
"cmp_strategy": "equals",
"value": "/usr/bin/gunicorn",
"value_type": "entry_file"
},
{
"cmp_strategy": "equals",
"value": "/usr/bin/flask",
"value_type": "entry_file"
},
{
"cmp_strategy": "equals",
"value": "/usr/bin/uvicorn",
"value_type": "entry_file"
},
{
"cmp_strategy": "equals",
"value": "/usr/bin/django-admin",
"value_type": "entry_file"
},
{
"cmp_strategy": "equals",
"value": "/usr/bin/celery",
"value_type": "entry_file"
},
{
"cmp_strategy": "equals",
"value": "/usr/bin/scrapy",
"value_type": "entry_file"
}
]
}
Comment on lines
+65
to
+68
| - `java -jar myapp.jar` (application, instrumented) | ||
| - `java -version` (version check, not instrumented) | ||
| - `npm start` (starts application, instrumented) | ||
| - `npm install` (installs dependencies, not instrumented) |
There was a problem hiding this comment.
just to clarify, right now (although work is being done to change that) we do inject but it's the SDK's responsibility to bail (or not)
and like I said, in the future we will also bail (and not inject) if we detected certain command line arguments liek 'help', 'version', etc.
Comment on lines
+94
to
+96
| - Text processing: `grep`, `sed`, `awk` | ||
| - File operations: `cp`, `mv`, `tar`, `zip` | ||
| - System monitoring: `ps`, `top`, `htop` |
There was a problem hiding this comment.
we don't inject these anyway they are native applications
Comment on lines
+74
to
+84
| - **Compilers:** `javac`, `gcc`, `dotnet build` | ||
| - **Package managers:** `npm`, `pip`, `gem`, `maven`, `gradle` | ||
| - **Build tools:** `make`, `cmake`, `webpack` | ||
| - **Project scaffolding:** `dotnet new`, `rails new`, `create-react-app` | ||
|
|
||
| ### Database and infrastructure management tools | ||
| - **Database CLIs:** `psql`, `mysql`, `mongo`, `redis-cli` | ||
| - **Kafka tools:** `kafka-topics.sh`, `kafka-console-consumer.sh` | ||
| - **Elasticsearch tools:** `elasticsearch-plugin`, `elasticsearch-keystore` | ||
| - **Cassandra tools:** `nodetool`, `cqlsh` | ||
| - **Cloud CLIs:** `aws`, `gcloud`, `kubectl` |
There was a problem hiding this comment.
https://github.com/DataDog/auto_inject/blob/main/preload_go/deny_patterns.go
☝️ even this is not a comprehensive list
iadjivon
reviewed
Oct 23, 2025
| - Modifies environment variables or command-line arguments to load the appropriate tracer SDK. | ||
| - Emits telemetry to report status and aid in debugging. | ||
| - Includes fallback logic to allow the application to continue running uninstrumented if injection fails. | ||
| Single Step Instrumentation instruments the following types of applications: |
There was a problem hiding this comment.
Suggested change
| Single Step Instrumentation instruments the following types of applications: | |
| Single Step Instrumentation supports the following types of applications: |
Just a small nitpick here to remove the duplication of the word "instrument"
iadjivon
reviewed
Oct 23, 2025
Comment on lines
+44
to
+48
| - **Web services** - API servers, web applications, microservices | ||
| - **Application servers** - Tomcat, Jetty, JBoss, WebLogic, Kestrel | ||
| - **Background workers** - Celery, Sidekiq, job processors | ||
| - **Custom applications** - Business logic and services | ||
|
|
There was a problem hiding this comment.
Suggested change
| - **Web services** - API servers, web applications, microservices | |
| - **Application servers** - Tomcat, Jetty, JBoss, WebLogic, Kestrel | |
| - **Background workers** - Celery, Sidekiq, job processors | |
| - **Custom applications** - Business logic and services | |
| - **Web services**: API servers, web applications, microservices | |
| - **Application servers**: Tomcat, Jetty, JBoss, WebLogic, Kestrel | |
| - **Background workers**: Celery, Sidekiq, job processors | |
| - **Custom applications**: Business logic and services |
Editing this to match out style guide.
iadjivon
reviewed
Oct 23, 2025
| - **Background workers** - Celery, Sidekiq, job processors | ||
| - **Custom applications** - Business logic and services | ||
|
|
||
| SSI uses multiple signals to determine if a process should be instrumented: |
There was a problem hiding this comment.
Suggested change
| SSI uses multiple signals to determine if a process should be instrumented: | |
| SSI uses multiple signals such as location, language, process type, and context, to determine if a process should be instrumented. |
Adding these here to set the stage for the upcoming headers so the reader knows which signals are to come up next.
iadjivon
reviewed
Oct 23, 2025
Comment on lines
+74
to
+78
| - **Compilers:** `javac`, `gcc`, `dotnet build` | ||
| - **Package managers:** `npm`, `pip`, `gem`, `maven`, `gradle` | ||
| - **Build tools:** `make`, `cmake`, `webpack` | ||
| - **Project scaffolding:** `dotnet new`, `rails new`, `create-react-app` | ||
|
|
There was a problem hiding this comment.
Suggested change
| - **Compilers:** `javac`, `gcc`, `dotnet build` | |
| - **Package managers:** `npm`, `pip`, `gem`, `maven`, `gradle` | |
| - **Build tools:** `make`, `cmake`, `webpack` | |
| - **Project scaffolding:** `dotnet new`, `rails new`, `create-react-app` | |
| - Compilers: `javac`, `gcc`, `dotnet build` | |
| - Package managers: `npm`, `pip`, `gem`, `maven`, `gradle` | |
| - Build tools: `make`, `cmake`, `webpack` | |
| - Project scaffolding: `dotnet new`, `rails new`, `create-react-app` |
I don't think these need to be bolded since the values are in quotes .
iadjivon
reviewed
Oct 23, 2025
Comment on lines
+80
to
+84
| - **Database CLIs:** `psql`, `mysql`, `mongo`, `redis-cli` | ||
| - **Kafka tools:** `kafka-topics.sh`, `kafka-console-consumer.sh` | ||
| - **Elasticsearch tools:** `elasticsearch-plugin`, `elasticsearch-keystore` | ||
| - **Cassandra tools:** `nodetool`, `cqlsh` | ||
| - **Cloud CLIs:** `aws`, `gcloud`, `kubectl` |
There was a problem hiding this comment.
Suggested change
| - **Database CLIs:** `psql`, `mysql`, `mongo`, `redis-cli` | |
| - **Kafka tools:** `kafka-topics.sh`, `kafka-console-consumer.sh` | |
| - **Elasticsearch tools:** `elasticsearch-plugin`, `elasticsearch-keystore` | |
| - **Cassandra tools:** `nodetool`, `cqlsh` | |
| - **Cloud CLIs:** `aws`, `gcloud`, `kubectl` | |
| - Database CLIs: `psql`, `mysql`, `mongo`, `redis-cli` | |
| - Kafka tools: `kafka-topics.sh`, `kafka-console-consumer.sh` | |
| - Elasticsearch tools: `elasticsearch-plugin`, `elasticsearch-keystore` | |
| - Cassandra tools: `nodetool`, `cqlsh` | |
| - Cloud CLIs: `aws`, `gcloud`, `kubectl` |
iadjivon
reviewed
Oct 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes