Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions docs/telemetry/betterstack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ This guide will walk you through setting up Better Stack as your telemetry provi
## Prerequisites

1. A [Better Stack account](https://betterstack.com/) (sign up if you don't have one)
2. A Shuttle project with the OpenTelemetry exporter enabled (see [Getting Started](./getting-started))

## Step 1: Create a Telemetry Source in Better Stack

Expand Down Expand Up @@ -38,12 +37,24 @@ This guide will walk you through setting up Better Stack as your telemetry provi
- Paste your source token and ingestion host
- Click "Apply"

## Step 3: Enable OpenTelemetry Exporter (optional)

<Note>
This step is only required if you want to emit custom metrics and logs from your application. If you only need the default CPU, network, and memory metrics, you can skip this step.
</Note>

Follow the [Getting Started guide](./getting-started#step-1-enable-the-opentelemetry-exporter) to enable the OpenTelemetry exporter in your project.

## Step 4: Redeploy Your Project

<Warning>
**Important**: If your project was already running, you must redeploy it for telemetry to start flowing.
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"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe also mention that it can be achieved using Shuttle CLI shuttle deployment redeploy? Am I right, @jonaro00 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have we described redeploy somewhere that we can easily reference?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

</Warning>

## Step 3: Create Dashboards
## Step 5: Create Dashboards

Once telemetry data starts flowing, you can create custom dashboards in Better Stack:

Expand Down Expand Up @@ -73,14 +84,14 @@ Better Stack will receive all the standard Shuttle telemetry metrics, including:
- Memory usage and limits
- Network I/O statistics
- Disk I/O statistics
- Custom metrics from your application
- Custom metrics from your application (requires OpenTelemetry exporter from Step 3)

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
Copy link

Copilot AI May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.
3. Ensure you've redeployed your project after enabling telemetry
4. Contact [Better Stack support](https://betterstack.com/contact) or join our [Discord community](https://discord.gg/shuttle) for help
2 changes: 1 addition & 1 deletion docs/telemetry/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link

Copilot AI May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
</Warning>

## Next Steps
Expand Down