Observability

This section highlights the observability features of the API Gateway. The API Gateway currently supports metrics and logs. When enabled, all logs and metrics are transmitted to our observability system, where they can be queried and analyzed for valuable insights. Central logging must be enabled for this functionality, ensuring effective monitoring and troubleshooting of API traffic. This allows for proactive identification and resolution of potential issues, enhancing overall system performance and reliability.

Accessing Logs & Metrics

Once central logging is enabled, logs from your API Gateway will be sent to the logging service. You can access and analyze these logs and metrics using a dedicated Grafana instance.

Grafana Instance URL

The URL for your Grafana instance is automatically made available when your API is first created. You can retrieve this URL using a GET request from the API Gateway (specific API details will be provided in a separate section). By leveraging central logging and Grafana, you gain valuable insights into your API's performance, identify potential issues, and ensure optimal API health.

Enabling Central Logging

• Requirement: Enabling central logging is mandatory for the API Gateway to send logs.

• Configuration: Send a PUT request to the logging service endpoint to enable central logging. Here's an example using curl:

curl -X "PUT" "https://logging.de-txl.ionos.com/central" \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer TOKEN' \
     -d '{ "properties": { "enabled": true } }'

Note: Enabling central logging incurs additional costs.