Skip to content

docs: updates dd & otel docs for plugin filtering - #4204

Merged
Pratham-Mishra04 merged 1 commit into
devfrom
06-09-docs_updates_dd_otel_docs_for_plugin_filtering
Jun 9, 2026
Merged

docs: updates dd & otel docs for plugin filtering#4204
Pratham-Mishra04 merged 1 commit into
devfrom
06-09-docs_updates_dd_otel_docs_for_plugin_filtering

Conversation

@roroghost17

@roroghost17 roroghost17 commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the plugin_span_filter configuration option for the Datadog connector, and corrects the UI navigation path for the OTEL connector's plugin span filtering instructions.

Changes

  • Added a new Plugin Span Filtering section to the Datadog connector docs, covering exclude/include filter modes, config.json usage, UI configuration, built-in plugin names, child span re-parenting behavior, and a note on per-connector filter independence and config versioning precedence.
  • Updated the OTEL connector docs to correct the UI navigation path from the generic "Plugins page" to the specific Observability page → Open Telemetry connector flow, matching the Datadog connector's updated instructions.

Type of change

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Chore/CI

Affected areas

  • Core (Go)
  • Transports (HTTP)
  • Providers/Integrations
  • Plugins
  • UI (React)
  • Docs

How to test

Review the rendered documentation for:

  • The new Plugin Span Filtering section appearing correctly in the Datadog connector page, including the config.json example, filter mode table, built-in plugin name list, and the <Note> callout.
  • The OTEL connector page showing the corrected UI navigation path ("Open the Observability page, select the Open Telemetry connector...").

Breaking changes

  • Yes
  • No

Related issues

Security considerations

None.

Checklist

  • I read docs/contributing/README.md and followed the guidelines
  • I added/updated tests where appropriate
  • I updated documentation where needed
  • I verified builds succeed (Go and UI)
  • I verified the CI pipeline passes locally if applicable

Summary by CodeRabbit

  • Documentation
    • Added a Plugin Span Filtering guide for Datadog APM explaining how to include/exclude plugin execution spans, supported filter modes (include/exclude), built-in plugin names, example configuration, and how filtering re-parents child spans in traces.
    • Clarified OpenTelemetry connector docs to use the Observability page for plugin tracing and that connector config can override UI-saved filters by version.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@Pratham-Mishra04, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 45 minutes and 28 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 40dd887e-32af-4541-8cce-b9f4fdf8c095

📥 Commits

Reviewing files that changed from the base of the PR and between 9ddc059 and c9a3a10.

📒 Files selected for processing (2)
  • docs/enterprise/datadog-connector.mdx
  • docs/features/observability/otel.mdx
📝 Walkthrough

Walkthrough

Adds a new "Plugin Span Filtering" section to the Datadog connector docs and updates OTEL docs to point UI configuration to Observability → Open Telemetry connector; both document the plugin_span_filter config.json and UI behavior including filter modes and version-based override precedence.

Changes

Plugin Span Filtering Documentation

Layer / File(s) Summary
Datadog plugin span filtering comprehensive guide
docs/enterprise/datadog-connector.mdx
New "Plugin Span Filtering" section explains plugin_span_filter configuration via config.json and the UI, available filter modes (exclude/include), built-in plugin names list, trace re-parenting when spans are filtered, and connector-scoped precedence using connector version to override UI-saved settings.
OTEL documentation navigation update
docs/features/observability/otel.mdx
Updates UI navigation path for plugin tracing configuration to Observability → Open Telemetry connector → Configure Plugin Tracing (replacing Plugins page), while preserving toggle/save persistence and the plugin_span_filter version override precedence rule.

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • akshaydeo
  • danpiths

"🐰 I hopped through docs with a curious nose,
Added filters where the plugin-span goes.
Datadog learns which spans to keep or shed,
OTEL points the way—now rest your head.
A little hop, a clearer trace, off to bed! ✨"

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: documentation updates to Datadog and OTEL connector docs for plugin filtering.
Description check ✅ Passed The description comprehensively covers the changes, type of change, affected areas, and testing instructions, following the template structure with only non-critical sections appropriately left unchecked.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 06-09-docs_updates_dd_otel_docs_for_plugin_filtering

Comment @coderabbitai help to get the list of available commands and usage tips.

@CLAassistant

CLAassistant commented Jun 9, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

roroghost17 commented Jun 9, 2026

Copy link
Copy Markdown
Contributor Author

