-
Notifications
You must be signed in to change notification settings - Fork 375
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add example files with console log output
Update example/counter.js Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com> Update example/default-metrics.js Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com> Update example/gauge.js Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com> Fix lint Refactor for destructure docs: update the changelog
- Loading branch information
Showing
8 changed files
with
502 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
'use strict'; | ||
|
||
// Counter | ||
// Single Label | ||
// Multiple Values | ||
|
||
const { Counter, register } = require('..'); | ||
const c = new Counter({ | ||
name: 'test_counter', | ||
help: 'Example of a counter', | ||
labelNames: ['code'], | ||
}); | ||
|
||
c.inc({ code: 200 }); | ||
console.log(register.metrics()); | ||
|
||
/* | ||
# HELP test_counter Example of a counter | ||
# TYPE test_counter counter | ||
test_counter{code="200"} 1 | ||
*/ | ||
|
||
c.inc({ code: 200 }); | ||
console.log(register.metrics()); | ||
|
||
/* | ||
# HELP test_counter Example of a counter | ||
# TYPE test_counter counter | ||
test_counter{code="200"} 2 | ||
*/ | ||
|
||
c.inc(); | ||
console.log(register.metrics()); | ||
|
||
/* | ||
# HELP test_counter Example of a counter | ||
# TYPE test_counter counter | ||
test_counter{code="200"} 2 | ||
test_counter 1 | ||
*/ | ||
|
||
c.reset(); | ||
console.log(register.metrics()); | ||
|
||
/* | ||
# HELP test_counter Example of a counter | ||
# TYPE test_counter counter | ||
*/ | ||
|
||
c.inc(15); | ||
console.log(register.metrics()); | ||
|
||
/* | ||
# HELP test_counter Example of a counter | ||
# TYPE test_counter counter | ||
test_counter 15 | ||
*/ | ||
|
||
c.inc({ code: 200 }, 12); | ||
console.log(register.metrics()); | ||
|
||
/* | ||
# HELP test_counter Example of a counter | ||
# TYPE test_counter counter | ||
test_counter 15 | ||
test_counter{code="200"} 12 | ||
*/ | ||
|
||
c.labels('200').inc(12); | ||
console.log(register.metrics()); | ||
|
||
/* | ||
# HELP test_counter Example of a counter | ||
# TYPE test_counter counter | ||
test_counter 15 | ||
test_counter{code="200"} 24 | ||
*/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,149 @@ | ||
'use strict'; | ||
|
||
const { collectDefaultMetrics, register } = require('..'); | ||
|
||
collectDefaultMetrics({ | ||
timeout: 10000, | ||
gcDurationBuckets: [0.001, 0.01, 0.1, 1, 2, 5], // These are the default buckets. | ||
}); | ||
|
||
console.log(register.metrics()); | ||
|
||
/* | ||
Output from metrics(): | ||
# HELP process_cpu_user_seconds_total Total user CPU time spent in seconds. | ||
# TYPE process_cpu_user_seconds_total counter | ||
process_cpu_user_seconds_total 0.004261 | ||
# HELP process_cpu_system_seconds_total Total system CPU time spent in seconds. | ||
# TYPE process_cpu_system_seconds_total counter | ||
process_cpu_system_seconds_total 0.000547 | ||
# HELP process_cpu_seconds_total Total user and system CPU time spent in seconds. | ||
# TYPE process_cpu_seconds_total counter | ||
process_cpu_seconds_total 0.004808 | ||
# HELP process_start_time_seconds Start time of the process since unix epoch in seconds. | ||
# TYPE process_start_time_seconds gauge | ||
process_start_time_seconds 1585092233 | ||
# HELP process_resident_memory_bytes Resident memory size in bytes. | ||
# TYPE process_resident_memory_bytes gauge | ||
process_resident_memory_bytes 37072896 | ||
# HELP process_virtual_memory_bytes Virtual memory size in bytes. | ||
# TYPE process_virtual_memory_bytes gauge | ||
process_virtual_memory_bytes 576438272 | ||
# HELP process_heap_bytes Process heap size in bytes. | ||
# TYPE process_heap_bytes gauge | ||
process_heap_bytes 50720768 | ||
# HELP process_open_fds Number of open file descriptors. | ||
# TYPE process_open_fds gauge | ||
process_open_fds 98 | ||
# HELP process_max_fds Maximum number of open file descriptors. | ||
# TYPE process_max_fds gauge | ||
process_max_fds 1048576 | ||
# HELP nodejs_eventloop_lag_seconds Lag of event loop in seconds. | ||
# TYPE nodejs_eventloop_lag_seconds gauge | ||
nodejs_eventloop_lag_seconds 0 | ||
# HELP nodejs_eventloop_lag_min_seconds The minimum recorded event loop delay. | ||
# TYPE nodejs_eventloop_lag_min_seconds gauge | ||
nodejs_eventloop_lag_min_seconds 9223372036.854776 | ||
# HELP nodejs_eventloop_lag_max_seconds The maximum recorded event loop delay. | ||
# TYPE nodejs_eventloop_lag_max_seconds gauge | ||
nodejs_eventloop_lag_max_seconds 0 | ||
# HELP nodejs_eventloop_lag_mean_seconds The mean of the recorded event loop delays. | ||
# TYPE nodejs_eventloop_lag_mean_seconds gauge | ||
nodejs_eventloop_lag_mean_seconds Nan | ||
# HELP nodejs_eventloop_lag_stddev_seconds The standard deviation of the recorded event loop delays. | ||
# TYPE nodejs_eventloop_lag_stddev_seconds gauge | ||
nodejs_eventloop_lag_stddev_seconds Nan | ||
# HELP nodejs_eventloop_lag_p50_seconds The 50th percentile of the recorded event loop delays. | ||
# TYPE nodejs_eventloop_lag_p50_seconds gauge | ||
nodejs_eventloop_lag_p50_seconds 0 | ||
# HELP nodejs_eventloop_lag_p90_seconds The 90th percentile of the recorded event loop delays. | ||
# TYPE nodejs_eventloop_lag_p90_seconds gauge | ||
nodejs_eventloop_lag_p90_seconds 0 | ||
# HELP nodejs_eventloop_lag_p99_seconds The 99th percentile of the recorded event loop delays. | ||
# TYPE nodejs_eventloop_lag_p99_seconds gauge | ||
nodejs_eventloop_lag_p99_seconds 0 | ||
# HELP nodejs_active_handles Number of active libuv handles grouped by handle type. Every handle type is C++ class name. | ||
# TYPE nodejs_active_handles gauge | ||
# HELP nodejs_active_handles_total Total number of active handles. | ||
# TYPE nodejs_active_handles_total gauge | ||
nodejs_active_handles_total 0 | ||
# HELP nodejs_active_requests Number of active libuv requests grouped by request type. Every request type is C++ class name. | ||
# TYPE nodejs_active_requests gauge | ||
# HELP nodejs_active_requests_total Total number of active requests. | ||
# TYPE nodejs_active_requests_total gauge | ||
nodejs_active_requests_total 0 | ||
# HELP nodejs_heap_size_total_bytes Process heap size from Node.js in bytes. | ||
# TYPE nodejs_heap_size_total_bytes gauge | ||
nodejs_heap_size_total_bytes 5746688 | ||
# HELP nodejs_heap_size_used_bytes Process heap size used from Node.js in bytes. | ||
# TYPE nodejs_heap_size_used_bytes gauge | ||
nodejs_heap_size_used_bytes 3870560 | ||
# HELP nodejs_external_memory_bytes Node.js external memory size in bytes. | ||
# TYPE nodejs_external_memory_bytes gauge | ||
nodejs_external_memory_bytes 1221803 | ||
# HELP nodejs_heap_space_size_total_bytes Process heap space size total from Node.js in bytes. | ||
# TYPE nodejs_heap_space_size_total_bytes gauge | ||
nodejs_heap_space_size_total_bytes{space="read_only"} 262144 | ||
nodejs_heap_space_size_total_bytes{space="new"} 2097152 | ||
nodejs_heap_space_size_total_bytes{space="old"} 2244608 | ||
nodejs_heap_space_size_total_bytes{space="code"} 430080 | ||
nodejs_heap_space_size_total_bytes{space="map"} 528384 | ||
nodejs_heap_space_size_total_bytes{space="large_object"} 135168 | ||
nodejs_heap_space_size_total_bytes{space="code_large_object"} 49152 | ||
nodejs_heap_space_size_total_bytes{space="new_large_object"} 0 | ||
# HELP nodejs_heap_space_size_used_bytes Process heap space size used from Node.js in bytes. | ||
# TYPE nodejs_heap_space_size_used_bytes gauge | ||
nodejs_heap_space_size_used_bytes{space="read_only"} 32808 | ||
nodejs_heap_space_size_used_bytes{space="new"} 955440 | ||
nodejs_heap_space_size_used_bytes{space="old"} 2231120 | ||
nodejs_heap_space_size_used_bytes{space="code"} 165472 | ||
nodejs_heap_space_size_used_bytes{space="map"} 353760 | ||
nodejs_heap_space_size_used_bytes{space="large_object"} 131112 | ||
nodejs_heap_space_size_used_bytes{space="code_large_object"} 2784 | ||
nodejs_heap_space_size_used_bytes{space="new_large_object"} 0 | ||
# HELP nodejs_heap_space_size_available_bytes Process heap space size available from Node.js in bytes. | ||
# TYPE nodejs_heap_space_size_available_bytes gauge | ||
nodejs_heap_space_size_available_bytes{space="read_only"} 0 | ||
nodejs_heap_space_size_available_bytes{space="new"} 92016 | ||
nodejs_heap_space_size_available_bytes{space="old"} 3608 | ||
nodejs_heap_space_size_available_bytes{space="code"} 0 | ||
nodejs_heap_space_size_available_bytes{space="map"} 0 | ||
nodejs_heap_space_size_available_bytes{space="large_object"} 0 | ||
nodejs_heap_space_size_available_bytes{space="code_large_object"} 0 | ||
nodejs_heap_space_size_available_bytes{space="new_large_object"} 1047456 | ||
# HELP nodejs_version_info Node.js version info. | ||
# TYPE nodejs_version_info gauge | ||
nodejs_version_info{version="v12.16.1",major="12",minor="16",patch="1"} 1 | ||
# HELP nodejs_gc_duration_seconds Garbage collection duration by kind, one of major, minor, incremental or weakcb. | ||
# TYPE nodejs_gc_duration_seconds histogram | ||
*/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
'use strict'; | ||
|
||
// Gauge | ||
// Single Label | ||
// Multiple Values | ||
|
||
const { Gauge, register } = require('..'); | ||
const g = new Gauge({ | ||
name: 'test_gauge', | ||
help: 'Example of a gauge', | ||
labelNames: ['code'], | ||
}); | ||
|
||
g.set({ code: 200 }, 5); | ||
console.log(register.metrics()); | ||
/* | ||
# HELP test_gauge Example of a gauge | ||
# TYPE test_gauge gauge | ||
test_gauge{code="200"} 5 | ||
*/ | ||
|
||
g.set(15); | ||
console.log(register.metrics()); | ||
/* | ||
# HELP test_gauge Example of a gauge | ||
# TYPE test_gauge gauge | ||
test_gauge{code="200"} 5 | ||
test_gauge 15 | ||
*/ | ||
|
||
g.labels('200').inc(); | ||
console.log(register.metrics()); | ||
/* | ||
# HELP test_gauge Example of a gauge | ||
# TYPE test_gauge gauge | ||
test_gauge{code="200"} 6 | ||
test_gauge 15 | ||
*/ | ||
|
||
g.inc(); | ||
console.log(register.metrics()); | ||
/* | ||
# HELP test_gauge Example of a gauge | ||
# TYPE test_gauge gauge | ||
test_gauge{code="200"} 6 | ||
test_gauge 16 | ||
*/ | ||
|
||
g.set(22); | ||
console.log(register.metrics()); | ||
/* | ||
# HELP test_gauge Example of a gauge | ||
# TYPE test_gauge gauge | ||
test_gauge{code="200"} 6 | ||
test_gauge 22 | ||
*/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
'use strict'; | ||
|
||
// Histogram | ||
// Single Label | ||
// Single Value | ||
|
||
const { register, Histogram } = require('..'); | ||
|
||
const h = new Histogram({ | ||
name: 'test_histogram', | ||
help: 'Example of a histogram', | ||
labelNames: ['code'], | ||
}); | ||
|
||
h.labels('200').observe(0.4); | ||
h.labels('200').observe(0.6); | ||
|
||
console.log(register.metrics()); | ||
|
||
/* | ||
Output from metrics(): | ||
# HELP test_histogram Example of a histogram | ||
# TYPE test_histogram histogram | ||
test_histogram_bucket{le="0.005",code="200"} 0 | ||
test_histogram_bucket{le="0.01",code="200"} 0 | ||
test_histogram_bucket{le="0.025",code="200"} 0 | ||
test_histogram_bucket{le="0.05",code="200"} 0 | ||
test_histogram_bucket{le="0.1",code="200"} 0 | ||
test_histogram_bucket{le="0.25",code="200"} 0 | ||
test_histogram_bucket{le="0.5",code="200"} 1 | ||
test_histogram_bucket{le="1",code="200"} 2 | ||
test_histogram_bucket{le="2.5",code="200"} 2 | ||
test_histogram_bucket{le="5",code="200"} 2 | ||
test_histogram_bucket{le="10",code="200"} 2 | ||
test_histogram_bucket{le="+Inf",code="200"} 2 | ||
test_histogram_sum{code="200"} 1 | ||
test_histogram_count{code="200"} 2 | ||
*/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
'use strict'; | ||
|
||
// Histogram | ||
// Single Label | ||
// Multiple Values | ||
|
||
const { register, Histogram } = require('..'); | ||
|
||
const h = new Histogram({ | ||
name: 'test_histogram', | ||
help: 'Example of a histogram', | ||
labelNames: ['code'], | ||
}); | ||
|
||
h.labels('200').observe(0.4); | ||
h.labels('300').observe(0.6); | ||
|
||
console.log(register.metrics()); | ||
|
||
/* | ||
Output from metrics(): | ||
# HELP test_histogram Example of a histogram | ||
# TYPE test_histogram histogram | ||
test_histogram_bucket{le="0.005",code="200"} 0 | ||
test_histogram_bucket{le="0.01",code="200"} 0 | ||
test_histogram_bucket{le="0.025",code="200"} 0 | ||
test_histogram_bucket{le="0.05",code="200"} 0 | ||
test_histogram_bucket{le="0.1",code="200"} 0 | ||
test_histogram_bucket{le="0.25",code="200"} 0 | ||
test_histogram_bucket{le="0.5",code="200"} 1 | ||
test_histogram_bucket{le="1",code="200"} 1 | ||
test_histogram_bucket{le="2.5",code="200"} 1 | ||
test_histogram_bucket{le="5",code="200"} 1 | ||
test_histogram_bucket{le="10",code="200"} 1 | ||
test_histogram_bucket{le="+Inf",code="200"} 1 | ||
test_histogram_sum{code="200"} 0.4 | ||
test_histogram_count{code="200"} 1 | ||
test_histogram_bucket{le="0.005",code="300"} 0 | ||
test_histogram_bucket{le="0.01",code="300"} 0 | ||
test_histogram_bucket{le="0.025",code="300"} 0 | ||
test_histogram_bucket{le="0.05",code="300"} 0 | ||
test_histogram_bucket{le="0.1",code="300"} 0 | ||
test_histogram_bucket{le="0.25",code="300"} 0 | ||
test_histogram_bucket{le="0.5",code="300"} 0 | ||
test_histogram_bucket{le="1",code="300"} 1 | ||
test_histogram_bucket{le="2.5",code="300"} 1 | ||
test_histogram_bucket{le="5",code="300"} 1 | ||
test_histogram_bucket{le="10",code="300"} 1 | ||
test_histogram_bucket{le="+Inf",code="300"} 1 | ||
test_histogram_sum{code="300"} 0.6 | ||
test_histogram_count{code="300"} 1 | ||
*/ |
Oops, something went wrong.