Skip to content

feat(docs): Add Hasura Monitoring Integration doc#2954

Merged
makeavish merged 8 commits intomainfrom
feat/hasura-monitoring-integration
Mar 24, 2026
Merged

feat(docs): Add Hasura Monitoring Integration doc#2954
makeavish merged 8 commits intomainfrom
feat/hasura-monitoring-integration

Conversation

@crazyuploader
Copy link
Contributor

@crazyuploader crazyuploader commented Mar 23, 2026

Summary

Adds Hasura monitoring doc

Closes: #106

Doc: Link

@crazyuploader crazyuploader self-assigned this Mar 23, 2026
@crazyuploader crazyuploader added the documentation Improvements or additions to documentation label Mar 23, 2026
@vercel
Copy link

vercel bot commented Mar 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
signoz-web Ready Ready Preview, Comment Mar 24, 2026 2:48pm

Request Review

@crazyuploader
Copy link
Contributor Author

@claude /review

@claude
Copy link
Contributor

claude bot commented Mar 23, 2026

Claude finished @crazyuploader's task in 2m 39s —— View job


Review of PR #2954 — Hasura Monitoring Integration

  • Gather context and read changed files
  • Review docs changes (data/docs/integrations/opentelemetry-hasura.mdx)
  • Review frontend changes (component files, sidebar nav)
  • Run verification checks
  • Post review summary

Overview

This 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 (data/docs/integrations/opentelemetry-hasura.mdx)

What's good:

  • Frontmatter is correct (date, id, title, description, doc_type: howto)
  • Follows the Send Data doc pattern: cloud-first default, self-hosted KeyPointCallout, collapsible Collector section, collapsible Troubleshooting
  • Clear prerequisites with version requirements for each telemetry type
  • Good use of Tabs/TabItem for traces/metrics/logs and data connectors
  • Placeholders use <...> format and are documented below the CLI snippet
  • Screenshots are WebP, well-captioned, and stored in the correct path
  • ## Validate section is present with concrete steps
  • ## Troubleshooting covers common issues with symptoms and fixes
  • ## Next Steps links to dashboards, alerts, and tracing docs
  • <GetHelp /> component at the end

Issues found (3 inline comments posted):

# 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:

  • SiHasura icon from react-icons/si is 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-hasura is consistent with the MDX file path
  • No issues found

Verification

  • yarn check:docs-metadata and yarn check:doc-redirects could 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.


@crazyuploader crazyuploader marked this pull request as ready for review March 23, 2026 15:21
@claude
Copy link
Contributor

claude bot commented Mar 23, 2026

Claude finished @crazyuploader's task in 2m 55s —— View job


Review of PR #2954 — Hasura Monitoring Integration

  • Gather context and read changed files
  • Review docs changes (data/docs/integrations/opentelemetry-hasura.mdx)
  • Review frontend changes (component files, sidebar nav)
  • Run verification checks
  • Post inline findings and summary

Docs Review (data/docs/integrations/opentelemetry-hasura.mdx)

The doc is well-structured and follows existing integration patterns closely. The latest commit (04d9e85) addressed most issues from the earlier review (added missing ingestion key header for Mongo connector, fixed external link format).

1 issue found (inline comment posted):

# 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), tags correctly omitted (applies to both Cloud and Self-Host)
  • Cloud-first default with collapsible KeyPointCallout for self-hosted
  • All internal links use absolute URLs per CONTRIBUTING.md
  • External link uses <a> tag with target="_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:

  • SiHasura icon from react-icons/si (confirmed available in the package)
  • Consistent styling (className="h-7 w-7 text-blue-600") matching existing entries
  • Correct href pointing 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>
@shubham-signoz
Copy link
Collaborator

Please resolve the comments

@github-actions
Copy link
Contributor

📚 Onboarding issue created… see #2960

@makeavish makeavish enabled auto-merge (squash) March 24, 2026 11:43
@makeavish makeavish merged commit 3bfba89 into main Mar 24, 2026
7 checks passed
@makeavish makeavish deleted the feat/hasura-monitoring-integration branch March 24, 2026 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add-to-onboarding documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SigNoz for Hasura Monitoring

4 participants