Step-by-step guide to setting up telemetry in your Shuttle project
This guide will walk you through setting up telemetry for your Shuttle project. We’ll cover the basic setup that applies to all telemetry providers, and then point you to provider-specific guides.
Before you begin, make sure you have:
First, you need to enable telemetry export in your project. Add the setup-otel-exporter
feature to your shuttle-runtime
dependency:
The shuttle-runtime
entry in your project’s Cargo.toml
should now look something like:
Note: Your specific entry may not be identical, that’s OK. The important part is that
"setup-otel-exporter"
appears in thefeatures
array.
Shuttle supports several telemetry providers. Each has its own setup process:
We plan to expand the list of supported third party services. Let us know you thoughts and suggestions on GitHub.
Follow the specific guide for your chosen provider to:
Important: After configuring telemetry, you must redeploy your project for the changes to take effect.
If you made code changes in Step 1 (enabling runtime’s OpenTelemetry exporter), you need to make a new deployment using with shuttle deploy
.
Once your telemetry is set up, you can:
Need help? Check out our telemetry overview for more details about what metrics are available, or join our Discord community for support.