[operator/nodejs] document disabling node auto-instrumentations

[JamieDanielson]

Summary

OTel JS auto-instrumentations-node v0.48.0 now includes the ability to disable instrumentations using environment variables.

Changes

• Add section to operator docs for disabling instrumentations
• Add headers and section to zero-code js configuration page for disabling instrumentations

I'm not sure if this is too redundant in this text, as it's mostly a copy-paste. Open to suggestions!

[JamieDanielson]

Wait don't merge this I have a typo on a link

[JamieDanielson]

Wait don't merge this I have a typo on a link

Fixed!

Side note: I noticed in a separate issue that there is external link checking but it is currently excluding GitHub URLs, which is how this one got missed. Noting for anyone curious (I was 😄 )

[tiffany76]

Thanks for fixing those links! I noticed the broken http link as well. (@chalin not sure if this needs attention or if we're happy to continue ignoring GH links.)

LGTM!

[chalin]

LGTM. See inline suggestion.

Also, what happens if both OTEL_NODE_ENABLED_INSTRUMENTATIONS and OTEL_NODE_DISABLED_INSTRUMENTATIONS are provided? Should there be a note explaining this?

[chalin]

Thanks for fixing those links! I noticed the broken http link as well. (@chalin not sure if this needs attention or if we're happy to continue ignoring GH links.)

Yes, thanks for fixing the link. I don't have the time to enable the link checking for GH links atm. If it becomes problematic (i.e., we feel that we've been manually detecting too many broken links into GH repos), then we can bump the priority on enabling such link checks.

[JamieDanielson]

Also, what happens if both OTEL_NODE_ENABLED_INSTRUMENTATIONS and OTEL_NODE_DISABLED_INSTRUMENTATIONS are provided? Should there be a note explaining this?

All instrumentations are disabled because they are mutually exclusive. I can add that note. I've opened a PR on js-contrib to illustrate this behavior and if there is feedback to change behavior or update the debug message I can come back and open a new PR for that.

[tiffany76]

We try to avoid future tense if possible, so there's no question of when the thing happens. Otherwise, LGTM! Thanks.

[JamieDanielson]

Also, what happens if both OTEL_NODE_ENABLED_INSTRUMENTATIONS and OTEL_NODE_DISABLED_INSTRUMENTATIONS are provided? Should there be a note explaining this?

All instrumentations are disabled because they are mutually exclusive. I can add that note. I've opened a PR on js-contrib to illustrate this behavior and if there is feedback to change behavior or update the debug message I can come back and open a new PR for that.

@chalin I added the note for behavior of both env vars being set, thanks for calling it out!

[svrnm]

Assuming that @trentm's comments are blocking I put this in to not accidentally merge it

[chalin]

LGTM, and I'm glad for this to get merged as is for now, but:

• We might prefer the use of an {{% alert %}} short code instead of blockquote markdown
• @svrnm - do we want to pull out that note into a shortcode given that it's used verbatim in two place. This would avoid drift.

[chalin]

Will let @svrnm have the final call here before this get's merged.

[trentm]

It does seem like there is some precedent in the content to use > ... blockquote markdown syntax for side-notes / call-outs.

[svrnm]

do we want to pull out that note into a shortcode given that it's used verbatim in two place. This would avoid drift.

Agreed, but let's leave it like that to get this PR merged and we can fix this eventually.

It does seem like there is some precedent in the content to use > ... blockquote markdown syntax for side-notes / call-outs.

Yes, but we try to replace them whenever we handle an existing file, eventually we want to use the shortcode everywhere since it gives us more flexibility in styling & structuring those call outs.

I will fix the notice and merge this PR

[svrnm]

/fix:all

[opentelemetrybot]

You triggered fix:all action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10073657559

[svrnm]

thank you all!

[JamieDanielson]

Yes, but we try to replace them whenever we handle an existing file, eventually we want to use the shortcode everywhere since it gives us more flexibility in styling & structuring those call outs.

Ah, good to know. I had that and removed it since it seemed like it was no longer a note that needed major attention. I thought it might be a "downgraded" note 😅