Skip to content

Commit e73774f

Browse files
authored
Merge pull request #340 from shuttle-hq/docs/betterstack-telemetry-clarification
Clarify Betterstack telemetry documentation
2 parents fc1da1d + 6d1ca6a commit e73774f

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

docs/telemetry/betterstack.mdx

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This guide will walk you through setting up Better Stack as your telemetry provi
99
## Prerequisites
1010

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

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

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

40+
## Step 3: Enable OpenTelemetry Exporter (optional)
41+
42+
<Note>
43+
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.
44+
</Note>
45+
46+
Follow the [Getting Started guide](./getting-started#step-1-enable-the-opentelemetry-exporter) to enable the OpenTelemetry exporter in your project.
47+
48+
## Step 4: Redeploy Your Project
49+
4150
<Warning>
4251
**Important**: If your project was already running, you must redeploy it for telemetry to start flowing.
43-
To redeploy, select your latest deployment in the Shuttle Console and click "Redeploy".
52+
53+
- If you've made code changes (like adding custom metrics), redeploy using the Shuttle CLI: `shuttle deploy`
54+
- If you haven't made any code changes, you can redeploy from the Shuttle Console by selecting your latest deployment and clicking "Redeploy"
4455
</Warning>
4556

46-
## Step 3: Create Dashboards
57+
## Step 5: Create Dashboards
4758

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

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

7889
For a complete list of available metrics, see our [telemetry overview](./overview#default-platform-metrics).
7990

8091
## Troubleshooting
8192

8293
If you don't see data in Better Stack:
8394
1. Verify your source token and ingestion host are correct
84-
2. Check that your project has the `setup-otel-exporter` feature on `shuttle-runtime` enabled
95+
2. If you're using custom metrics, check that your project has the `setup-otel-exporter` feature on `shuttle-runtime` enabled
8596
3. Ensure you've redeployed your project after enabling telemetry
8697
4. Contact [Better Stack support](https://betterstack.com/contact) or join our [Discord community](https://discord.gg/shuttle) for help

docs/telemetry/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Follow the specific guide for your chosen provider to:
5151

5252
<Warning>
5353
**Important**: After configuring telemetry, you **_must_** redeploy your project for the changes to take effect.
54-
You can do this by selecting your latest deployment in the Shuttle Console and clicking "Redeploy".
54+
Since you've made code changes in Step 1 (adding the OpenTelemetry exporter), you need to deploy the changes using the Shuttle CLI.
5555
</Warning>
5656

5757
## Next Steps

0 commit comments

Comments
 (0)