@roroghost17
roroghost17 marked this pull request as ready for review June 9, 2026 11:03
@greptile-apps

greptile-apps Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Confidence Score: 5/5

Documentation-only change with no runtime impact; all documented fields and values are accurate against the config schema and codebase.

Both files touch only Mintlify documentation. The new plugin_span_filter example, filter modes, built-in plugin names, and version field placement were all cross-checked against transports/config.schema.json and the plugins directory — everything matches. The OTEL path correction is a straightforward factual fix.

No files require special attention.

Important Files Changed

Filename Overview
docs/enterprise/datadog-connector.mdx Adds a Plugin Span Filtering section; config fields, filter modes, built-in plugin names, and version precedence all match the schema and codebase.
docs/features/observability/otel.mdx Corrects the UI navigation path from the generic "Plugins page" to the specific "Observability → Open Telemetry" flow; change is accurate and consistent with the Datadog connector docs.

Reviews (4): Last reviewed commit: "docs: updates dd & otel docs for plugin ..." | Re-trigger Greptile

Comment thread docs/enterprise/datadog-connector.mdx
@roroghost17
roroghost17 force-pushed the 06-09-feat_adds_plugin_span_filters_to_config_json_and_helm_charts branch from 45d25de to 1931de3 Compare June 9, 2026 11:25
@roroghost17
roroghost17 force-pushed the 06-09-docs_updates_dd_otel_docs_for_plugin_filtering branch 2 times, most recently from 0afd0f5 to 9ddc059 Compare June 9, 2026 12:21
@roroghost17
roroghost17 force-pushed the 06-09-feat_adds_plugin_span_filters_to_config_json_and_helm_charts branch from 1931de3 to 7350823 Compare June 9, 2026 12:21

Pratham-Mishra04 commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Merge activity

  • Jun 9, 12:40 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jun 9, 12:46 PM UTC: Graphite rebased this pull request as part of a merge.
  • Jun 9, 12:47 PM UTC: @Pratham-Mishra04 merged this pull request with Graphite.

@Pratham-Mishra04
Pratham-Mishra04 changed the base branch from 06-09-feat_adds_plugin_span_filters_to_config_json_and_helm_charts to graphite-base/4204 June 9, 2026 12:42
@Pratham-Mishra04
Pratham-Mishra04 changed the base branch from graphite-base/4204 to dev June 9, 2026 12:44
@Pratham-Mishra04
Pratham-Mishra04 requested a review from a team as a code owner June 9, 2026 12:44
@Pratham-Mishra04
Pratham-Mishra04 force-pushed the 06-09-docs_updates_dd_otel_docs_for_plugin_filtering branch from 9ddc059 to c9a3a10 Compare June 9, 2026 12:46
@Pratham-Mishra04
Pratham-Mishra04 merged commit 35bc0f7 into dev Jun 9, 2026
16 of 17 checks passed
@Pratham-Mishra04
Pratham-Mishra04 deleted the 06-09-docs_updates_dd_otel_docs_for_plugin_filtering branch June 9, 2026 12:47
akshaydeo pushed a commit that referenced this pull request Jun 12, 2026
## Summary

Documents the `plugin_span_filter` configuration option for the Datadog connector, and corrects the UI navigation path for the OTEL connector's plugin span filtering instructions.

## Changes

- Added a new **Plugin Span Filtering** section to the Datadog connector docs, covering `exclude`/`include` filter modes, config.json usage, UI configuration, built-in plugin names, child span re-parenting behavior, and a note on per-connector filter independence and config versioning precedence.
- Updated the OTEL connector docs to correct the UI navigation path from the generic "Plugins page" to the specific **Observability** page → **Open Telemetry** connector flow, matching the Datadog connector's updated instructions.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Review the rendered documentation for:
- The new **Plugin Span Filtering** section appearing correctly in the Datadog connector page, including the config.json example, filter mode table, built-in plugin name list, and the `<Note>` callout.
- The OTEL connector page showing the corrected UI navigation path ("Open the **Observability** page, select the **Open Telemetry** connector...").

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->
## Summary by CodeRabbit

* **Documentation**
  * Added a Plugin Span Filtering guide for Datadog APM explaining how to include/exclude plugin execution spans, supported filter modes (include/exclude), built-in plugin names, example configuration, and how filtering re-parents child spans in traces.
  * Clarified OpenTelemetry connector docs to use the Observability page for plugin tracing and that connector config can override UI-saved filters by version.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants