You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: develop-docs/self-hosted/production-enhancements/monitoring.mdx
+36-8Lines changed: 36 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,11 +18,17 @@ Sentry does not provide any alerts if your host instance is low on resources suc
18
18
After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Linkto="/self-hosted/#configuration">configuration section</Link> for more information.
19
19
</Alert>
20
20
21
-
## Sentry-related configurations
21
+
## Configuration
22
22
23
23
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`.
24
24
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
26
32
27
33
You can configure Sentry to send metrics to Statsd server by configuring your `sentry/sentry.conf.py` file:
You can configure Relay to send metrics to Statsd server by configuring your `relay/config.yml` file:
75
81
@@ -86,7 +92,7 @@ metrics:
86
92
87
93
Defined metric keys are specified on [statsd.rs file](https://github.com/getsentry/relay/blob/master/relay-server/src/statsd.rs).
88
94
89
-
### Symbolicator
95
+
####Symbolicator
90
96
91
97
You can configure Symbolicator to send metrics to Statsd server by configuring your `symbolicator/config.yml` file:
92
98
@@ -97,7 +103,7 @@ metrics:
97
103
prefix: "sentry.symbolicator"# Adjust this to your needs, default is "symbolicator"
98
104
```
99
105
100
-
### Uptime Checker
106
+
#### Uptime Checker
101
107
102
108
You can configure Uptime Checker to send metrics to Statsd server by configuring your `docker-compose.yml` file:
103
109
@@ -110,7 +116,7 @@ services:
110
116
UPTIME_CHECKER_STATSD_ADDR: "100.100.123.123:8125" # It's recommended to use IP address instead of domain name
111
117
```
112
118
113
-
### Taskbroker
119
+
#### Taskbroker
114
120
115
121
You can configure Taskbroker to send metrics to Statsd server by configuring your `docker-compose.yml` file:
116
122
@@ -123,6 +129,28 @@ services:
123
129
TASKBROKER_STATSD_ADDR: "100.100.123.123:8125" # It's recommended to use IP address instead of domain name
124
130
```
125
131
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
127
155
128
156
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