Skip to content

Commit 34301b0

Browse files
authored
docs(self-hosted): provide notable statsd keys to monitor (#15487)
Follow up for getsentry/self-hosted#4031
1 parent 9ed400c commit 34301b0

File tree

1 file changed

+36
-8
lines changed

1 file changed

+36
-8
lines changed

develop-docs/self-hosted/production-enhancements/monitoring.mdx

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,17 @@ Sentry does not provide any alerts if your host instance is low on resources suc
1818
After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
1919
</Alert>
2020

21-
## Sentry-related configurations
21+
## Configuration
2222

2323
This documentation assumes `100.100.123.123` as your statsd host IP address. On most services, it is recommended to provide an IP address for the host like this, instead of a domain name like `statsd.yourcompany.com`.
2424

25-
### Sentry
25+
To start, simply uncomment and change the value of `STATSD_ADDR` on your `.env` or `.env.custom` file to your statsd host IP address.
26+
27+
### Manual Configuration
28+
29+
If you don't have the liberty of using the `.env` file, or you want to be very specific about the configuration, you can configure it manually too.
30+
31+
#### Sentry
2632

2733
You can configure Sentry to send metrics to Statsd server by configuring your `sentry/sentry.conf.py` file:
2834

@@ -36,7 +42,7 @@ SENTRY_METRICS_OPTIONS: dict[str, Any] = {
3642
# SENTRY_METRICS_PREFIX = "sentry." # Adjust this to your needs, default is "sentry."
3743
```
3844

39-
### Snuba
45+
#### Snuba
4046

4147
You can configure Snuba to send metrics to Statsd server by configuring your `docker-compose.yml` file:
4248

@@ -69,7 +75,7 @@ x-snuba-defaults: &snuba_defaults
6975
# The rest of your Docker Compose file
7076
```
7177

72-
### Relay
78+
#### Relay
7379

7480
You can configure Relay to send metrics to Statsd server by configuring your `relay/config.yml` file:
7581

@@ -86,7 +92,7 @@ metrics:
8692

8793
Defined metric keys are specified on [statsd.rs file](https://github.com/getsentry/relay/blob/master/relay-server/src/statsd.rs).
8894

89-
### Symbolicator
95+
#### Symbolicator
9096

9197
You can configure Symbolicator to send metrics to Statsd server by configuring your `symbolicator/config.yml` file:
9298

@@ -97,7 +103,7 @@ metrics:
97103
prefix: "sentry.symbolicator" # Adjust this to your needs, default is "symbolicator"
98104
```
99105
100-
### Uptime Checker
106+
#### Uptime Checker
101107
102108
You can configure Uptime Checker to send metrics to Statsd server by configuring your `docker-compose.yml` file:
103109

@@ -110,7 +116,7 @@ services:
110116
UPTIME_CHECKER_STATSD_ADDR: "100.100.123.123:8125" # It's recommended to use IP address instead of domain name
111117
```
112118

113-
### Taskbroker
119+
#### Taskbroker
114120

115121
You can configure Taskbroker to send metrics to Statsd server by configuring your `docker-compose.yml` file:
116122

@@ -123,6 +129,28 @@ services:
123129
TASKBROKER_STATSD_ADDR: "100.100.123.123:8125" # It's recommended to use IP address instead of domain name
124130
```
125131

126-
## Sentry dependencies
132+
## Notable Metric Keys
133+
134+
You can query these keys on your statsd server to get a better understanding of what is happening in your Sentry instance.
135+
136+
**API request volume**
137+
138+
- `sentry.view.response` - has tags for url-name and method. Which gives visibility into what API requests are being made to Sentry (`web` container), and what endpoints are being used.
139+
- `sentry.view.duration` - has the same tags as `sentry.view.response`, but gives duration for API requests.
140+
141+
**Task throughput**
142+
143+
- `sentry.taskworker.registry.send_task.scheduled` - has tags for taskname, gives throughput of tasks being created.
144+
- `sentry.taskworker.worker.execute_task` - has tags for taskname, gives throughput of tasks being completed.
145+
- `sentry.taskworker.worker.execution_duration` - has tags for taskname, gives task execution duration.
146+
147+
**Error processing**
148+
149+
- `sentry.relay.event.accepted` - The event volume Relay is accepting.
150+
- `sentry.relay.event.items` - has tag for item_type which maps to event categories. Measures the volume of event items being handled by Relay.
151+
- `sentry.event_manager.save_error_events.count` - The number of events being processed.
152+
- `sentry.events.since_received` - has tags for each major step in the pipeline, and measures duration between the event being received by Relay and reaching each stage.
153+
154+
## Other Sentry dependencies
127155

128156
We don't provide configurations for Sentry's dependencies such as PostgreSQL, Kafka, Redis, Memcached and ClickHouse that are bundled with the Docker Compose file. You will need to provide monitoring configuration for those service yourself adjusted to your needs.

0 commit comments

Comments
 (0)