Skip to content

Commit 24a4353

Browse files
authored
docs: improve impact metrics description (#359)
1 parent e8b0840 commit 24a4353

1 file changed

Lines changed: 6 additions & 12 deletions

File tree

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -351,30 +351,24 @@ unleash.getImpactMetrics().incrementCounter("request_count");
351351
352352
### Gauges
353353
354-
Use gauges for values that can go up and down, such as current memory usage or active thread count.
354+
Use gauges for point-in-time values that can go up or down.
355355
356356
```java
357357
unleash.getImpactMetrics()
358-
.defineGauge("heap_memory_total", "Current heap memory usage in bytes");
358+
.defineGauge("total_users", "Total number of registered users");
359359
360-
long currentHeap = Runtime.getRuntime().totalMemory() - Runtime.getRuntime().freeMemory();
361-
362-
unleash.getImpactMetrics().updateGauge("heap_memory_total", currentHeap);
360+
unleash.getImpactMetrics().updateGauge("total_users", userCount);
363361
```
364362
365363
### Histograms
366364
367-
Use histograms to measure the distribution of values, such as request duration or response size. Unleash automatically calculates percentiles (p50, p95, p99).
365+
Histograms measure value distribution (request duration, response size).
368366
369367
```java
370368
unleash.getImpactMetrics()
371-
.defineHistogram("request_time_ms", "Time taken to process a request in milliseconds");
372-
373-
long start = System.currentTimeMillis();
374-
// handleRequest();
375-
long duration = System.currentTimeMillis() - start;
369+
.defineHistogram("request_time_ms", "Time taken to process a request in milliseconds", List.of(50.0, 100.0, 200.0, 500.0, 1000.0));
376370
377-
unleash.getImpactMetrics().observeHistogram("request_time_ms", duration);
371+
unleash.getImpactMetrics().observeHistogram("request_time_ms", 125);
378372
```
379373
380374
Impact metrics are batched and sent on the same interval as regular SDK metrics. They are ingested via the regular metrics endpoint.

0 commit comments

Comments
 (0)