Skip to content

[Docs] Add central config and update IncludeScopes#411

Open
stevejgordon wants to merge 9 commits into
mainfrom
docs-updates
Open

[Docs] Add central config and update IncludeScopes#411
stevejgordon wants to merge 9 commits into
mainfrom
docs-updates

Conversation

@stevejgordon
Copy link
Copy Markdown
Contributor

@stevejgordon stevejgordon commented Apr 27, 2026

As titled

Closes #404 and #405

Comment thread docs/reference/edot-dotnet/configuration.md Outdated
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 27, 2026

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 27, 2026

Vale Linting Results

Summary: 3 suggestions found

💡 Suggestions (3)
File Line Rule Message
docs/reference/edot-dotnet/configuration.md 201 Elastic.Semicolons Use semicolons judiciously.
docs/reference/edot-dotnet/configuration.md 239 Elastic.Wordiness Consider using 'because' instead of 'since'.
docs/reference/edot-dotnet/setup/edot-defaults.md 233 Elastic.Wordiness Consider using 'because' instead of 'Since'.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@stevejgordon stevejgordon marked this pull request as ready for review April 28, 2026 05:16
@stevejgordon stevejgordon requested a review from a team as a code owner April 28, 2026 05:16
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

Warning

Rate limit exceeded

@stevejgordon has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 53 minutes and 6 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, 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 have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 54bf6bf7-1fa2-4941-ac51-c63b50b10341

📥 Commits

Reviewing files that changed from the base of the PR and between 76b2505 and c9d66e3.

📒 Files selected for processing (2)
  • docs/reference/edot-dotnet/configuration.md
  • docs/reference/edot-dotnet/setup/edot-defaults.md
📝 Walkthrough

Walkthrough

This documentation update adds guidance for OpAMP central configuration in EDOT .NET. The configuration.md file introduces new OpAmpEndpoint and OpAmpHeaders options with service-name resolution behavior, clarifies HTTPS endpoint support with TLS limitations, and documents remote configuration management including which settings are remotely configurable. The edot-defaults.md file updates the IncludeScopes default from false to true and replaces historical notes with explanations about scope attribute inclusion and storage volume implications.

🚥 Pre-merge checks | ✅ 1 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Out of Scope Changes check ❓ Inconclusive The PR includes documentation updates to IncludeScopes default behavior (1.4.0), which aligns with configuration documentation updates but falls outside the explicit scope of issue #404 (central configuration). Confirm whether the IncludeScopes changes were authorized as part of this PR or should be separated into a distinct issue/PR.
✅ Passed checks (1 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The PR fulfills issue #404 by documenting central configuration via OpAMP, including log level configuration, service-name resolution, headers, and TLS support details.

✏️ 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 docs-updates
  • 🛠️ Update Documentation: Commit on current branch
  • 🛠️ Update Documentation: Create PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 53 minutes and 6 seconds.

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

@theletterf
Copy link
Copy Markdown
Member

theletterf commented Apr 28, 2026

@alexandra5000 Could you check? We might need to update the features table and the Central Config docs in the opentelemetry repo, too. +CC @hegerchr

Copy link
Copy Markdown

@alexandra5000 alexandra5000 left a comment

Choose a reason for hiding this comment

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

Thanks for adding this! You used some phrases discouraged in Elastic docs. Other than that, it looks good to me.

Comment thread docs/reference/edot-dotnet/setup/edot-defaults.md Outdated
Comment thread docs/reference/edot-dotnet/setup/edot-defaults.md Outdated
Comment thread docs/reference/edot-dotnet/configuration.md Outdated
Comment thread docs/reference/edot-dotnet/configuration.md Outdated
Comment thread docs/reference/edot-dotnet/configuration.md Outdated
Comment thread docs/reference/edot-dotnet/configuration.md Outdated
stevejgordon and others added 6 commits April 30, 2026 07:34
Co-authored-by: Aleksandra Spilkowska <96738481+alexandra5000@users.noreply.github.com>
Co-authored-by: Aleksandra Spilkowska <96738481+alexandra5000@users.noreply.github.com>
Co-authored-by: Aleksandra Spilkowska <96738481+alexandra5000@users.noreply.github.com>
Co-authored-by: Aleksandra Spilkowska <96738481+alexandra5000@users.noreply.github.com>
Co-authored-by: Aleksandra Spilkowska <96738481+alexandra5000@users.noreply.github.com>
Co-authored-by: Aleksandra Spilkowska <96738481+alexandra5000@users.noreply.github.com>
@stevejgordon
Copy link
Copy Markdown
Contributor Author

Thanks @alexandra5000 - I also just added some minor tweaks - Do we have a standard way to document when features are introduced?

@alexandra5000
Copy link
Copy Markdown

alexandra5000 commented Apr 30, 2026

Hey @stevejgordon! If you want me to update the specific config options or features in the reference docs (like the features table and the Central Config docs in the opentelemetry repo, mentioned by Fabri), just ping me in a PR or on slack. Some of these updates are automated.

We currently capture what's new per release in the release notes, but I'm not aware of any cross-repo standard for documenting individual features + their version info.

I didn't have time yet to open a PR adding this to the reference docs in the opentelemetry repo, but it is on my to-do list, I promise 😅

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.

[Docs] Add and update documentation for central configuration

3 participants