Skip to content

[APM] Add 'deactivate_...' agent configuration settings for EDOT Node.js#224502

Merged
trentm merged 2 commits intoelastic:mainfrom
trentm:trentm-edot-nodejs-central-config-vars
Jun 20, 2025
Merged

[APM] Add 'deactivate_...' agent configuration settings for EDOT Node.js#224502
trentm merged 2 commits intoelastic:mainfrom
trentm:trentm-edot-nodejs-central-config-vars

Conversation

@trentm
Copy link
Member

@trentm trentm commented Jun 18, 2025

Summary

This makes the existing 'deactivate_all_instrumentations' and 'deactivate_instrumentations' agent configuration settings
available to EDOT Node.js agents (agent.name: opentelemetry/nodejs/elastic). (This follows on the recent #222883 that did the same for another config setting.)

This makes use of the newly added https://ela.st/edot-node-disable-instrs short URL that points to the current relevant anchor in the EDOT Node.js docs.

Screenshot of Agent Configuration section in Kibana showing to two newly available settings for an EDOT Node.js SDK configuration:

Screenshot 2025-06-18 at 3 29 34 PM

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

@trentm trentm self-assigned this Jun 18, 2025
@trentm trentm force-pushed the trentm-edot-nodejs-central-config-vars branch from 5a77bce to 3b11cd3 Compare June 18, 2025 22:35
'Comma-separated list of instrumentation names to disable. When an instrumentation is disabled, no telemetry will be collected for the library/module it instruments. ' +
'The list of supported instrumentation names is language specific:\n' +
'- [EDOT Java](https://ela.st/otel-agent-instructions): for example "akka-http,grpc"\n' +
'- [EDOT Node.js](https://ela.st/edot-node-disable-instrs): for example "net,dns,http"',
Copy link
Member Author

Choose a reason for hiding this comment

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

@jackshirazi Are you okay with the re-wording here?

@intuibase @SergeyKleyman In the APM agents meeting yesterday, my understanding was that EDOT PHP was going to want deactivate_instrumentations and deactivate_all_instrumentations settings. Shall I add PHP to this PR as well?

If so, can you provide an appropriate link listing supported instrumentation names? For:

- [EDOT PHP](https://ela.st/???): for example "???"

@trentm trentm marked this pull request as ready for review June 18, 2025 22:41
@trentm trentm requested a review from a team June 18, 2025 22:41
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

@trentm trentm added the backport:version Backport to applied version labels label Jun 18, 2025
Copy link
Contributor

@cauemarcondes cauemarcondes left a comment

Choose a reason for hiding this comment

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

LGTM

@trentm trentm merged commit 228db1a into elastic:main Jun 20, 2025
11 checks passed
@trentm trentm deleted the trentm-edot-nodejs-central-config-vars branch June 20, 2025 16:20
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jun 24, 2025
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 224502 locally
cc: @trentm

akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request Jun 25, 2025
….js (elastic#224502)

This makes the existing 'deactivate_all_instrumentations' and
'deactivate_instrumentations' agent configuration settings
available to EDOT Node.js agents (`agent.name:
opentelemetry/nodejs/elastic`).
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 224502 locally
cc: @trentm

@trentm trentm removed backport missing Added to PRs automatically when the are determined to be missing a backport. backport:version Backport to applied version labels labels Jun 25, 2025
@kibanamachine kibanamachine added backport:skip This PR does not require backporting labels Jun 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting release_note:enhancement Team:obs-ux-infra_services - DEPRECATED DEPRECATED - Use Team:obs-presentation. v9.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants