Skip to content

Render docs#2566

Open
revmag wants to merge 2 commits intomainfrom
render-docs
Open

Render docs#2566
revmag wants to merge 2 commits intomainfrom
render-docs

Conversation

@revmag
Copy link
Collaborator

@revmag revmag commented Jan 21, 2026

Guide for Render docs

@vercel
Copy link

vercel bot commented Jan 21, 2026

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

Project Deployment Review Updated (UTC)
signoz-web Ready Ready Preview, Comment Jan 21, 2026 8:21am

Request Review

@claude
Copy link
Contributor

claude bot commented Jan 21, 2026

Claude finished @revmag's task in 3m 3s —— View job


Review Complete: Render Metrics Documentation

I've reviewed the PR for documentation quality and technical accuracy against the repository's CONTRIBUTING.md guidelines and official Render documentation.


Summary

This PR adds documentation for streaming Render service metrics to SigNoz using Render's Metrics Streams feature. The changes include:

  • New documentation file: render-metrics.mdx
  • Updated navigation in docsSideNav.ts
  • Added Render to the metrics overview component

Issues Found

I've posted 6 inline comments with specific issues that need to be addressed:

  1. Missing self-hosted callout - Required by CONTRIBUTING.md for consistency across Send Data docs
  2. Unverified metric names - The specific metric names (e.g., render.service.http.requests.total) cannot be confirmed from Render's official documentation
  3. Missing ingestion documentation links - Should link to SigNoz Cloud endpoints and keys documentation
  4. Unclear Render UI fields - The exact field names in Render's dashboard should be verified
  5. Missing tags field in frontmatter - Should clarify if this applies to both Cloud and Self-Host
  6. Missing required sections - Needs Troubleshooting, Next Steps, and expanded Limitations sections per CONTRIBUTING.md

Technical Accuracy Notes

Based on Render's official documentation:

  • ✅ Professional plan requirement is correct
  • ✅ SigNoz is listed as an officially supported provider
  • ✅ Static sites exclusion is correct
  • ⚠️ Specific metric names need verification (Render docs don't list all metric names)
  • ℹ️ HTTP request metrics are aggregated across instances, not per-instance

Labeling Decision

According to the custom instructions, this PR adds a NEW documentation file that explains how to send data (metrics) to SigNoz Cloud, so the add-to-onboarding label should be added. However, I don't have permission to add labels via the gh CLI.

Action Required: A maintainer should add the add-to-onboarding label to this PR.


PR Checklist Status (from CONTRIBUTING.md)

Based on the Docs PR Checklist:

  • ⚠️ Frontmatter: Missing tags field
  • SEO: Keywords present in title/description
  • Self-hosted callout: Missing
  • ⚠️ Commands: Step 2 needs more clarity
  • ⚠️ Validate section: Present but metric names unverified
  • Troubleshooting: Missing section
  • doc_type: Correctly set as howto
  • Next steps section: Missing
  • ⚠️ Links: Need to add SigNoz ingestion docs links
  • Sidebar: Correctly added to docsSideNav.ts
  • Images: Using appropriate icon in component

Sources

Added tags for better categorization and clarity.
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.

1 participant