How to set up Digibee API metrics with Prometheus
Learn how to integrate API metrics.
Last updated
Was this helpful?
Learn how to integrate API metrics.
Last updated
Was this helpful?
Prometheus is a monitoring platform that provides comprehensive insight into the performance and health of various aspects of an organization’s IT infrastructure, applications, and services.
The feature must be enabled for your realm.
Username, Password and API Key generated on the menu.
Connection between your Prometheus and the Digibee Integration Platform cluster.
In your , add a job configuration as demonstrated below:
The ENVIRONMENT variable is NOT used for VPN metrics.
#
Variable name
Description
1
HOST
HOST from the URL generated on the APIs credentials page after setting up a credential.eg: core.godigibee.io
2
REALM
Your realm’s name.
3
ENVIRONMENT
Environment to collect metrics from.
4
DIGIBEE_SERVICES_API_APIKEY
Generated after setting up a username and password on the Digibee APIs menu
5
DIGIBEE_SERVICES_API_USERNAME
Username created/configured on the Digibee APIs menu.
6
DIGIBEE_SERVICES_API_PASSWORD
Password created/configured on the Digibee APIs menu.
7
METRIC_NAME
List of metric names (one per line) according to the table below.
jvm_memory_bytes_committed
Committed (bytes) of a given JVM memory area.
Gauge
jvm_memory_bytes_init
Initial bytes of a given JVM memory area.
Gauge
jvm_memory_bytes_max
Maximum (bytes) of a given JVM memory area.
Gauge
jvm_memory_bytes_used
Used bytes of a given JVM memory area.
Gauge
jvm_memory_pool_bytes_committed
Committed bytes of a given JVM memory pool.
Gauge
jvm_memory_pool_bytes_init
Initial bytes of a given JVM memory pool.
Gauge
jvm_memory_pool_bytes_max
Maximum bytes of a given JVM memory pool.
Gauge
jvm_memory_pool_bytes_used
Used bytes of a given JVM memory pool.
Gauge
pipeline_all_hung
Boolean indicating if all pipeline consumers are hung.
Gauge
pipeline_cached_bytes
Total cached bytes.
Summary
pipeline_component_executions_total
The total number of executions per component.
Counter
pipeline_component_processi_latency_seconds
Component processing latency in seconds.
Summary
pipeline_inflight
Number of currently running (inflight) pipelines.
Gauge
pipeline_inflight_reported_by_camel
Number of currently running (inflight) pipelines reported by Camel.
Gauge
pipeline_jvm_memory_bytes_max
Maximum (bytes) of a given JVM memory area.
Gauge
pipeline_jvm_memory_bytes_used
Used bytes of a given JVM memory area.
Gauge
pipeline_message_error_rate_in_sec
Message error rate per seconds (integer number).
Gauge
pipeline_message_monitoring_processor_latency_seconds
Message monitoring processor latency in seconds.
Summary
pipeline_message_processing_latency_seconds
Duration that a message is executed within a replica (Pipeline response time).
Summary
pipeline_message_rate_in_sec
Message rate per seconds (integer number).
Gauge
pipeline_message_size_bytes
Message size in bytes.
Summary
pipeline_process_cpu_seconds_total
Total user and system CPU time spent in seconds.
Counter
pipeline_redeliveries
Total number of messages redelivered.
Counter
pipeline_message_size_bytes
Message size in bytes.
Summary
pipeline_process_cpu_seconds_total
Total user and system CPU time spent in seconds.
Counter
rabbitmq_queue_messages
Number of messages in the queue in a given time.
Gauge
ipsec_tunnel_bytes_in
Total amount of data received through the tunnel in bytes.
Counter
ipsec_tunnel_bytes_out
Total amount of data sent through the tunnel in bytes.
Counter
ipsec_tunnel_nat_status
Indicates the status of Network Address Translation (NAT).
Gauge
ipsec_tunnel_status
Current tunnel status (up or down).
Gauge
ipsec_tunnel_status_last_run
Timestamp of the last execution of the tunnel status check
Counter
ipsec_tunnel_vpncheck_status
Indicates the status of the service that collects VPN metrics.
Gauge
Add your username using the format: <realm>-<username>, as shown in .