Telemetry
Overview
How Shuttle Telemetry integrations work
Under the hood, Shuttle runs an OpenTelemetry (OTel) collector alongside your service that, once configured, sends project telemetry like vCPU and RAM usage as well as any custom metrics you define to a supported third-party integration of your choice.
Quick Start
To get started with telemetry in your Shuttle project, follow our step-by-step guide.Available Telemetry
Community Tier - Container Metrics
The Community tier provides essential container metrics to help you monitor your application’s resource usage. You’ll have access to key metrics across CPU, memory, network, and storage performance. For detailed information about specific metrics, see the Default Platform Metrics section below.Pro & Growth Tiers - Everything
Upgrade to Pro or Growth tier to unlock:- All Container Metrics - Everything from the Community tier
- Application Metrics - Track your application’s behavior with custom metrics
- Application Logs - Export tracing events and logs (not stdout/stderr)
- No Export Limits - Send as much data as you need
Supported Providers
Currently, Shuttle supports the following telemetry providers:- Better Stack - Recommended for most users
- More providers coming soon!
We plan to expand the list of supported third party services.
Let us know you thoughts and suggestions on GitHub.
Custom Metrics and Tracing
Learn how to add custom metrics and tracing events to your application in our Custom Metrics Guide.Default Platform Metrics
The following table lists all container metrics that Shuttle automatically collects and exports via OpenTelemetry for every deployment.| Attribute name | Description |
|---|---|
| cpu_cores | CPU cores available |
| cpu_onlines | Number of online/active CPUs |
| cpu_reserved | Reserved CPU resources (if any) |
| cpu_usage_kernelmode | CPU time spent in kernel mode (nanos) |
| cpu_usage_system | System-wide CPU usage (nanos) |
| cpu_usage_total | Total CPU time usage (nanos) |
| cpu_usage_usermode | CPU time spent in user mode (nanos) |
| cpu_usage_vcpu | vCPU usage |
| cpu_utilized | Percentage of CPU utilized |
| memory_reserved | Memory reserved (bytes) |
| memory_usage | Memory used (bytes) |
| memory_usage_limit | Memory limit (bytes) |
| memory_usage_max | The max amount of memory used by your application (bytes) |
| memory_utilized | Memory being utilised (bytes) |
| network_io_usage_rx_bytes | Network ingress (bytes) |
| network_io_usage_rx_packets | Network ingress packet count |
| network_io_usage_rx_dropped | Network ingress dropped packet count |
| network_io_usage_rx_errors | Network ingress errored packet count |
| network_io_usage_tx_bytes | Network egress (bytes) |
| network_io_usage_tx_packets | Network egress packet count |
| network_io_usage_tx_dropped | Network egress dropped packet count |
| network_io_usage_tx_errors | Network egress errored packet count |
| network_rate_rx | Network ingress rate (bytes/s) |
| network_rate_tx | Network egress rate (bytes/s) |
| storage_read_bytes | Bytes read from disk |
| storage_write_bytes | Bytes written to disk |