Skip to content

[CONTP-1760] Document configuring Autodiscovery with the DatadogInstrumentation CRD - #37532

Merged
Mathew-Estafanous merged 20 commits into
masterfrom
mathew.estafanous/docs-datadoginstrumentation-crd-autodiscovery
Aug 7, 2026
Merged

[CONTP-1760] Document configuring Autodiscovery with the DatadogInstrumentation CRD#37532
Mathew-Estafanous merged 20 commits into
masterfrom
mathew.estafanous/docs-datadoginstrumentation-crd-autodiscovery

Conversation

@Mathew-Estafanous

@Mathew-Estafanous Mathew-Estafanous commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Datadog now lets users configure Autodiscovery for Kubernetes workloads through the DatadogInstrumentation custom resource, instead of pod annotations. This PR documents that capability.

Pod annotations require editing workload specs, are error-prone (raw JSON), and can't be centrally managed or rolled back without touching the workload. The custom resource gives users a structured, validated, version-controllable way to configure checks per workload — and it's a familiar model for teams coming from the Prometheus Operator's PodMonitor/ServiceMonitor.

Annotations remain the default path for most users. These docs surface the CRD as an alternative wherever annotation-based configuration already appears, so users discover it when it's relevant without disrupting the existing flow.

What's included:

  • A new guide covering setup, the resource schema, precedence rules, and verification.
  • Brief, consistent pointers from the existing Autodiscovery pages (Kubernetes integrations, logs, Prometheus/OpenMetrics, endpoint checks, JMX, and auto-configuration) and the Getting Started guide.

Epic context: CONTP-1453
Platform RFC: https://datadoghq.atlassian.net/wiki/x/J8FIhwE
Autodiscovery RFC: https://datadoghq.atlassian.net/wiki/x/mgAsiAE

Merge instructions

Merge readiness:

  • Ready for merge
  • Wait for 7.82 agent release

@github-actions github-actions Bot added the Guide Content impacting a guide label Jun 15, 2026
@github-actions

github-actions Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

@Mathew-Estafanous Mathew-Estafanous self-assigned this Jun 16, 2026
@Mathew-Estafanous Mathew-Estafanous changed the title Document configuring Autodiscovery with the DatadogInstrumentation CRD [CONTP-1760] Document configuring Autodiscovery with the DatadogInstrumentation CRD Jun 16, 2026
@Mathew-Estafanous
Mathew-Estafanous requested a review from a team June 16, 2026 22:01
@Mathew-Estafanous
Mathew-Estafanous marked this pull request as ready for review June 17, 2026 15:43
@Mathew-Estafanous
Mathew-Estafanous requested a review from a team as a code owner June 17, 2026 15:43
@buraizu buraizu self-assigned this Jun 17, 2026
@buraizu

buraizu commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Thanks for the PR! I've created DOCS-14878 for documentation team review

@buraizu buraizu added the editorial review Waiting on a more in-depth review label Jun 17, 2026
@buraizu buraizu removed their assignment Jun 17, 2026
Comment thread content/en/containers/kubernetes/log.md Outdated
@Mathew-Estafanous
Mathew-Estafanous requested a review from cswatt June 24, 2026 21:29
@datadog-datadog-prod-us1

This comment has been minimized.

@Mathew-Estafanous
Mathew-Estafanous force-pushed the mathew.estafanous/docs-datadoginstrumentation-crd-autodiscovery branch 2 times, most recently from 4820848 to 07cd13f Compare August 3, 2026 19:24
@Mathew-Estafanous
Mathew-Estafanous force-pushed the mathew.estafanous/docs-datadoginstrumentation-crd-autodiscovery branch from 3c7d488 to 85b7b33 Compare August 5, 2026 17:51
@linear-code

linear-code Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

CONTP-105

@gabedos gabedos left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved with small comments

Comment thread hugo/content/en/containers/kubernetes/log.md
Comment thread hugo/content/en/containers/kubernetes/prometheus.md
@Mathew-Estafanous
Mathew-Estafanous force-pushed the mathew.estafanous/docs-datadoginstrumentation-crd-autodiscovery branch from 38899ab to 40bbbd2 Compare August 6, 2026 13:05
@github-actions github-actions Bot removed the Guide Content impacting a guide label Aug 6, 2026
@jhgilbert jhgilbert added the astro-reorg-no-conflicts Needs manual conflict resolution after replatforming reorg label Aug 6, 2026
@Mathew-Estafanous
Mathew-Estafanous force-pushed the mathew.estafanous/docs-datadoginstrumentation-crd-autodiscovery branch from 40bbbd2 to 0315ee5 Compare August 6, 2026 19:05
Mathew-Estafanous and others added 4 commits August 6, 2026 20:06
Add a new guide describing how to configure Autodiscovery checks for
Kubernetes workloads through the DatadogInstrumentation custom resource
(beta) instead of pod annotations, and cross-reference it from the
existing Autodiscovery pages.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Mathew-Estafanous and others added 16 commits August 6, 2026 20:06
- Use present tense for precedence and validation behavior
- Add "Verify scheduled checks" section with an agent configcheck example
- Remove the redundant status section
- Point Prometheus Operator users to the DDI CRD as the PodMonitor/ServiceMonitor equivalent
- Fix a trailing space in the Prometheus DDI example

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Show the OpenMetrics check as a DatadogInstrumentation resource alongside
the annotation examples, note the 7.81+ requirement, and call out removing
the annotation from the example manifest so the resource takes effect.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@Mathew-Estafanous
Mathew-Estafanous force-pushed the mathew.estafanous/docs-datadoginstrumentation-crd-autodiscovery branch from 0315ee5 to 4eb4555 Compare August 7, 2026 00:08
@github-actions github-actions Bot added the Guide Content impacting a guide label Aug 7, 2026
@Mathew-Estafanous
Mathew-Estafanous merged commit 1b7e04c into master Aug 7, 2026
14 of 17 checks passed
@Mathew-Estafanous
Mathew-Estafanous deleted the mathew.estafanous/docs-datadoginstrumentation-crd-autodiscovery branch August 7, 2026 00:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

astro-reorg-no-conflicts Needs manual conflict resolution after replatforming reorg editorial review Waiting on a more in-depth review Guide Content impacting a guide

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants