docs(operator): copy sampler and propagation config from operator README by gayathri12devi · Pull Request #9684 · open-telemetry/opentelemetry.io

gayathri12devi · 2026-04-19T03:55:29Z

This PR copied the configuration docs from the operator README into the automatic.md page as requested by the maintainers in the issue.

This commit copies the following sections into automatic.md :

Deployment modes and sidecar injection
Upgrade Strategy
Multi-container pod instrumentation
Customized/vendor instrumentation
Apache HTTPD and Nginx auto-instrumentation
Target Allocator
Controlling instrumentation capabilities
Resource attributes configuration

I have read and followed the Contributing docs, especially the "First-time contributing?" section.
This PR has content that I did not fully write myself.
- I used AI and I have read and followed the Generative AI Contribution Policy.
I have the experience and knowledge necessary to understand, review, and validate all content in this PR.¹

Yes, I can answer maintainer questions about the content of this PR, without using AI. ↩

linux-foundation-easycla · 2026-04-19T03:55:35Z

The committers listed above are authorized under a signed CLA.

✅ login: gayathri12devi / name: gayathri12devi (edd9559)
✅ login: gayathri12devi / name: Moha Gayathri (5b6d1d8, 84ab6a9, 91198ab, d07f86b, fe66aad)
✅ login: otelbot[bot] / name: otelbot (385246e)
✅ login: theletterf / name: Fabrizio Ferri-Benedetti (736d501)
✅ login: tiffany76 / name: Tiffany Hrabusa (edd9559)

theletterf · 2026-04-20T05:09:52Z

Thank you, @gayathri12devi.

@open-telemetry/operator-approvers Please have a look.

gayathri12devi · 2026-04-20T07:26:19Z

Thank you for the review, @theletterf!

gayathri12devi · 2026-04-21T03:01:38Z

Hi!
I am a first-time contributor. Should I run /fix:all to fix the failing checks or would you prefer to guide me through it?

pavolloffay · 2026-04-21T08:37:35Z

 The above command results in a deployment of the Collector that you can use as
 an endpoint for auto-instrumentation in your pods.

+## Deployment Modes


It would make more sense to have this in a seprate document. This page should be focused on the auto-instrumentation

pavolloffay · 2026-04-21T08:39:07Z

+instrumentation.opentelemetry.io/inject-sdk: "true"
+```
+
+## Target Allocator


This should go into the TA docs https://opentelemetry.io/docs/platforms/kubernetes/operator/target-allocator/

gayathri12devi · 2026-04-21T16:07:06Z

Thanks for the review! @pavolloffay I've removed the Deployment Modes and Target Allocator sections as suggested
I have a quick question should the "Configure resource attributes" section also be removed, or is it acceptable to keep it here?

tiffany76 · 2026-04-21T19:04:08Z

I am a first-time contributor. Should I run /fix:all to fix the failing checks or would you prefer to guide me through it?

Hi @gayathri12devi! Thanks for your contribution! We'll definitely help you out with the CI checks.

Yes, you can use GitHub actions to fix them on the PR. If you're more comfortable working locally, you can also run the fix commands on your machine and push up the changes.

I'll try a GItHub action command now to see how many of the checks we can get passing.

tiffany76 · 2026-04-21T19:04:14Z

/fix

otelbot-docs · 2026-04-21T19:14:55Z

✅ fix applied successfully in run 24741083899.

tiffany76 · 2026-04-24T21:01:50Z

Hi @gayathri12devi! We reserve this file for words that are widely used. Could you revert the changes you made to this file and instead add them to the cSpell:ignore front matter of the docs page? I'll leave a comment to show you exactly where they need to go.

Thank you @tiffany76! I wasn't aware of the cSpell:ignore front matter convention. I've committed your suggestion and reverted the changes to cspell/en-words.txt.

gayathri12devi · 2026-04-25T03:34:04Z

@tiffany76 I noticed my PR shows some extra words being added to en-words.txt like dotnet, Dyla, dynatrace etc. These were already present in my local fork before I started this PR. I didn't add them intentionally. I also noticed that chalin restructured the cSpell file 2 days ago in the main repo, and my fork still has the older version with those extra words. Should I sync my fork's en-words.txt with the latest main branch to fix this?

tiffany76 · 2026-04-25T17:17:21Z

@gayathri12devi, try rebasing off the latest main branch. That should fix the cSpell issue. 🤞

Closes open-telemetry#2341 The operator README contains configuration docs for sampler and propagation that were missing from the official docs site at https://opentelemetry.io/docs/platforms/kubernetes/operator/automatic/ Instead of linking out to the operator repo, this commit copies the following sections directly into automatic.md as requested: 1. Deployment modes and sidecar injection 2. Upgrade Strategy 3. Multi-container pod instrumentaion 4. Customized/vendor instrumentaion 5. Apache HTTPD and Nginx auto-instrumentation 6. Target Allocator 7. Controlling instrumentation capabilities 8. Resource attributes configuration

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

gayathri12devi · 2026-04-25T17:33:52Z

@tiffany76 Done! I've rebased my branch on top of the latest main.

gayathri12devi · 2026-04-26T03:01:27Z

@tiffany76 The /docs/specs/semconv/non-normative/k8s-attributes.md path doesn't seem to exist in the repo and is causing the CHECK LINKS failure. Should I revert it back to the original external GitHub URL. Also, the CSPELL word lists check is suggesting to run /fix:dict should I go ahead and do that?

tiffany76 · 2026-04-26T22:17:51Z

@gayathri12devi Yes, please run fix:dict locally and push up any changes. It will adjust the front matter formatting.

As for the link, the page exists. The problem is the .md. Change the link to /docs/specs/semconv/non-normative/k8s-attributes/ and it should work.

tiffany76

LGTM. @pavolloffay, PTAL before we merge.

otelbot · 2026-05-06T09:37:09Z

Thank you for your contribution @gayathri12devi! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

gayathri12devi requested a review from a team as a code owner April 19, 2026 03:55

github-project-automation Bot added this to SIG Comms: PRs & Issues Apr 19, 2026

otelbot-docs Bot requested a review from a team April 19, 2026 03:55

otelbot-docs Bot added missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer missing:sig-approval Co-owning SIG didn't provide an approval labels Apr 19, 2026

iblancasa approved these changes Apr 20, 2026

View reviewed changes

otelbot-docs Bot removed the missing:sig-approval Co-owning SIG didn't provide an approval label Apr 20, 2026

otelbot-docs Bot requested a review from a team April 21, 2026 03:32

pavolloffay reviewed Apr 21, 2026

View reviewed changes

otelbot-docs Bot requested a review from a team April 21, 2026 16:01

tiffany76 reviewed Apr 24, 2026

View reviewed changes

gayathri12devi and others added 6 commits April 25, 2026 17:26

fix: used descriptive link text for Target Allocator README

d07f86b

Remove Deployment Modes and Target Allocator sections

84ab6a9

Results from /fix directive

385246e

remove double slash in semconv link

fe66aad

Update content/en/docs/platforms/kubernetes/operator/automatic.md

edd9559

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

gayathri12devi force-pushed the fix/operator-auto-instrumentation-docs branch from a38b315 to edd9559 Compare April 25, 2026 17:29

corrected k8s-attributes link and used fix:dict

5b6d1d8

tiffany76 approved these changes Apr 27, 2026

View reviewed changes

swiatekm requested review from iblancasa and pavolloffay April 30, 2026 15:38

otelbot-docs Bot removed the missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer label May 6, 2026

Merge branch 'main' into fix/operator-auto-instrumentation-docs

736d501

otelbot-docs Bot added the missing:sig-approval Co-owning SIG didn't provide an approval label May 6, 2026

theletterf merged commit e6937ea into open-telemetry:main May 6, 2026
24 checks passed

github-project-automation Bot moved this to Done in SIG Comms: PRs & Issues May 6, 2026

Conversation

gayathri12devi commented Apr 19, 2026

Footnotes

Uh oh!

linux-foundation-easycla Bot commented Apr 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

theletterf commented Apr 20, 2026

Uh oh!

gayathri12devi commented Apr 20, 2026

Uh oh!

gayathri12devi commented Apr 21, 2026

Uh oh!

pavolloffay Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

pavolloffay Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

gayathri12devi commented Apr 21, 2026

Uh oh!

tiffany76 commented Apr 21, 2026

Uh oh!

tiffany76 commented Apr 21, 2026

Uh oh!

otelbot-docs Bot commented Apr 21, 2026

Uh oh!

tiffany76 Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

gayathri12devi Apr 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gayathri12devi commented Apr 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tiffany76 commented Apr 25, 2026

Uh oh!

gayathri12devi commented Apr 25, 2026

Uh oh!

gayathri12devi commented Apr 26, 2026

Uh oh!

tiffany76 commented Apr 26, 2026

Uh oh!

tiffany76 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

otelbot Bot commented May 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

linux-foundation-easycla Bot commented Apr 19, 2026 •

edited

Loading

gayathri12devi commented Apr 25, 2026 •

edited

Loading