---
title: "Databases & Analytics - Set up a service integration"
description: "Learn how to use Cross Service Integration to expose your Cloud Databases or Analytics service's Logs and Metrics."
url: https://docs.us.ovhcloud.com/en/public-cloud/databases/set-up-service-integration
lang: en
---
> For AI agents: the complete documentation index is available at https://docs.us.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.us.ovhcloud.com/en/llms-full.txt.

# Databases & Analytics - Set up a service integration

**Learn how to use Cross Service Integration to expose your Cloud Databases or Analytics service's Logs and Metrics.**

**Warning:**

**Out of scope:**

- Expose metrics and logs outside of OVHcloud Public Cloud
- MongoDB® is not supported

 

## Requirements

- A [Public Cloud project](https://us.ovhcloud.com/public-cloud/) in your OVHcloud account
- A Cloud Database or Analytics service running ([this guide](https://docs.us.ovhcloud.com/en/public-cloud/databases/getting-started.md) can help you to meet this requirement)
- Access to your [OVHcloud Control Panel](https://manager.us.ovhcloud.com/) or the [OVHcloud API](https://api.us.ovhcloud.com/)

 

## Concept

The Cross Service Integrations for Logs and Metrics allow you, for example[\*](#go-further):

- To send Valkey or MySQL® metrics to PostgreSQL®.
- To send PostgreSQL® or MySQL® metrics to OpenSearch™.
- To show metrics in Dashboard.

For that, you need:

- A source service
- A destination service

**Warning:**

**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** | **dashboard**         | **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](https://manager.us.ovhcloud.com/) and open your database instance via the `Public Cloud` and `Databases` menus.

Open the `Integration` tab and click `+ Add an integration`.

Define the **Integration type** and th&#x65;**&#x20;Destination service**:

**Warning:**

**NOTE:** First, create an instance for your _Destination_ (Target) service via your Control Panel or API.

Your first integration is ready:

**Note:**

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 Dashboard

Go to the `Integrations` tab of your **Destination service** and click on `+ Add an integration`.

**Note:**

As you can see, the first integration is referenced.

Define `grafanaDashboard` as the **Integration type** and the **Source service**. Then click `Add`.

Your second integration is ready:

Connect to your Grafana® instance and browse the dashboards:

Then open your new dashboard:

 

### Using API

**Note:**

If you are not familiar with using the OVHcloud API, please refer to our guide on [First Steps with the OVHcloud API](https://docs.us.ovhcloud.com/en/manage-and-operate/api/first-steps.md).

#### 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:

[GET /cloud/project](https://api.us.ovhcloud.com/console/?section=/cloud/project&branch=v1#get-/cloud/project)

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                                                                                                                                       |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Dashboard          | `GET /cloud/project/{serviceName}/database/grafana`          |
| Kafka®             | `GET /cloud/project/{serviceName}/database/kafka`            |
| Kafka® Connect     | `GET /cloud/project/{serviceName}/database/kafkaConnect`     |
| Kafka® MirrorMaker | `GET /cloud/project/{serviceName}/database/kafkaMirrorMaker` |
| MySQL®             | `GET /cloud/project/{serviceName}/database/mysql`            |
| OpenSearch™        | `GET /cloud/project/{serviceName}/database/opensearch`       |
| PostgreSQL®        | `GET /cloud/project/{serviceName}/database/postgresql`       |
| Valkey             | `GET /cloud/project/{serviceName}/database/redis`            |

 

#### Get integration capabilities

Get integration capabilities related to your Cloud Databases or Analytics service:

| Engine             | API call                                                                                                                                                                              |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Dashboard          | `GET /cloud/project/{serviceName}/database/grafana/{clusterId}/capabilities/integration`          |
| Kafka®             | `GET /cloud/project/{serviceName}/database/kafka/{clusterId}/capabilities/integration`            |
| Kafka® Connect     | `GET /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/integration`     |
| Kafka® MirrorMaker | `GET /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/capabilities/integration` |
| MySQL®             | `GET /cloud/project/{serviceName}/database/mysql/{clusterId}/capabilities/integration`            |
| OpenSearch™        | `GET /cloud/project/{serviceName}/database/opensearch/{clusterId}/capabilities/integration`       |
| PostgreSQL®        | `GET /cloud/project/{serviceName}/database/postgresql/{clusterId}/capabilities/integration`       |
| Valkey             | `GET /cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/integration`            |

 

#### 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 Dashboard.

For that, you need to create a new integration:

| Engine             | API call                                                                                                                                                                  |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Dashboard          | `POST /cloud/project/{serviceName}/database/grafana/{clusterId}/integration`          |
| Kafka®             | `POST /cloud/project/{serviceName}/database/kafka/{clusterId}/integration`            |
| Kafka® Connect     | `POST /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration`     |
| Kafka® MirrorMaker | `POST /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration` |
| MySQL®             | `POST /cloud/project/{serviceName}/database/mysql/{clusterId}/integration`            |
| OpenSearch™        | `POST /cloud/project/{serviceName}/database/opensearch/{clusterId}/integration`       |
| PostgreSQL®        | `POST /cloud/project/{serviceName}/database/postgresql/{clusterId}/integration`       |
| Valkey             | `POST /cloud/project/{serviceName}/database/redis/{clusterId}/integration`            |

The `destionationServiceId` and the `sourceServiceId` correspond to the destination cluster ID and the source cluster ID.

 

#### Allow metrics visualization into Dashboard

Now that metrics are stored somewhere, you need to connect your Cloud Database or Analytics service to a Dashboard service.

For that, create an instance for Dashboard via our Control Panel or API.

Once done, get the `GrafanaDashboard` integration capability related to the destination service:

| Engine             | API call                                                                                                                                                         |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Dashboard          | `GET /cloud/project/{serviceName}/database/grafana/{clusterId}/integration`          |
| Kafka®             | `GET /cloud/project/{serviceName}/database/kafka/{clusterId}/integration`            |
| Kafka® Connect     | `GET /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration`     |
| Kafka® MirrorMaker | `GET /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration` |
| MySQL®             | `GET /cloud/project/{serviceName}/database/mysql/{clusterId}/integration`            |
| OpenSearch™        | `GET /cloud/project/{serviceName}/database/opensearch/{clusterId}/integration`       |
| PostgreSQL®        | `GET /cloud/project/{serviceName}/database/postgresql/{clusterId}/integration`       |
| Valkey             | `GET /cloud/project/{serviceName}/database/redis/{clusterId}/integration`            |

Then create a second integration from your _Destination_ service name:

| Engine             | API call                                                                                                                                                                  |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Dashboard          | `POST /cloud/project/{serviceName}/database/grafana/{clusterId}/integration`          |
| Kafka®             | `POST /cloud/project/{serviceName}/database/kafka/{clusterId}/integration`            |
| Kafka® Connect     | `POST /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration`     |
| Kafka® MirrorMaker | `POST /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration` |
| MySQL®             | `POST /cloud/project/{serviceName}/database/mysql/{clusterId}/integration`            |
| OpenSearch™        | `POST /cloud/project/{serviceName}/database/opensearch/{clusterId}/integration`       |
| PostgreSQL®        | `POST /cloud/project/{serviceName}/database/postgresql/{clusterId}/integration`       |
| Valkey             | `POST /cloud/project/{serviceName}/database/redis/{clusterId}/integration`            |

Connect to your Grafana® instance and browse the dashboards:

Then open your new dashboard:

 

## Go further

Browse all the [Databases guides](https://docs.us.ovhcloud.com/en/public-cloud/databases/landing-page-databases.md).

Browse the rest of the [OVHcloud US documentation](https://docs.us.ovhcloud.com/en/index.md) for guides on our other products and services.

Learn more about [Managed Databases](https://us.ovhcloud.com/public-cloud/databases/) on the OVHcloud US website.

OVHcloud Managed Databases and Analytics:

- Grafana® is a registered trademark of Grafana Labs and is used with the permission of Grafana Labs. OVH SAS and its subsidiaries are not affiliated with or endorsed by Grafana Labs.
- Kafka® is a registered trademark of The Apache Software Foundation and has been licensed for use by OVHcloud, who has no affiliation with and is not endorsed by The Apache Software Foundation.
- MongoDB® is a registered trademark of MongoDB, Inc.
- MySQL® is a registered trademark of Oracle and/or its affiliates.
- PostgreSQL® is a registered trademark of the PostgreSQL Community Association of Canada.
