The Hydrolix stack includes Prometheus, an open-source metrics database. While the Stack runs, Hydrolix continuously updates its Prometheus instance with metrics information.

Using Prometheus directly

Prometheus has its own web-based UI, available by visiting https://<YourHostname/prometheus in your web browser.

This view is a basic metric view, suitable for quickly entering queries and seeing simple, graphed results. Hydrolix does make this feature available immediately, without any additional setup.

For more information about metric types, refer to Prometheus's documentation.

Hydrolix's metrics

If more than one component uses a given metric, then querying it will return results from all relevant components. You can restrict results to a specific component by adding a service keyword to your query, e.g. "process_open_fds{service="stream-peer"}".

Each of the Ingest method peers has multiple containers. One container that will do message acquisition and the other is the indexer which will index and complete enrichment jobs.

HTTP Stream Ingest

These metrics are specific to the use of streaming data sources.

Traefik

Metric	Type	Components	Purpose
`traefik_service_requests_total`	Counter	Traefik	HTTP Traefik request information.
`traefik_service_request_duration_seconds_count/sum/bucket`	Counter	Traefik	Response time of traefik to client.
`http_source_request_duration_ns_count/sum/bucket`	Counter	Traefik	Response time from Stream-Head.

Stream-Head

Metric	Type	Components	Purpose
`http_source_byte_count`	Counter	Stream head	Count of bytes processed.
`http_source_request_count`	Counter	Stream head	Count of http requests.
`http_source_request_duration_ns_count/bucket/sum`	Histogram	Stream head	A histogram of HTTP request durations in nanoseconds.
`http_source_request_error_count`	Counter	Stream head	Count of http request failures.
`http_source_row_count`	Counter	Stream head	Count of rows processed.
`http_source_value_count`	Counter	Stream head	Count of values processed.

RedPanda

Metric	Type	Components	Purpose
`internal_event_queue_byte_count{mode="sink"}`	Counter	Stream Head	Row Count sent to RedPanda
`internal_event_queue_row_count{mode="sink""}`	Counter	Stream Head	Row Count sent to RedPanda
`internal_event_queue_value_count{mode="sink""}`	Counter	Stream Head	Row Count sent to RedPanda
`internal_event_queue_row_count{mode="source"}`	Counter	Stream Peer	Row Count received from RedPanda
`internal_event_queue_value_count{mode="source"}`	Counter	Stream Peer	Value Count recieved from RedPanda

Stream-Peer

Metric	Type	Components	Purpose
`query_count`	Counter	Stream Peer	Count of calls to the Catalog.
`query_failure`	Counter	Stream Peer	Count of failed Catalog calls.
`query_latency_summary`	Counter	Stream Peer	Latency in calls to catalog.
`query_latency_summary_count/sum`	Count/Sum	Stream Peer	Latency in calls to catalog.

In addition to Stream-Peer metrics Indexer metrics should also be reviewed (below).

Kafka Ingest

These metrics are specific to the use of Kafka data sources.

Metric	Type	Components	Purpose
`kafka_source_byte_count`	Counter	Kafka peer	Count of bytes read from Kafka.
`kafka_source_commit_duration_ns_count/bucket/sum`	Histogram	Kafka peer	Kafka commit duration.
`kafka_source_read_count`	Counter	Kafka peer	Count of Kafka reads.
`kafka_source_read_duration_ns_count/bucket/sum`	Histogram	Kafka peer	Kafka read duration.
`kafka_source_read_error_count`	Counter	Kafka peer	Count of Kafka errors.
`kafka_source_row_count`	Counter	Kafka peer	Count of rows processed.
`kafka_source_value_count`	Counter	Kafka peer	Count of values processed.
`query_count`	Counter	Kafka Peer	Count of calls to the Catalog.
`query_failure`	Counter	Kafka Peer	Count of failed Catalog calls.
`query_latency_summary`	Counter	Kafka Peer	Latency in calls to catalog.
`query_latency_summary_count/sum`	Count/Sum	Kafka Peer	Latency in calls to catalog.

In addition to Kafka-Peer metrics Indexer metrics should also be reviewed (below).

Kinesis Ingest

These metrics are specific to the use of Kinesis data sources.

Metric	Type	Components	Purpose
`kinesis_source_byte_count`	Counter	Kinesis peer	Count of bytes read from Kinesis.
`kinesis_source_checkpoint_count`	Counter	Kinesis peer	Count of Kinesis checkpoint operations.
`kinesis_source_checkpoint_duration_ns_count/bucket/sum`	Histogram	Kinesis peer	Duration of Kinesis checkpoint operations.
`kinesis_source_lag_ms`	Gauge	Kinesis peer	Measure of lag in Kinesis source.
`kinesis_source_operation_count`	Counter	Kinesis peer	Count of operations on Kinesis.
`kinesis_source_operation_duration_ns_count/bucket/sum`	Histogram	Kinesis peer	Histogram of duration of operations on Kinesis.
`kinesis_source_record_count`	Counter	Kinesis peer	Count of records read from Kinesis.
`kinesis_source_row_count`	Counter	Kinesis peer	Count of rows read from Kinesis.
`kinesis_source_value_count`	Counter	Kinesis peer	Count of values read from Kinesis.
`query_count`	Counter	Kinesis Peer	Count of calls to the Catalog.
`query_failure`	Counter	Kinesis Peer	Count of failed Catalog calls.
`query_latency_summary`	Counter	Kinesis Peer	Latency in calls to catalog.
`query_latency_summary_count/sum`	Count/Sum	Kinesis Peer	Latency in calls to catalog.

