For Docker Environment
Akeyless Gateway Telemetry Metrics can be consumed by well-known monitoring and alerting solutions, such as Datadog or Prometheus.
The Telemetry Metrics are based on time series telemetry data metrics from the application and the runtime environment, storing them in a unique database or index, and analyzing data trends over time.
The metrics visualization uses a pre-made/custom dashboard (Grafana marketplace dashboard, Datadog integration dashboard, etc.).
The following Metrics are currently available:
|CPU utilization metrics|
|Disk I/O metrics|
|CPU load metrics|
|Memory utilization metrics|
|Network interface I/O metrics & TCP connection metrics|
|Current transaction number|
|Total transaction by an admin client|
|Total transaction limit per hour|
To enable Telemetry Metrics on your Gateway for Datadog, set the
ENABLE_METRICS=true variable and mount the Telemetry config file, i.e.,
otel-config.yaml as described below:
exporters: datadog: api: key: "<Datadog API key>" site: datadoghq.eu # optional. default to Datadog US site when missing site service: pipelines: metrics: exporters: [datadog]
Set the relevant
API Key of your Datadog server, and set the relevant site. If your Datadog server is running in the
EU site, add site:
datadoghq.eu by default is set to the
docker run -d -p 8000:8000 -p 8200:8200 -p 18888:18888 -p 8080:8080 -p 8081:8081 -p 5696:5696 -e ADMIN_ACCESS_ID="Access-id" -e ADMIN_ACCESS_KEY="Access-key" -e ENABLE_METRICS="true" -v $PWD/otel-config.yaml:/akeyless/otel-config.yaml --name akeyless-gateway akeyless/base:latest-akeyless
Download the dashboard JSON file from here.
In the Datadog navigation pane, create a new dashboard, Dashboards > New Dashboards.
Go to settings (on the top right) and choose Import dashboard JSON and select the downloaded
Upon successful setup of the Gateway, navigate to the Datadog platform, and filter the Akeyless metrics on the summary page: https://app.datadoghq.com/metric/summary?filter=akeyless.gw
To enable Telemetry Metrics on your Gateway for Prometheus, set the
ENABLE_METRICS=true variable, expose the port
8889 (or any other port) for Prometheus scraping, and mount the Telemetry config file, i.e.,
otel-config.yaml for the Prometheus Exporter as described below:
exporters: prometheus: endpoint: "0.0.0.0:8889" service: pipelines: metrics: exporters: [prometheus]
Add a scraping target for the Akeyless Gateway container in the Prometheus config file and restart your Prometheus server.
scrape_configs: - job_name: 'akeyless' scrape_interval: 10s static_configs: # docker for linux - targets: ['localhost:8889'] # for docker on macOS use['host.docker.internal:8889']
Run the Gateway installation command:
docker run -d -p 8000:8000 -p 8200:8200 -p 18888:18888 -p 8080:8080 -p 8081:8081 -p 5696:5696 -p 8889:8889 -e ADMIN_ACCESS_ID="Access-id" -e ADMIN_ACCESS_KEY="Access-key" -e ENABLE_METRICS="true" -v $PWD/otel-config.yaml:/akeyless/otel-config.yaml --name akeyless-gateway akeyless/base:latest-akeyless
Once done, check your Prometheus server for the ingested metrics.
You can visualize Akeyless metrics in Grafana Dashboard when using Prometheus as a data source.
Import the Akeykess GW dashboard for your Grafana instance using this link.
Updated 6 days ago