|
194 | 194 | {
|
195 | 195 | "type": "Gauge",
|
196 | 196 | "name": "metrics.buckets",
|
197 |
| - "description": "The total number of metric buckets in Relay's metrics aggregator.", |
| 197 | + "description": "The total number of metric buckets in Relay's metrics aggregator.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).", |
198 | 198 | "features": []
|
199 | 199 | },
|
200 | 200 | {
|
201 | 201 | "type": "Histogram",
|
202 | 202 | "name": "metrics.buckets.batches_per_partition",
|
203 |
| - "description": "The number of batches emitted per partition by [`crate::aggregation::Aggregator`].", |
| 203 | + "description": "The number of batches emitted per partition by [`crate::aggregation::Aggregator`].\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).", |
204 | 204 | "features": []
|
205 | 205 | },
|
206 | 206 | {
|
207 | 207 | "type": "Gauge",
|
208 | 208 | "name": "metrics.buckets.cost",
|
209 |
| - "description": "The total storage cost of metric buckets in Relay's metrics aggregator.", |
| 209 | + "description": "The total storage cost of metric buckets in Relay's metrics aggregator.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).", |
210 | 210 | "features": []
|
211 | 211 | },
|
212 | 212 | {
|
213 | 213 | "type": "Set",
|
214 | 214 | "name": "metrics.buckets.created.unique",
|
215 |
| - "description": "Count the number of unique buckets created.\n\nThis is a set of bucketing keys. The metric is basically equivalent to\n`metrics.buckets.merge.miss` for a single Relay, but could be useful to determine how much\nduplicate buckets there are when multiple instances are running.\n\nThe hashing is platform-dependent at the moment, so all your relays that send this metric\nshould run on the same CPU architecture, otherwise this metric is not reliable.", |
| 215 | + "description": "Count the number of unique buckets created.\n\nThis is a set of bucketing keys. The metric is basically equivalent to\n`metrics.buckets.merge.miss` for a single Relay, but could be useful to determine how much\nduplicate buckets there are when multiple instances are running.\n\nThe hashing is platform-dependent at the moment, so all your relays that send this metric\nshould run on the same CPU architecture, otherwise this metric is not reliable.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).\n- `metric_name`: A low-cardinality representation of the metric name (see [`metric_name_tag`]).", |
216 | 216 | "features": []
|
217 | 217 | },
|
218 | 218 | {
|
|
224 | 224 | {
|
225 | 225 | "type": "Counter",
|
226 | 226 | "name": "metrics.buckets.dropped",
|
227 |
| - "description": "Incremented every time a bucket is dropped.\n\nThis should only happen when a project state is invalid during graceful shutdown.", |
| 227 | + "description": "Incremented every time a bucket is dropped.\n\nThis should only happen when a project state is invalid during graceful shutdown.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).", |
228 | 228 | "features": []
|
229 | 229 | },
|
230 | 230 | {
|
231 | 231 | "type": "Histogram",
|
232 | 232 | "name": "metrics.buckets.flushed",
|
233 |
| - "description": "The total number of metric buckets flushed in a cycle across all projects.", |
| 233 | + "description": "The total number of metric buckets flushed in a cycle across all projects.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).", |
234 | 234 | "features": []
|
235 | 235 | },
|
236 | 236 | {
|
237 | 237 | "type": "Histogram",
|
238 | 238 | "name": "metrics.buckets.flushed_per_project",
|
239 |
| - "description": "The number of metric buckets flushed in a cycle for each project.\n\nRelay scans metric buckets in regular intervals and flushes expired buckets. This histogram\nis logged for each project that is being flushed. The count of the histogram values is\nequivalent to the number of projects being flushed.", |
| 239 | + "description": "The number of metric buckets flushed in a cycle for each project.\n\nRelay scans metric buckets in regular intervals and flushes expired buckets. This histogram\nis logged for each project that is being flushed. The count of the histogram values is\nequivalent to the number of projects being flushed.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).", |
240 | 240 | "features": []
|
241 | 241 | },
|
242 | 242 | {
|
|
248 | 248 | {
|
249 | 249 | "type": "Counter",
|
250 | 250 | "name": "metrics.buckets.merge.hit",
|
251 |
| - "description": "Incremented every time two buckets or two metrics are merged.\n\nTagged by metric type and name.", |
| 251 | + "description": "Incremented every time two buckets or two metrics are merged.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).\n- `metric_name`: A low-cardinality representation of the metric name (see [`metric_name_tag`]).", |
252 | 252 | "features": []
|
253 | 253 | },
|
254 | 254 | {
|
255 | 255 | "type": "Counter",
|
256 | 256 | "name": "metrics.buckets.merge.miss",
|
257 |
| - "description": "Incremented every time a bucket is created.\n\nTagged by metric type and name.", |
| 257 | + "description": "Incremented every time a bucket is created.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).\n- `metric_name`: A low-cardinality representation of the metric name (see [`metric_name_tag`]).", |
258 | 258 | "features": []
|
259 | 259 | },
|
260 | 260 | {
|
|
266 | 266 | {
|
267 | 267 | "type": "Histogram",
|
268 | 268 | "name": "metrics.buckets.partition_keys",
|
269 |
| - "description": "Distribution of flush buckets over partition keys.\n\nThe distribution of buckets should be even.\nIf it is not, this metric should expose it.", |
| 269 | + "description": "Distribution of flush buckets over partition keys.\n\nThe distribution of buckets should be even.\nIf it is not, this metric should expose it.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).", |
270 | 270 | "features": []
|
271 | 271 | },
|
272 | 272 | {
|
273 | 273 | "type": "Histogram",
|
274 | 274 | "name": "metrics.buckets.per_batch",
|
275 |
| - "description": "The number of buckets in a batch emitted by [`crate::aggregation::Aggregator`].\n\nThis corresponds to the number of buckets that will end up in an envelope.", |
| 275 | + "description": "The number of buckets in a batch emitted by [`crate::aggregation::Aggregator`].\n\nThis corresponds to the number of buckets that will end up in an envelope.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).", |
276 | 276 | "features": []
|
277 | 277 | },
|
278 | 278 | {
|
279 | 279 | "type": "Timer",
|
280 | 280 | "name": "metrics.buckets.scan_duration",
|
281 |
| - "description": "Time in milliseconds spent scanning metric buckets to flush.\n\nRelay scans metric buckets in regular intervals and flushes expired buckets. This timer\nshows the time it takes to perform this scan and remove the buckets from the internal cache.\nSending the metric buckets to upstream is outside of this timer.", |
| 281 | + "description": "Time in milliseconds spent scanning metric buckets to flush.\n\nRelay scans metric buckets in regular intervals and flushes expired buckets. This timer\nshows the time it takes to perform this scan and remove the buckets from the internal cache.\nSending the metric buckets to upstream is outside of this timer.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).", |
282 | 282 | "features": []
|
283 | 283 | },
|
284 | 284 | {
|
|
290 | 290 | {
|
291 | 291 | "type": "Counter",
|
292 | 292 | "name": "metrics.insert",
|
293 |
| - "description": "Incremented for every metric that is inserted.\n\nTagged by metric type and name.", |
| 293 | + "description": "Incremented for every metric that is inserted.\n\nThis metric is tagged with:\n- `aggregator`: The name of the metrics aggregator (usually `\"default\"`).\n- `metric_type`: The type of the metric (e.g. `\"counter\"`).", |
294 | 294 | "features": []
|
295 | 295 | },
|
296 | 296 | {
|
|
0 commit comments