Fly doc #2143
Fly doc #2143
Conversation
revmag
requested review from
makeavish,
pranay01 and
therealpandey
as code owners
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@gemini-cli /review |
|
🤖 Hi @makeavish, I've received your request, and I'm working on it now! You can track my progress in the logs for more details. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
📋 Review Summary
This Pull Request introduces new documentation for Fly.io metrics integration, including setup instructions and dashboard visualization. The changes are well-structured and follow most of the documentation guidelines.
🔍 General Feedback
- The new documentation for Fly.io metrics is comprehensive and provides clear steps for integration.
- The use of code blocks with language and filename annotations is excellent for clarity.
- Ensure all external links adhere to the
CONTRIBUTING.mdguidelines for opening in new tabs with security attributes. - Consider the use of tabs for Cloud vs Self-Host sections, as per
CONTRIBUTING.mdrecommendations.
| You would need to replace `{signoz-instance}` with the IP address or FQDN of your self-hosted SigNoz server. | ||
|
|
||
| </TabItem> |
There was a problem hiding this comment.
🟡 External links should open in a new tab and preserve security attributes as per CONTRIBUTING.md ("Hyperlinks" section). Please add target="_blank" rel="noopener noreferrer nofollow" to external links.
| You would need to replace `{signoz-instance}` with the IP address or FQDN of your self-hosted SigNoz server. | |
| </TabItem> | |
| You would need to replace `{region}` with the [region](https://signoz.io/docs/ingestion/signoz-cloud/overview/){target="_blank" rel="noopener noreferrer nofollow"} of your SigNoz Cloud environment and `<YOUR_SIGNOZ_API_KEY>` with your [Ingestion Key](https://signoz.io/docs/ingestion/signoz-cloud/keys/){target="_blank" rel="noopener noreferrer nofollow"}. |
|
|
||
| You would need to replace `{region}` with the [region](https://signoz.io/docs/ingestion/signoz-cloud/overview/) of your SigNoz Cloud environment and `<YOUR_SIGNOZ_API_KEY>` with your [Ingestion Key](https://signoz.io/docs/ingestion/signoz-cloud/keys/). | ||
|
|
||
| </TabItem> |
There was a problem hiding this comment.
🟡 Consider using the Cloud vs Self-Hosted drop-in snippet instead of tabs, as the instructions primarily differ by endpoint and ingestion key. This aligns with the "Cloud vs Self-Host" guideline in CONTRIBUTING.md which states: "Only use tabs if instructions materially diverge (e.g., different components/flows), not for small endpoint/header differences."
| }, | ||
| { | ||
| type: 'doc', | ||
| className: 'new-doc', |
There was a problem hiding this comment.
🟢 Good job adding className: 'new-doc' for the new documentation entry, as suggested in CONTRIBUTING.md ("Add Doc to Sidebar (Docs only)" section).
|
|
||
|  | ||
|
|
||
| <Admonition> |
There was a problem hiding this comment.
🟢 Correct usage of the Admonition component to highlight important information.
| <figure data-zoomable align='center'> | ||
| <img src="/img/docs/dashboards/dashboard-templates/fly-dashboard.webp" alt="Fly.io Dashboard"/> | ||
| <figcaption><i>Fly.io Dashboard</i></figcaption> |
There was a problem hiding this comment.
🟡 External links should open in a new tab and preserve security attributes as per CONTRIBUTING.md ("Hyperlinks" section). Please add target="_blank" rel="noopener noreferrer nofollow" to external links.
| <figure data-zoomable align='center'> | |
| <img src="/img/docs/dashboards/dashboard-templates/fly-dashboard.webp" alt="Fly.io Dashboard"/> | |
| <figcaption><i>Fly.io Dashboard</i></figcaption> | |
| You can use the pre-configured dashboard for Docker metrics or [create your own custom dashboard](https://signoz.io/docs/userguide/manage-dashboards/#steps-to-create-a-custom-dashboard){target="_blank" rel="noopener noreferrer nofollow"}. To use the pre-configured dashboard, download the dashboard JSON from [here](https://github.com/SigNoz/dashboards/blob/main/container-metrics/docker/container-metrics-by-host.json){target="_blank" rel="noopener noreferrer nofollow"} and import it to SigNoz by clicking Dashboards → New dashboard → Import JSON: |
|
@makeavish please review the fly.io dashboard docs first, the link for dashboard is temperory in this doc, once that is approved, will update |
2 participants
Adding fly.io docs integration guide along with dashboards.