Cross Service Integration

Find out how to use Cross Service Integration for Public Cloud Databases engines

Last updated October 19th, 2022

Objective

Cross Service Integration allows you to expose your Public Cloud Databases Logs and Metrics.

This guide explains how to use Cross Service Integration.

Out of scope:

  • Expose metrics and logs outside of OVHcloud Public Cloud
  • MongoDB engine is not supported

Requirements

Concept

The Cross Service Integrations for Logs and Metrics allow you for example:

  • To send Redis or MySQL metrics or Cassandra metrics in M3db or PostgreSQL.
  • To send PostgreSQL or MySQL metrics to OpenSearch.
  • To show metrics in Grafana.

For that you need:

  • A source service
  • A destination service

Best practices

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, ...)

Bad practices

Integration matrix

  • All services support logs to opensearch & kafka_logs to kafka.
  • All services except m3db & m3agg support metrics to pg & metrics to m3db.

Other integrations:

source →
↓ destination
grafana m3db kafka
pg dashboard, datasource
opensearch datasource
m3db dashboard, datasource
m3agg m3agg
kmm kafka_mirrormaker
kc kafka_connect

Instructions

Using the OVHcloud Control Panel

Store yours 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:

Service integration

Define the Integration type and the Destination service:

First create a Public Cloud Database for your Destination service via your Control Panel or API.

If you want to store the metrics of your postgresql cluster to m3db, select m3dbMetrics as Integration type and m3db as Destination service, as shown below.

Create integration

Your first integration is ready:

Result

Note that this integration creation has created two users, respectively: metrics_reader and metrics_writer in your engine instance.

Users & Roles

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

Service integration

As you can see, the first integration is referenced.

Define grafanaDashboard as Integration type and the Source service:

Create integration

Your second integration is ready:

Result

Connect to your Grafana instance and browse the dashboards:

Grafana browse Dashboards

Then open your new dashboard:

PostgreSQL Dashboard

Using API

If you are not familiar with using the OVHcloud API, please refer to our guide on First Steps with the OVHcloud APIs.

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:

serviceName

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:

Cluster ID

Get integration capabilities

Get integration capabilities related to your Public Cloud Databases service:

Get Integration Capabilities

Store yours logs or metrics

As a first step, you need to push your metrics or logs somewhere, in order to store them and retrieve the metrics with Grafana.

For that, you need to create a new integration:

Fill in the form with the information corresponding to the type of integration chosen.

Create a new integration

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

Allow metrics visualization into Grafana

Now that metrics are stored somewhere, you need to connect your Public Cloud Databases service to a Grafana service.

For that, first create a Public Cloud Database for Grafana via our Control Panel or API.

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

Get Grafana Dashboard integration capabilitie

Then create a second integration from your Destination service name:

Create Grafana Integration

Connect to your Grafana instance and browse the dashboards:

Grafana browse Dashboards

Then open your new dashboard:

PostgreSQL Dashboard

We want your feedback!

We would love to help answer questions and appreciate any feedback you may have.

Are you on Discord? Connect to our channel at https://discord.gg/ovhcloud and interact directly with the team that builds our databases service!


Did you find this guide useful?

Please feel free to give any suggestions in order to improve this documentation.

Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.

Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.

Thank you. Your feedback has been received.


These guides might also interest you...

OVHcloud Community

Access your community space. Ask questions, search for information, post content, and interact with other OVHcloud Community members.

Discuss with the OVHcloud community

In accordance with the 2006/112/CE Directive, modified on 01/01/2015, prices incl. VAT may vary according to the customer's country of residence
(by default, the prices displayed are inclusive of the UK VAT in force).