OpenTelemetry Support
Foglight Cloud allows database and query insights data to be exported via an OpenTelemetry compatible API. To configure the export of metrics through the OpenTelemetry API, please contact Quest Support.
This section covers the following key areas:
- Configuring OpenTelemetry Export
- Configuring OpenTelemetry tools to read the metrics
- Supported Metrics to export
Configuring OpenTelemetry Export
To configure the export of metrics through the OpenTelemetry API, please contact Quest Support.
Configuring OpenTelemetry tools to read the metrics
The Foglight Cloud exposes an endpoint that allows you to read OpenTelemetry metrics. To ingest these metrics, configure your tools to invoke the API and use the generated authentication token to authorize the request.
The tools need to be configured to invoke the https://<FOGLIGHT_HOST_NAME>:<FOGLIGHT_PORT>/api/v1/open-telemetry/metrics URL. Authorize the request using the generated authentication token:
- If the tool supports custom HTTP headers in the request, add an Auth-Token header with the generated token.
- Alternatively, configure the tool to add the Auth-Token query parameter to the URL with the generated value. For example, https://<FOGLIGHT_HOST_NAME>:<FOGLIGHT_PORT>/api/v1/open-telemetry/metrics?Auth-Token=…
The tool should be configured to invoke the API with a period of one minute or greater.
Supported Metrics to export
Database Global View Data
The export contains the following metrics:
| Metric | Description |
|---|---|
| instance_data_total_health | The overall health of the instance reported as an enumeration: 0 = Normal 1 = Informational 2 = Warning 3 = Critical 4 = Fatal -1= Unknown |
| instance_data_database_health | The health of the database. |
| instance_data_system_health | The health of the system. |
| instance_data_database_up_since | The time since the database was up reported in milliseconds since epoch. |
| instance_data_workload | The instance workload. |
| instance_data_cpu_utilization | The CPU utilization of the instance. |
| instance_data_memory_utilization | The memory utilization of the instance. |
| instance_data_disk_utilization | The disk utilization of the instance. |
| instance_data_instance_num_warning_alarms | The number of alarms of warning severity reported for the instance. |
| instance_data_instance_num_critical_alarms | The number of alarms of critical severity reported for the instance. |
| instance_data_instance_num_fatal_alarms | The number of alarms of fatal severity reported for the instance. |
| instance_data_host_num_warning_alarms | The number of alarms of warning severity reported for the host. |
| instance_data_host_num_critical_alarms | The number of alarms of critical severity reported for the host. |
| instance_data_host_num_fatal_alarms | The number of alarms of fatal severity reported for the host. |
The metrics have the following labels attached:
| Label | Description |
|---|---|
| cluster_identifier_agent_name | The name of the Foglight agent that is monitoring the instance. |
| cluster_identifier_database_type | The type of database being monitored. |
| cluster_identifier_is_clustered | A flag indicating whether the instance is running as part of a cluster. |
| instance_identifier_host_name | The host name on which the database instance is running. |
| instance_identifier_instance_name | The name of the database instance. |
| instance_identifier_port | The port used by the database instance. |
Query Insights Data
The export contains the following metrics:
| Metric | Description |
|---|---|
| sql_elapsed_time | The statement elapsed time (in milliseconds). |
| sql_executions | The number of executions. |
| sql_response_time | The statement response time (in milliseconds). |
| sql_instance_impact | The statement impact on instance (percent). |
The metrics have the following common labels:
| Label | Description |
|---|---|
| sql_domain | The domain, or database type, that the statement relates to (e.g. “SQL Server”). |
| sql_id | A short identifier for the statement. |
| sql_text | The statement text. Longer statements will be truncated. |
The metrics have additional labels that are specific to a particular domain.
