Skip to content

docs: align observability with runtime - #252

Merged
thomhurst merged 5 commits into
mainfrom
issue-238-observability-docs
Aug 24, 2026
Merged

docs: align observability with runtime#252
thomhurst merged 5 commits into
mainfrom
issue-238-observability-docs

Conversation

@thomhurst

Copy link
Copy Markdown
Owner

Summary

  • rewrite observability docs from the published metric and callback contracts
  • verify the instrument table and callback matrix against runtime/reflection on .NET 10 and .NET 8
  • execute the MeterListener sample and prevent duplicate analyzer tables or hardware-specific benchmark claims

Test plan

  • dotnet build Kevlar.slnx -c Release
  • all eight executable test suites (1,116 tests)
  • pwsh scripts/Verify-Docs.ps1
  • pwsh scripts/Verify-DocSnippets.ps1 -PackagesPath artifacts/package/release -Version 0.0.0-docs
  • npm run build in docs/

Closes #238

@coderabbitai

coderabbitai Bot commented Aug 24, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2ca13f9a-cca0-4d4c-b500-bc7e1b3953e8


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

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 306c382a53

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread tests/Kevlar.Chaos.Tests/DocsConsistencyTests.cs Outdated
Comment thread scripts/Verify-Docs.ps1 Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ec683e3ed0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/docs/observability.md
Comment thread scripts/Verify-Docs.ps1 Outdated
@thomhurst
thomhurst force-pushed the issue-238-observability-docs branch 3 times, most recently from 0277c80 to ce9595c Compare August 24, 2026 20:56
Keep coverage instrumentation initialization outside the measured Current-read loop.
Add executable net8/net10 contracts and canonical docs gates. Refs #238.
Locate docs from the runtime checkout instead of deterministic source paths, and validate every three-digit KEV analyzer ID.

Refs #238
Keep observability and invocation-semantics tests compatible with the merged FallbackTo API.
Keep the core meter example package-independent and detect hardware-specific benchmark claims across common CPU families.
@thomhurst
thomhurst force-pushed the issue-238-observability-docs branch from ce9595c to b412ab0 Compare August 24, 2026 21:57
@thomhurst
thomhurst merged commit 6171a4f into main Aug 24, 2026
7 checks passed
@thomhurst
thomhurst deleted the issue-238-observability-docs branch August 24, 2026 22:16
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(observability): stale callback/analyzer sections; instrument types; state absence of logging/tracing; dated overhead numbers

1 participant