Metrics Reference

This page lists the metrics generated by the Platform. See Overview for details on how metrics are captured, stored and presented. Each component will generate a range of metrics. With metrics enabled on a component, kdb info, memory and cpu metrics are generated.

Metric Suffixes

The suffix to a metric name describes its contents. These suffixes are used in individual application metrics.

_total

This counter metric reports the total number of calls to the specified function.

kdb_sync_opened_total{service="component"}   10

_err_total

This counter metric reports the total number of errored calls to the specified function.

kdb_sync_err_total{service="component"}  1

_failure_total

This counter metric reports the total number of failed calls to the specified function, including errors.

kxi_sd_register_failure_total{service="component"}  2

_histogram_seconds

This histogram metric reports the duration of requests made to the function in less than or equal to buckets.

kdb_sync_histogram_seconds{le="+Inf", service="component"}  109
kdb_sync_histogram_seconds{le="0.25", service="component"}  23
kdb_sync_histogram_seconds{le="0.5", service="component"}  23
kdb_sync_histogram_seconds{le="1", service="component"}  24
kdb_sync_histogram_seconds{le="10", service="component"}  109
kdb_sync_histogram_seconds{le="5", service="component"}  44

_histogram_seconds_sum

Additional counter metric created as part of _histogram_seconds. This metric reports the sum of the duration of the recorded operation made in the component container.

kdb_sync_histogram_seconds_sum{service="component"}  557.5367

_histogram_seconds_count

Additional counter metric created as part of _histogram_seconds. This metric reports the total number the recorded operations made in the component container.

kdb_sync_histogram_seconds_count{service="component"}  109

_summary_seconds

This summary metric reports the duration of requests made to the function in set quantiles 0.25, 0.5 and 0.75.

kdb_sync_summary_seconds{quantile="0.25", service="component"}  1.991117
kdb_sync_summary_seconds{quantile="0.5", service="component"}  6.507305
kdb_sync_summary_seconds{quantile="0.75", service="component"}  7.993268

_summary_seconds_sum

Additional counter metric created as part of _summary_seconds. This metric reports the sum of the duration of the recorded operation made in the component container.

kdb_sync_summary_seconds_sum{service="component"}  557.5367

_summary_seconds_count

Additional counter metric created as part of _summary_seconds. This metric reports the total number the recorded operations made in the component container.

kdb_sync_summary_seconds_count{service="component"}  109

License

kdb_info

This is a gauge metric detailing the the kdb+ license.

kdb_info{license_expiry_date="2022.01.27", os_version="l64", process_cores="4", release_date="2021.06.12", release_version="4.1", service="component"}

Memory stats

memory_usage_bytes

This gauge metric reports the current memory usage in bytes of the component container. Output is taken from .Q.w[].

q) .Q.w[]`used

memory_usage_bytes{service="component"}  1010128

memory_heap_bytes

This gauge metric reports the memory available in the heap in bytes for the component container. Output is taken from .Q.w[].

.Q.w[]`heap

memory_heap_bytes{service="component"}  67108860

memory_heap_peak_bytes

This gauge metric reports the maximum heap size so far in bytes for the component container. Output is taken from .Q.w[].

.Q.w[]`peak

memory_heap_peak_bytes{service="component"}  67108860

memory_heap_limit_bytes

This gauge metric reports the memory limit heap in bytes for the component container as set by -w.

Output is taken from .Q.w[]

.Q.w[]`wmax

memory_heap_limit_bytes{service="component"}  0

memory_mapped_bytes

This gauge metric reports the mapped memory in bytes for the component container.

Output is taken from .Q.w[]

.Q.w[]`mmap

memory_mapped_bytes{service="component"}   0

memory_physical_bytes

This gauge metric reports the physical memory available in bytes for the component container.

Output is taken from .Q.w[]

.Q.w[]`mphy

memory_physical_bytes{service="component"}  16788270000

kdb_syms_total

This gauge metric reports the number of symbols for the component container.

Output is taken from .Q.w[]

q) .Q.w[]`syms

kdb_syms_total{service="component"}   2150

kdb_syms_memory_bytes

This gauge metric reports the memory use of symbols in bytes for the component container.

Output is taken from .Q.w[]

q) .Q.w[]`symw

kdb_syms_memory_bytes{service="component"}  106648

.z Handler Metrics

Each component is able to generate metrics from the .z.* handlers, these are enabled by setting the relevant field true under the metrics.handler object in your values file. See details here.

kdb_ipc_opened_total

This counter metric reports the total number of ipc sockets that have been opened to the component container.

Enable by setting:

handler:
    po: true

kdb_ipc_opened_total{service="component"}   1

kdb_handles_total

This gauge metric reports the total number of open handles (ipc and websocket) to the component container.

Enabled by setting any of the following:

handler:
    po: true
    pc: true
    wo: true
    wc: true

kdb_handles_total{service="component"}  1

Note

This metrics is incremented and decremented by multiple handlers, all should be enabled to get a better view of application.

kdb_ipc_closed_total

This counter metric reports the total number of ipc sockets that have been closed to the component container.

Enable by setting:

handler:
    pc: true

kdb_ipc_closed_total{service="component"}  0

kdb_ws_opened_total

This counter metric reports the total number of websockets opened to the component container.