In addition to Kinesis-Peer metrics Indexer metrics should also be reviewed (below).

Indexer Metrics

Indexer metrics are metrics that cover the indexing and enrichment of data being ingested. These are available across all of the above peer components.

Metric	Type	Components	Purpose
`indexer_rows_written_count/bucket/sum`	Histogram	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP	Total rows indexed (written to partitions)
`indexer_bytes_written_count/bucket/sum`	Histogram	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP	Total bytes indexed (written to partitions)
`indexer_partitions_rejected_count/bucket/sum`	Histogram	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP	Histogram of partitions not able to written. If value is 0=raw data parsing failed, 1=raw data / transform schema mismatch, 3=Error writing partition file, 4= Other Error during indexing
`indexer_partitions_written_count/bucket/sum`	Histogram	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP	Total partitions created
`indexer_partition_write_seconds_count/bucket/sum`	Histogram	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP	Time from receiving indexing query to writing partition file (seconds)
`hdx_sink_row_count`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP	Count of rows processed by the indexer and uploaded to storage. Includes Hot and Cold reporting.
`hdx_sink_byte_count`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP	Count of bytes processed by the indexer and uploaded to storage. Includes Hot and Cold reporting.
`hdx_sink_value_count`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP	Count of values processed by the indexer and uploaded to storage. Includes Hot and Cold reporting.
`hdx_sink_error_count`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP	Count of errors in indexing and uploading to storage.

Storage

Cloud Storage metrics.

Metric	Type	Components	Purpose
`net_http_status_code_bucket`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP	HTTP Status Code histogram count from Storage.

Additional Metrics

Additional Metrics are provided for the management and control of different components.

General Metrics.

These metrics track various counters and statistics regarding data ingestion.

Metric	Type	Components	Purpose
`up`	Counter	All components	How many pods are up for each component
`process_cpu_seconds_total`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Total user and system CPU time spent in seconds.
`process_max_fds`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Maximum number of open file descriptors.
`process_open_fds`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of open file descriptors.
`process_resident_memory_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Resident memory size in bytes.
`process_start_time_seconds`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Start time of the process since unix epoch in seconds.
`process_virtual_memory_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Virtual memory size in bytes.
`process_virtual_memory_max_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Maximum amount of virtual memory available in bytes.
`promhttp_metric_handler_requests_in_flight`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Current number of scrapes being served.
`promhttp_metric_handler_requests_total`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Total number of scrapes by HTTP status code.

Go environment metrics

These metrics track resources used by Hydrolix's Go environments.

Metric	Type	Components	Purpose
`go_gc_duration_seconds`	Summary	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	A summary of the pause duration of garbage collection cycles.
`go_goroutines`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of goroutines that currently exist.
`go_info`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Information about the Go environment.
`go_memstats_alloc_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes allocated and still in use.
`go_memstats_alloc_bytes_total`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Total number of bytes allocated, even if freed.
`go_memstats_buck_hash_sys_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes used by the profiling bucket hash table.
`go_memstats_frees_total`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Total number of frees.
`go_memstats_gc_cpu_fraction`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	The fraction of this program's available CPU time used by the GC since the program started.
`go_memstats_gc_sys_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes used for garbage collection system metadata.
`go_memstats_heap_alloc_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik
`go_memstats_heap_idle_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of heap bytes waiting to be used.
`go_memstats_heap_inuse_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of heap bytes that are in use.
`go_memstats_heap_objects`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of allocated objects.
`go_memstats_heap_released_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of heap bytes released to OS.
`go_memstats_heap_sys_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of heap bytes obtained from system.
`go_memstats_last_gc_time_seconds`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of seconds since 1970 of last garbage collection.
`go_memstats_lookups_total`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Total number of pointer lookups.
`go_memstats_mallocs_total`	Counter	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Total number of mallocs.
`go_memstats_mcache_inuse_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes in use by mcache structures.
`go_memstats_mcache_sys_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes used for mcache structures obtained from system.
`go_memstats_mspan_inuse_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes in use by mspan structures.
`go_memstats_mspan_sys_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes used for mspan structures obtained from system.
`go_memstats_next_gc_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of heap bytes when next garbage collection will take place.
`go_memstats_other_sys_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes used for other system allocations.
`go_memstats_stack_inuse_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes in use by the stack allocator.
`go_memstats_stack_sys_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes obtained from system for stack allocator.
`go_memstats_sys_bytes`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of bytes obtained from system.
`go_threads`	Gauge	Batch (inc. Autoingest), Kafka, Kinesis, Stream HTTP, Traefik	Number of OS threads created.