SSI Troubleshooting Updates #30840
SSI Troubleshooting Updates #30840
Conversation
📝 Documentation Team Review RequiredThis pull request requires approval from the @DataDog/documentation team before it can be merged. Please ensure your changes follow our documentation guidelines and wait for a team member to review and approve your changes. |
Preview links (active after the
|
|
Do not merge until we get approval from me and @betterengineering |
| <li>Environments: Linux hosts, containers, Kubernetes</li> | ||
| <li>Datadog Agent v7.68.2+</li> | ||
| </ul> | ||
| <p>To enable it, contact support or turn on the <code>apm-ssi-troubleshooting</code> feature flag.<p> |
There was a problem hiding this comment.
this is public/customer facing right? I don't think users have the ability to do this.
There was a problem hiding this comment.
@avivenzio-dd Should I just say "To enable it, contact support." ??
|
|
||
| Start with the UI to spot issues across multiple hosts or services before investigating logs or containers directly. | ||
|
|
||
| To access instrumentation insights in Datadog: |
There was a problem hiding this comment.
Is instrumentation insights how we are branding this feature?
...ent/en/tracing/trace_collection/automatic_instrumentation/single-step-apm/troubleshooting.md
Outdated
Show resolved
Hide resolved
| |-------|--------|--------|------------------| | ||
| | Other Agent already attached | Injection failed | Another tracer is already loaded in the process | Remove existing tracer and restart the process, or disable SSI for this service. | | ||
| | Unsupported runtime version | Injection failed | For example, Node.js 16.14.2 detected (minimum: 18.x) | Upgrade to a supported runtime version. | | ||
| | Permission denied | Injection failed | Insufficient privileges to inject into process | Ensure the Agent has sufficient permissions. Check container security policies and capabilities. | |
There was a problem hiding this comment.
for permissions can we show the required permissions? or link to a page that has them?
...ent/en/tracing/trace_collection/automatic_instrumentation/single-step-apm/troubleshooting.md
Outdated
Show resolved
Hide resolved
| - `single_step_instrumentation` shows which hosts have SSI enabled or disabled. | ||
| - `instrumentation_status` shows which hosts have encountered issues with service instrumentation. |
There was a problem hiding this comment.
Being that we are explaining the UI, we should use the labels used in the UI rather than the request parameter names.
There was a problem hiding this comment.
Technically users can write the facet queries into the query box, so this is helpful info. I agree though that maybe we should also include where to find the matching facets on the facet column in the UI.
|
|
||
| If a service is not instrumented and no failure reason is listed, check whether the process exited quickly or used a language that isn't yet supported. | ||
|
|
||
| ### Manually verify injection in the application container |
There was a problem hiding this comment.
Why would a customer need to do this manual verification if they have the troubleshooting data in the UI?
There was a problem hiding this comment.
@sarjyusuf Can you weigh in on how to frame this content? Do we want it at all? This is what was pulled in from that Troubleshooting Confluence page. Perhaps this section if redundant or obsolete with the new UI-based capabilities?
...ent/en/tracing/trace_collection/automatic_instrumentation/single-step-apm/troubleshooting.md
Show resolved
Hide resolved
...ent/en/tracing/trace_collection/automatic_instrumentation/single-step-apm/troubleshooting.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Tahir H. Butt <[email protected]>
What does this PR do? What is the motivation?
https://datadoghq.atlassian.net/browse/DOCS-11673
Updates the SSI Troubleshooting guide:
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