Enable by setting:

handler:
    wo: true

kdb_ws_opened_total{service="component"}  0

kdb_ws_closed_total

This counter metric reports the total number of websockets closed to the component container.

Enable by setting:

handler:
    wc: true

kdb_ws_closed_total{service="component"}  0

kdb_sync

Metrics prepended with kdb_sync relate to the sync requests made to the component container.

Enable by setting:

handler:
    pg: true

Available metrics:

kdb_sync_total
kdb_sync_err_total
kdb_sync_summary_seconds
kdb_sync_summary_seconds_sum
kdb_sync_summary_seconds_count
kdb_sync_histogram_seconds
kdb_sync_histogram_seconds_sum
kdb_sync_histogram_seconds_count

kdb_async

Metrics prepended with kdb_async relate to the async requests made to the component container.

Enable by setting:

handler:
    ps: true

Available metrics:

kdb_async_total
kdb_async_err_total
kdb_async_summary_seconds
kdb_async_summary_seconds_sum
kdb_async_summary_seconds_count
kdb_async_histogram_seconds
kdb_async_histogram_seconds_sum
kdb_async_histogram_seconds_count

kdb_http_get

Metrics prepended with kdb_http_get relate to the http GET requests made to the component container.

Enable by setting:

handler:
    ph: true

Available metrics:

kdb_http_get_total
kdb_http_get_err_total
kdb_http_get_summary_seconds
kdb_http_get_summary_seconds_sum
kdb_http_get_summary_seconds_count
kdb_http_get_histogram_seconds
kdb_http_get_histogram_seconds_sum
kdb_http_get_histogram_seconds_count

kdb_http_post

Metrics prepended with kdb_http_post relate to the http POST requests made to the component container.

Enable by setting:

handler:
    pp: true

Available metrics:

kdb_http_post_total
kdb_http_post_err_total
kdb_http_post_summary_seconds
kdb_http_post_summary_seconds_sum
kdb_http_post_summary_seconds_count
kdb_http_post_histogram_seconds
kdb_http_post_histogram_seconds_sum
kdb_http_post_histogram_seconds_count

kdb_ts

Metrics prepended with kdb_ts relate to the timer calls made within the component container.

Enable by setting:

handler:
    ts: true

Available metrics:

kdb_ts_total
kdb_ts_err_total
kdb_ts_summary_seconds
kdb_ts_summary_seconds_sum
kdb_ts_summary_seconds_count
kdb_ts_histogram_seconds
kdb_ts_histogram_seconds_sum
kdb_ts_histogram_seconds_count

kdb_ws

Metrics prepended with kdb_ws relate to the websocket messages received by the component container. Note the special kdb_ws_opened_total and kdb_ws_closed_total metrics.

Enable by setting:

handler:
    ws: true

Available metrics:

kdb_ws_total
kdb_ws_err_total
kdb_ws_summary_seconds
kdb_ws_summary_seconds_sum
kdb_ws_summary_seconds_count
kdb_ws_histogram_seconds
kdb_ws_histogram_seconds_sum
kdb_ws_histogram_seconds_count

kxi-controller

Each call to a kxi_controller API endpoint will generate metrics appended with _total and _histogram_seconds, and _failure_total where applicable.

kxi_kxic

Relates to the management of sandboxes from the UI. Available operations are:

kxi_kxic_list
kxi_kxic_create
kxi_kxic_listOne
kxi_kxic_status
kxi_kxic_expiresAfter
kxi_kxic_refresh
kxi_kxic_teardown

kxi_kxic_schema

Relates to the management of schemas from the UI. Available operations are:

kxi_kxic_schema_list
kxi_kxic_schema_create
kxi_kxic_schema_get
kxi_kxic_schema_update
kxi_kxic_schema_delete

kxi_kxic_db

Relates to the management of databases from the UI. Available operations are:

kxi_kxic_db_list
kxi_kxic_db_create
kxi_kxic_db_get
kxi_kxic_db_update
kxi_kxic_db_delete

kxi_kxic_pipeline

Relates to the management of pipelines from the UI. Available operations are:

kxi_kxic_pipeline_list
kxi_kxic_pipeline_create
kxi_kxic_pipeline_get
kxi_kxic_pipeline_update
kxi_kxic_pipeline_delete

kxi_kxic_stream

Relates to the management of streams from the UI. Available operations are:

kxi_kxic_stream_list
kxi_kxic_stream_create
kxi_kxic_stream_get
kxi_kxic_stream_update
kxi_kxic_stream_delete

kxi_kxic_assembly

Relates to the management of assemblies from the UI. Available operations are:

kxi_kxic_assembly_list
kxi_kxic_assembly_create
kxi_kxic_assembly_get
kxi_kxic_assembly_update
kxi_kxic_assembly_delete
kxi_kxic_assembly_deploy
kxi_kxic_assembly_teardown
kxi_kxic_assembly_export

discovery-proxy

Each call to a discovery-proxy API endpoint will generate metrics appended with _total and _histogram_seconds, and _failure_total where applicable. Available operations are:

kxi_sd_register
kxi_sd_updateDetails
kxi_sd_getServices
kxi_sd_heartbeat
kxi_sd_updateStatus
kxi_sd_deregister
kxi_sd_alive
kxi_sd_ready