Learn how to use Cross Service Integration to expose your Cloud Databases or Analytics service's Logs and Metrics.
Out of scope:
- Expose metrics and logs outside of OVHcloud Public Cloud
- MongoDB is not supported
Requirements
- A Public Cloud project in your OVHcloud account
- A Cloud Database or Analytics service running (this guide can help you to meet this requirement)
- Access to your OVHcloud Control Panel or the OVHcloud API
Concept
The Cross Service Integrations for Logs and Metrics allow you for example:
- To send Caching or MySQL metrics or Cassandra metrics in PostgreSQL.
- To send PostgreSQL or MySQL metrics to OpenSearch.
- To show metrics in Grafana®. 1
For that you need:
- A source service
- A destination service
NOTE: Although it is possible to define the same cluster as destination service and source service, this is a bad practice for multiple reasons (performance, security, resiliency, etc.).
Integration matrix
- All services support logs to OpenSearch & kafka_logs to kafka.
- All services support metrics to pg.
Other integrations:
|
source → ↓ destination |
grafana® | kafka |
| pg | dashboard, datasource | |
| opensearch | datasource | |
| kmm | kafka_mirrormaker | |
| kc | kafka_connect |
Instructions
Using the OVHcloud Control Panel
Store your logs or metrics
Log in to your OVHcloud Control Panel and open your Public Cloud project. Click on Databases in the left-hand navigation bar, select your engine instance, and open the Service integration tab.
Click on Add an integration:
Define the Integration type and the Destination service:
NOTE: First, create an instance for your Destination (Target) service via your Control Panel or API.
If you want to store the metrics of your postgresql cluster to m3db, select m3dbMetrics as the Integration type and your M3db service as the Destination (Target) service, as shown below. Then click Confirm.
Your first integration is ready:
This integration creation may have created two users, respectively: metrics_reader and metrics_writer in your engine instance.
Don't delete them.
Allow metrics visualization into Grafana®
Go to the Service integration tab of your Destination service service and click on Add an integration.
As you can see, the first integration is referenced.
Define grafanaDashboard as the Integration type and the Source service. Then click Confirm.
Your second integration is ready:
Connect to your Grafana® instance and browse the dashboards:
Then open your new dashboard:
Using API
If you are not familiar with using the OVHcloud API, please refer to our guide on First Steps with the OVHcloud API.
Get your service and cluster IDs
You first need to identify your serviceId and your clusterId.
Get the desired service ID
Execute the following API call:
From the resulting list, select and copy the service identifier corresponding to the desired service, also known as serviceName.
Get the desired cluster ID
Open the following API call, paste your service ID into the serviceName input field, and click Execute:
| Engine | API call |
|---|---|
| Cassandra | |
| Grafana® | |
| Kafka | |
| Kafka Connect | |
| Kafka MirrorMaker | |
| MySQL | |
| OpenSearch | |
| PostgreSQL | |
| Redis (Caching) |
Get integration capabilities
Get integration capabilities related to your Cloud Databases or Analytics service:
| Engine | API call |
|---|---|
| Cassandra | |
| Grafana® | |
| Kafka | |
| Kafka Connect | |
| Kafka MirrorMaker | |
| MySQL | |
| OpenSearch | |
| PostgreSQL | |
| Redis (Caching) |
Store your logs or metrics
As a first step, you need to push your metrics or logs somewhere, to store them and retrieve the metrics with Grafana®.
For that, you need to create a new integration:
| Engine | API call |
|---|---|
| Cassandra | |
| Grafana® | |
| Kafka | |
| Kafka Connect | |
| Kafka MirrorMaker | |
| MySQL | |
| OpenSearch | |
| PostgreSQL | |
| Redis (Caching) |
The destionationServiceId and the sourceServiceId correspond to the destination cluster ID and the source cluster ID.
Allow metrics visualization into Grafana®
Now that metrics are stored somewhere, you need to connect your Cloud Database or Analytics service to a Grafana® service.
For that, create an instance for Grafana® via our Control Panel or API.
Once done, get the GrafanaDashboard integration capability related to the destination service:
| Engine | API call |
|---|---|
| Cassandra | |
| Grafana® | |
| Kafka | |
| Kafka Connect | |
| Kafka MirrorMaker | |
| MySQL | |
| OpenSearch | |
| PostgreSQL | |
| Redis (Caching) |
Then create a second integration from your Destination service name:
| Engine | API call |
|---|---|
| Cassandra | |
| Grafana® | |
| Kafka | |
| Kafka Connect | |
| Kafka MirrorMaker | |
| MySQL | |
| OpenSearch | |
| PostgreSQL | |
| Redis (Caching) |
Connect to your Grafana® instance and browse the dashboards:
Then open your new dashboard:
Go further
For more information and tutorials, please see our other Managed Databases & Analytics or Platform as a Service guides. You can also explore the guides for other OVHcloud products and services.
[1]: The Grafana Labs Marks are trademarks of Grafana Labs, and are used with Grafana Labs’ permission. We are not affiliated with, endorsed or sponsored by Grafana Labs or its affiliates.