Add Operator Path to APM Single Step Instrumentation#22007
Add Operator Path to APM Single Step Instrumentation#22007brett0000FF merged 13 commits intomasterfrom
Conversation
Preview links (active after the
|
content/en/tracing/trace_collection/automatic_instrumentation/single-step-apm.md
Outdated
Show resolved
Hide resolved
content/en/tracing/trace_collection/automatic_instrumentation/single-step-apm.md
Outdated
Show resolved
Hide resolved
github-actions
bot
removed
the
Architecture
| ``` | ||
| 2. Create `datadog-agent.yaml` with the spec of your Datadog Agent deployment configuration. The simplest configuration is as follows: | ||
| ```yaml | ||
| kind: DatadogAgent |
| apiSecret: | ||
| secretName: datadog-secret | ||
| keyName: api-key | ||
| appSecret: |
| {{< collapse-content title="Installing with Datadog Operator" level="h4" >}} | ||
|
|
||
| ### Installation | ||
| To enable single step instrumentation with the Datadog Operator: |
There was a problem hiding this comment.
Let's add more context here. Following the steps below will add support of SSI in the whole cluster: we will be emitting traces for every app written in one of SSI-supported languages in the cluster.
There was a problem hiding this comment.
Also, not sure where is the best place to add, but worth mentioning that SSI is supported by Operator 1.5.0+.
There was a problem hiding this comment.
Sounds good. I'm adding that extra context to each section, and I'm adding the Operator version to step 1.
| </ul> | ||
| </div> | ||
|
|
||
| 3. Run the following command: |
There was a problem hiding this comment.
After applying datadog-agent.yaml, we should allow few minutes for Datadog Cluster Agent to complete its leader election process. Only after that restarting apps will result in instrumentation.
| datadog: | ||
| apiKeyExistingSecret: datadog-secret | ||
| site: <DATADOG_SITE> | ||
| You can choose to enable or disable instrumentation for applications in specific namespaces. The file you need to configure depends on if you enabled Single Step Instrumentation with Datadog Operator or Helm: |
There was a problem hiding this comment.
Let's add the following information:
- enabledNamespaces and disabledNamespaces cannot be set at the same time. This will result in SSI configuration not being applied at all.
- By default,
kube-systemnamespace and the namespace where Datadog resources are running are not instrumented.
There was a problem hiding this comment.
For point 2, I think this is essentially covered by the note we have at the beginning of the installation section:
<div class="alert alert-info">Single Step Instrumentation doesn't instrument applications in the namespace where you install the Datadog Agent. It's recommended to install the Agent in a separate namespace in your cluster where you don't run your applications.</div>
What do you think?
content/en/tracing/trace_collection/automatic_instrumentation/single-step-apm.md
Outdated
Show resolved
Hide resolved
|
Few nits:
The links don't lead anywhere.
I'm not sure Choosing specific pod specifications needs to be part of this instruction. It's an alternate way to SSI of instrumentation, not the part of it. |
4 participants
What does this PR do? What is the motivation?
Preview: https://docs-staging.datadoghq.com/brett0000FF/ssi-k8operator/tracing/trace_collection/automatic_instrumentation/single-step-apm/?tab=kubernetes
TODO
Merge instructions
Additional notes