feat(docs): Add Hasura Monitoring Integration doc#2954
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@claude /review |
|
Claude finished @crazyuploader's task in 2m 39s —— View job Review of PR #2954 — Hasura Monitoring Integration
OverviewThis PR adds a new Hasura OpenTelemetry integration doc covering traces, metrics, and logs export to SigNoz, along with sidebar nav entries and integration listicle cards across 4 component files. The doc is well-structured and follows the existing integration pattern closely. Docs Review (
|
| # | Severity | File | Issue |
|---|---|---|---|
| 1 | Medium | opentelemetry-hasura.mdx:186-195 |
Mongo Data Connector env vars are missing OTEL_EXPORTER_OTLP_TRACES_HEADERS with signoz-ingestion-key — traces will be rejected by SigNoz Cloud without it |
| 2 | Low | opentelemetry-hasura.mdx:66 |
Screenshot (configure-ingestion-key.webp) shows generic custom.attribute rather than the service.name/hasura-prod pair described in the text |
| 3 | Low | opentelemetry-hasura.mdx:153 |
External link to Hasura Metrics Documentation uses markdown [text](url) instead of the repo's required <a> tag with target="_blank" rel="noopener noreferrer nofollow" |
Frontend Review (component files + sidebar)
What's good:
SiHasuraicon fromreact-icons/siis confirmed to exist in the installed package- Consistent pattern with other integration entries (same structure:
name,href,icon,clickName) - Icon styling (
className="h-7 w-7 text-blue-600") matches existing entries - All 4 listicle files follow the same insertion pattern
Sidebar (constants/docsSideNav.ts):
- Hasura is added in 4 appropriate locations (APM instrumentation, Logs, Metrics, and Integrations sections)
- Route
/docs/integrations/opentelemetry-hasurais consistent with the MDX file path - No issues found
Verification
yarn check:docs-metadataandyarn check:doc-redirectscould not be run due to sandbox permissions, but the frontmatter structure looks correct based on manual inspection and comparison with existing docs.
Summary
Solid first integration doc. The main actionable issue is the missing ingestion key header for the Mongo Data Connector (line 186-195), which would cause traces to be silently rejected on SigNoz Cloud. The other two items are minor polish.
|
Claude finished @crazyuploader's task in 2m 55s —— View job Review of PR #2954 — Hasura Monitoring Integration
Docs Review (
|
| # | Severity | Line | Issue |
|---|---|---|---|
| 1 | High | 177 |
QUARKUS_OTEL_EXPORTER_OTLP_ENDPOINT is a base endpoint — the SDK auto-appends /v1/traces for http/protobuf. The current value ...443/v1/traces will cause double-pathing and traces will silently fail. Revert to ...443 (the pre-04d9e85 value was correct). |
What looks good:
- Correct frontmatter (
date,id,title,description,doc_type: howto),tagscorrectly omitted (applies to both Cloud and Self-Host) - Cloud-first default with collapsible
KeyPointCalloutfor self-hosted - All internal links use absolute URLs per CONTRIBUTING.md
- External link uses
<a>tag withtarget="_blank" rel="noopener noreferrer nofollow" - Placeholders use
<...>format with "Verify these values" blocks below snippets - Screenshots are WebP, well-captioned, stored in correct path, and match the text
- Standard sections present: Prerequisites, Configure, Validate, Troubleshooting, Next Steps, GetHelp
- Collapsible CLI config and OTel Collector sections keep the happy path clean
Frontend Review (4 listicle components + sidebar)
No issues found. All 4 component files follow the identical pattern for adding an integration entry:
SiHasuraicon fromreact-icons/si(confirmed available in the package)- Consistent styling (
className="h-7 w-7 text-blue-600") matching existing entries - Correct
hrefpointing to/docs/integrations/opentelemetry-hasura - Sidebar entries added in 4 appropriate locations (APM, Logs, Metrics, Integrations)
Verification
yarn check:docs-metadata and yarn check:doc-redirects could not be run due to sandbox permissions. Frontmatter and routing look correct based on manual inspection. No URL changes requiring redirects.
Summary
The doc and frontend additions are solid. The one remaining actionable issue is the Quarkus base endpoint containing /v1/traces (line 177) — this was introduced in the latest commit and will cause traces to fail for GraphQL data connectors. See the inline comment for the fix.
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
|
Please resolve the comments |
|
📚 Onboarding issue created… see #2960 |
Summary
Adds Hasura monitoring doc
Closes: #106
Doc: Link