Add observability documentation.#3055
Open
Malith-19 wants to merge 1 commit into
Open
Conversation
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
✅ Files skipped from review due to trivial changes (3)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation standardizes observability import paths and event constants, expands Event Anatomy and DataKey catalog, adds observability configuration (Console/File/OTel) and deployment/OTel setup guides, updates sidebar navigation, and extends Vale vocabulary for observability tooling. ChangesObservability Documentation and Configuration
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
docs/content/community/contributing/contributing-code/backend-development/observability.mdxESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox. docs/content/guides/deployment-patterns/observability.mdxESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox. docs/content/guides/getting-started/configuration.mdxESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox.
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. Comment |
Malith-19
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 9
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/sidebars.ts (1)
643-643:⚠️ Potential issue | 🟠 Major | ⚡ Quick winSidebar label hardcodes the brand name.
Is this hardcoded brand name intentional? Replace
'Contribute to ThunderID'with a config-derived string (for example,`Contribute to ${productConfig.project.name}`).As per coding guidelines,
**/*.tsanddocs/**must not hardcodeThunder/ThunderID; use config-driven product naming.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/sidebars.ts` at line 643, The sidebar entry currently hardcodes the brand in the label ({type: 'doc', id: 'community/contributing/overview', label: 'Contribute to ThunderID'}); update this to use the product name from configuration (e.g., build the label string from productConfig.project.name) so it becomes config-driven rather than hardcoded; locate the sidebar entry in docs/sidebars.ts and replace the literal label with a template that reads the product name from the existing productConfig (or import productConfig if not present) and formats it like "Contribute to ${productConfig.project.name}".
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/content/guides/deployment-patterns/observability/index.mdx`:
- Line 5: The frontmatter description contains a hardcoded product name
"ThunderID"; update the frontmatter key `description` so that the value uses the
placeholder `{{ProductName}}` instead of the literal "ThunderID" (e.g., change
the string that currently mentions ThunderID to use {{ProductName}}) to comply
with docs frontmatter guidelines.
- Line 54: Replace the hardcoded brand string "ThunderID" in the "[Set Up
OpenTelemetry] — Connect ThunderID to Jaeger, Grafana Tempo, or an OpenTelemetry
Collector." bullet with the JSX component <ProductName /> so the line reads
"[Set Up OpenTelemetry] — Connect <ProductName /> to Jaeger, Grafana Tempo, or
an OpenTelemetry Collector.", ensuring you use the MDX component syntax (not a
plain string).
- Line 10: Replace the hardcoded brand string "ThunderID" in the paragraph that
begins "ThunderID emits structured events for key identity operations — token
issuance, authentication flow execution, and authorization decisions." with the
JSX token <ProductName /> so the sentence reads "<ProductName /> emits
structured events..." to comply with the docs MDX guideline.
In `@docs/content/guides/deployment-patterns/observability/opentelemetry.mdx`:
- Around line 22-57: Replace hardcoded "ThunderID" occurrences in the
opentelemetry.mdx doc with the product component <ProductName />: update the
prerequisites bullet ("A running ThunderID instance..."), the list item that
mentions "ThunderID server", the YAML example value for service_name
("thunderid-iam") if intended to be the product identifier, and the restart note
("ThunderID must be restarted...") so all prose and example values use
<ProductName /> where the brand is referenced; ensure the JSX tag is used
verbatim in the markdown and that surrounding punctuation/quoting in the YAML
example remains valid.
- Around line 64-113: Replace all hardcoded "ThunderID" occurrences in the shown
MDX content with the MDX component <ProductName /> (e.g., "receives spans from
<ProductName />", "Run the Collector alongside <ProductName />", "Point
<ProductName /> directly..."). Update only the prose (not code blocks unless the
product name is inside plaintext), ensure the self-closing component syntax
(<ProductName />) is used with surrounding punctuation preserved, and verify the
file continues to build as MDX after the replacements.
- Around line 188-203: This section hardcodes the product name ("ThunderID");
replace every occurrence of the literal "ThunderID" in this
OpenTelemetry/observability section with the MDX component <ProductName />
(e.g., change "After restarting ThunderID" -> "After restarting <ProductName
/>") and ensure the <ProductName /> component is imported at the top of the MDX
file if it isn’t already; keep all other wording intact and preserve MDX syntax
for inline component usage.
- Line 5: The frontmatter description currently hardcodes the product name
("description: Export ThunderID observability events..."); update that
frontmatter value to use the template variable by replacing "ThunderID" with
"{{ProductName}}" so the description reads like "description: Export
{{ProductName}} observability events as OpenTelemetry traces to backends such as
Jaeger or Grafana Tempo." Ensure the change is made only in the frontmatter
`description` field.
- Around line 10-16: Replace every hardcoded "ThunderID" in the shown intro
paragraph with the JSX component <ProductName /> so the MDX uses the product
placeholder; update the lines that mention spans/traces and the export sentence
(the occurrences within the functions "How It Works" and the initial description
block) to use <ProductName /> instead of the literal brand string, ensuring the
file continues to be valid MDX (keep existing punctuation and formatting
intact).
In `@docs/content/guides/getting-started/configuration.mdx`:
- Line 475: Replace the hardcoded brand string "ThunderID" in the MDX prose with
the product component tag <ProductName />; locate the sentence containing
"ThunderID supports three output backends — console, file, and OpenTelemetry
(OTel) — and you can enable any combination of them independently." and swap
"ThunderID" for <ProductName /> so the documentation uses the reusable component
instead of a literal brand name.
---
Outside diff comments:
In `@docs/sidebars.ts`:
- Line 643: The sidebar entry currently hardcodes the brand in the label ({type:
'doc', id: 'community/contributing/overview', label: 'Contribute to
ThunderID'}); update this to use the product name from configuration (e.g.,
build the label string from productConfig.project.name) so it becomes
config-driven rather than hardcoded; locate the sidebar entry in
docs/sidebars.ts and replace the literal label with a template that reads the
product name from the existing productConfig (or import productConfig if not
present) and formats it like "Contribute to ${productConfig.project.name}".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 79887dcd-7ae9-45eb-ac86-0d195e446169
📒 Files selected for processing (5)
docs/content/community/contributing/contributing-code/backend-development/observability.mdxdocs/content/guides/deployment-patterns/observability/index.mdxdocs/content/guides/deployment-patterns/observability/opentelemetry.mdxdocs/content/guides/getting-started/configuration.mdxdocs/sidebars.ts
Malith-19
force-pushed
the
update-observability-docs
branch
2 times, most recently
from
b823807 to
e7494ff
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
sahandilshan
previously approved these changes
May 28, 2026
Malith-19
force-pushed
the
update-observability-docs
branch
3 times, most recently
from
1c514b3 to
576f650
Compare
Member
Author
|
@coderabbitai review |
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/sidebars.ts (1)
758-758: ⚡ Quick winIs this hardcoded brand name intentional?
The label contains a hardcoded "ThunderID" string literal. For consistency with the rest of this file (lines 73, 78), consider using the product name from config:
📝 Proposed fix
- {type: 'doc', id: 'community/contributing/overview', label: 'Contribute to ThunderID'}, + {type: 'doc', id: 'community/contributing/overview', label: `Contribute to ${productConfig.project.name}`},As per coding guidelines,
**/*.tsfiles should avoid hardcoded "Thunder" or "ThunderID" literals and instead read the value from the app's config system.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/sidebars.ts` at line 758, The sidebar entry currently hardcodes the label 'Contribute to ThunderID'; replace that string with the shared product-name value used elsewhere in this file by importing and using the same config export (the product name constant/selector used on lines with other labels) instead of a literal, and add the corresponding import at the top of docs/sidebars.ts so the menu object uses the config-derived product name for its label.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/sidebars.ts`:
- Line 758: The sidebar entry currently hardcodes the label 'Contribute to
ThunderID'; replace that string with the shared product-name value used
elsewhere in this file by importing and using the same config export (the
product name constant/selector used on lines with other labels) instead of a
literal, and add the corresponding import at the top of docs/sidebars.ts so the
menu object uses the config-derived product name for its label.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 88bf3c77-00f9-4a24-9152-abfb44a1e0bc
📒 Files selected for processing (5)
.vale/styles/config/vocabularies/vocab/accept.txtdocs/content/community/contributing/contributing-code/backend-development/observability.mdxdocs/content/guides/deployment-patterns/observability.mdxdocs/content/guides/getting-started/configuration.mdxdocs/sidebars.ts
✅ Files skipped from review due to trivial changes (4)
- docs/content/guides/deployment-patterns/observability.mdx
- .vale/styles/config/vocabularies/vocab/accept.txt
- docs/content/guides/getting-started/configuration.mdx
- docs/content/community/contributing/contributing-code/backend-development/observability.mdx
Contributor
✅ Actions performedReview triggered.
|
Malith-19
force-pushed
the
update-observability-docs
branch
from
576f650 to
96e38d2
Compare
Malith-19
force-pushed
the
update-observability-docs
branch
from
96e38d2 to
7003293
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Adds and expands observability documentation across the project. This covers three areas:
failure_modesetting, event categories reference, and a full example snippet.internal/system/observability), updated event type constant naming convention (event.EventTypeX), added component constants, full event type and data key reference tables, and event categories.Approach
The documentation is split by persona:
The sidebar is updated to register the new pages under the existing deployment patterns section.
Related Issues
Related PRs
Checklist
breaking changelabel added.Security checks
Summary by CodeRabbit