--- title: Akeyless Gateway description: Track your Akeyless Gateway key metrics. breadcrumbs: Docs > Integrations > Akeyless Gateway --- # Akeyless Gateway Supported OS Integration version1.0.0Akeyless Gateway metrics dashboard ## Overview{% #overview %} The Akeyless Platform is a unified secrets management system that enables you to store, protect, rotate, and dynamically create credentials, certificates, and encryption keys. Our platform supports several use cases, including managing static and dynamic credentials, certificate automation, encryption and digital signing, and zero-trust application access that secures remote access to your internal resources. This integration allows you to visualize and monitor performance of your [Akeyless Gateway](https://docs.akeyless.io/docs/api-gw). Telemetry metrics are sourced from the application and the runtime environment. ## Setup{% #setup %} Akeyless offers a unique Gateway which adds an extra level of protection between your private network and the cloud. Acting as a SaaS extension of our core services, our stateless Gateway enables a transparent internal operation with a robust out-of-the-box mechanism to ensure service continuity and recovery without having to change any network infrastructure in order to work with your internal resources. To configure the integration with Datadog to view important Akeyless Gateway metrics, follow the instructions below for the method you are using (or have used) for your Gateway deployment. ### Prerequisites{% #prerequisites %} - An Akeyless Gateway either running or being deployed for the first time ### Configure{% #configure %} This integration works with one Gateway or multiple instances using the same API key. Metrics can be shown per `host` or `instance` in the **Akeyless GW** dashboard. #### For a Gateway running on Kubernetes{% #for-a-gateway-running-on-kubernetes %} To configure the Akeyless Gateway integration on a [Gateway running on K8s](https://docs.akeyless.io/docs/gateway-k8s): 1. In your `values.yaml` file you use to deploy your Gateway on Kubernetes, under the `metrics` section, add the following configuration. Set the relevant API Key of your Datadog server, and the relevant [Datadog site](https://docs.datadoghq.com/getting_started/site/) such as: `app.datadoghq.com`. ```gdscript3 metrics: enabled: true config: | exporters: datadog: api: key: "" site: service: pipelines: metrics: exporters: [datadog] ``` If you have not yet deployed the Gateway, continue with your installation as usual and run the following command when you are ready to deploy: ``` helm install akeyless/akeyless-api-gateway -f values.yaml ``` If you are updating an existing Gateway on Kubernetes, run the following commands to update: ``` helm upgrade akeyless/akeyless-api-gateway -f values.yaml ``` #### For a standalone Gateway running on Docker{% #for-a-standalone-gateway-running-on-docker %} To configure the Akeyless Gateway integration on a [Standalone Gateway](https://docs.akeyless.io/docs/install-and-configure-the-gateway): 1. Create a local file called `otel-config.yaml` with the following configuration. Set the relevant API Key of your Datadog server, and the relevant [Datadog site](https://docs.datadoghq.com/getting_started/site/) such as `app.datadoghq.com`. ```gdscript3 exporters: datadog: api: key: "" site: service: pipelines: metrics: exporters: [datadog] ``` If you have not yet deployed the Gateway, run the following command to spin up your Akeyless Gateway with the `ENABLE_METRICS=true` variable and mount the `otel-config.yaml` file: ``` docker run -d -p 8000:8000 -p 8200:8200 -p 18888:18888 -p 8080:8080 -p 8081:8081 -p 5696:5696 -e ENABLE_METRICS="true" -v $PWD/otel-config.yaml:/akeyless/otel-config.yaml --name akeyless/base:latest-akeyless ``` If you are updating an existing Gateway, use the same `Admin Access ID` and `Cluster Name` for the updated Gateway in order to retrieve the latest settings and data from the previously removed Docker instance: ``` 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="p-xxxxxx" -e ADMIN_ACCESS_KEY="62Hu...xxx....qlg=" -e ENABLE_METRICS="true" -v $PWD/otel-config.yaml:/akeyless/otel-config.yaml --name akeyless/base:latest-akeyless ``` ### Validation{% #validation %} Upon successful setup of the Gateway, go to the [Metrics Explorer](https://app.datadoghq.com/metric/explorer) on the Datadog site, and filter the Akeyless metrics on the summary page. ## Data Collected{% #data-collected %} ### Metrics{% #metrics %} | | | | | **akeyless.gw.system.cpu**(gauge) | CPU utilization metrics. | | **akeyless.gw.system.disk**(gauge) | Disk I/O metrics. | | **akeyless.gw.system.load**(gauge) | CPU load metrics. | | **akeyless.gw.system.memory**(gauge) | Memory utilization metrics. | | **akeyless.gw.system.network**(gauge) | Network interface I/O metrics and TCP connection metrics. | | **akeyless.gw.quota.current\_transactions\_number**(gauge) | Current transaction number. | | **akeyless.gw.quota.gw\_admin\_client\_transactions**(gauge) | Total transaction by an admin client. | | **akeyless.gw.quota.total\_transactions\_limit**(gauge) | Total transaction limit per hour. | | **akeyless.gw.system.http\_response\_status\_code**(gauge) | Status of the HTTP response. | | **akeyless.gw.system.request\_count**(gauge) | Total number of requests. | | **akeyless.gw.system.healthcheck.status**(gauge) | Monitors container health check status. | ### Service Checks{% #service-checks %} The Akeyless Gateway integration does not include any service checks. ### Events{% #events %} The Akeyless Gateway integration does not include any events. ## Support{% #support %} Need help? Contact [Akeyless Support](mailto:support@akeyless.io).