Clarify Betterstack telemetry documentation #340
Conversation
shaaza
force-pushed
the
docs/betterstack-telemetry-clarification
branch
from
e663515 to
6d1ca6a
Compare
| To redeploy, select your latest deployment in the Shuttle Console and click "Redeploy". | ||
|
|
||
| - If you've made code changes (like adding custom metrics), redeploy using the Shuttle CLI: `shuttle deploy` | ||
| - If you haven't made any code changes, you can redeploy from the Shuttle Console by selecting your latest deployment and clicking "Redeploy" |
There was a problem hiding this comment.
Maybe also mention that it can be achieved using Shuttle CLI shuttle deployment redeploy? Am I right, @jonaro00 ?
There was a problem hiding this comment.
Have we described redeploy somewhere that we can easily reference?
There was a problem hiding this comment.
Have we described redeploy somewhere that we can easily reference?
No idea. That's why I was pulling in @jonaro00 . But if should be part of the documentation, because it's not a hidden command anymore.
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the Betterstack telemetry documentation to clarify deployment and configuration instructions for integrating Betterstack telemetry.
- Updated the deployment instructions in the Getting Started guide to emphasize the use of the Shuttle CLI when code changes are made.
- Revised the Betterstack guide by adding an optional step for enabling the OpenTelemetry exporter, refining redeployment guidelines, and updating troubleshooting steps.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/telemetry/getting-started.mdx | Changed the redeployment instructions to guide users to deploy using the Shuttle CLI after code changes. |
| docs/telemetry/betterstack.mdx | Added a new optional step for the OpenTelemetry exporter, clarified redeployment options, and updated troubleshooting details for custom metrics. |
Comments suppressed due to low confidence (1)
docs/telemetry/betterstack.mdx:57
- Verify that the updated step numbering is consistent throughout the guide and that any internal references to steps are updated accordingly.
## Step 5: Create Dashboards
| @@ -51,7 +51,7 @@ Follow the specific guide for your chosen provider to: | |||
|
|
|||
| <Warning> | |||
| **Important**: After configuring telemetry, you **_must_** redeploy your project for the changes to take effect. | |||
| You can do this by selecting your latest deployment in the Shuttle Console and clicking "Redeploy". | |||
| Since you've made code changes in Step 1 (adding the OpenTelemetry exporter), you need to deploy the changes using the Shuttle CLI. | |||
There was a problem hiding this comment.
Ensure that these deployment instructions are clearly aligned with those in the Betterstack guide, and explicitly state that they apply only for situations where code changes are present.
Copilot uses AI. Check for mistakes.
|
|
||
| For a complete list of available metrics, see our [telemetry overview](./overview#default-platform-metrics). | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| If you don't see data in Better Stack: | ||
| 1. Verify your source token and ingestion host are correct | ||
| 2. Check that your project has the `setup-otel-exporter` feature on `shuttle-runtime` enabled | ||
| 2. If you're using custom metrics, check that your project has the `setup-otel-exporter` feature on `shuttle-runtime` enabled |
There was a problem hiding this comment.
[nitpick] Consider clarifying that the setup-otel-exporter feature is required only for users implementing custom metrics, which will help prevent potential confusion during troubleshooting.
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
@shaaza +1,000,000 for the before and after screenshots. Super helpful in this context 😁
Updates documentation to clarify details about Betterstack telemetry integration.
Change 1
Before
Change 2
Before
After