OVH Guide

Récupérer les métriques d’un SQL Privé sur Grafana

Récupérer les métriques d’un SQL Privé sur Grafana

  • sql privé
  • private sql
  • metrics
  • métriques
  • métrique
  • grafana
  • ram

Qu'est ce que Docker ?

Docker est un logiciel libre qui automatise le déploiement d'applications dans des conteneurs logiciels.

Qu'est ce que Grafana ?

Grafana est une solution open-source permettant de mettre en forme des données sous forme de graphique par exemple.

Une instance

Pour installer Grafana, il sera nécessaire d'utiliser Docker. Celui-ci pourra être installé sur différents produits proposés par OVH :

Docker

Comment l'installer ?

En fonction de votre machine, vous pouvez suivre la documentation accessible via ce lien pour l'installer.

Sur un VPS

Si vous disposez d'un VPS chez OVH, vous pouvez choisir d'installer la distribution "Docker on Ubuntu" qui vous permettra de disposer d'un serveur disposant déjà de Docker.

Grafana

Installer Grafana sur Docker

Si vous souhaitez utiliser Grafana sur le port 80 de votre serveur, il vous suffit d'utiliser la commande suivante :

docker run -i -p 80:3000 grafana/grafana

Vous retrouverez plus d'informations sur ce lien. Vous pouvez installer Grafana sans Docker, vous pouvez pour cela vous rendre sur cette documentation.

Un serveur SQL Privé

Type de SQL Privé

Votre serveur SQL Privé doit être de type "Docker" pour récupérer des métriques.

Activation gratuite sur les hébergements Performance

Si vous disposez d'un hébergement performance, vous pouvez activer un serveur SQL Privé gratuitement en vous aidant du guide suivant.

Commander un serveur SQL Privé

Vous pouvez commander un serveur SQL Privé directement dans votre espace client.

  • Tous les nouveaux serveurs SQL Privé mis en place sont de type "Docker".

Mon serveur SQL Privé est-il de type "Legacy" ou "Docker" ?

Les anciens serveurs SQL Privé sont de type "Legacy" (exemple : sqlprive-kx11111-009), les nouveaux sont de type "Docker" (exemple : sx11111-012). Il s'agit de deux infrastructures différentes.

Obtenir le token via l'API OVH

Se connecter à l'API OVH

Pour vous connecter à l'API OVH, veuillez vous rendre sur le lien suivant puis cliquer sur "Login" afin de vous connecter.

https://api.ovh.com/console/

Récupérer le token

Il faut utiliser la fonction suivante pour récupérer la liste des serveurs SQL Privé présents sur votre compte puis cliquer sur "Execute" :

/hosting/privateDatabase

Renseigner via la fonction suivante le nom de votre serveur SQL Privé de type "Docker" :

/hosting/privateDatabase/{serviceName}

Vous retrouverez dans "graphEndpoint" les deux informations nécessaires :

  • readToken
  • host

Utiliser Grafana

Connexion à votre Grafana

Accéder à votre Grafana via votre navigateur, les identifiants par défaut sont :

  • admin / admin

Ajouter votre source de données

Il faut pour cela cliquer sur "Data Sources" dans la colonne de gauche puis en haut sur "Add new".

Remplissez les informations suivantes :

  • Name : le nom de votre source de données, dans notre cas je la nommerai "private SQL".
  • Default : Oui
  • Type : "OpenTSDB"
  • URL : renseigner ici le contenu du champs "host" récupéré précédemment dans l'API OVH
  • Access : "proxy"
  • Http Auth : Cochez "Basic Auth", décochez "With Credentials"
  • User : renseignez ici le contenu du champs "readToken" récupéré précédemment dans l'API OVH
  • Password : renseignez également ici le contenu du champs "readToken" récupéré précédemment dans l'API OVH

Réalisez un test de connexion et si celui-ci est concluant, ajouter la source de données.

Configurer votre "Dashboard"

Cliquez dans la colonne de gauche sur "Dahboards", cliquez en haut sur "Home" puis sur "New".

  • Vous obtenez de cette manière un tableau de bord vierge que vous pouvez renommer en cliquant sur l'icône "Manage Dashboard" puis "Settings".
  • Vous pouvez à tout moment sauvegarder votre tableau de bord en cliquant sur l'icône de "Disquette" en haut.

Un tableau de bord est composée de ligne ("Row"), pour ajouter le premier graphique, cliquez sur le bouton vert, puis sur "Add Panel" et "Graph".

Dans l'onglet "General", renseigner le titre de votre graphique, pour cet exemple nous le nommerons "RAM".

  • Dans l'onglet "Metrics", vérifiez dans un premier temps que votre source de données soit bien sélectionnée en bas à droite.

La première métrique à renseigner est "memory.hierarchical_memory_limit", cela correspond à la RAM maximum allouée à votre serveur SQL Privé.

Cliquez ensuite sur "+ Query" pour ajouter la seconde métrique "memory.rss", celle-ci correspond à la RAM utilisée par votre serveur.

Dans l'onglet "Axes & Grid", sélectionnez dans "Left Y" l'unité ""data" puis "Bytes"

  • Choisissez en haut à droite l'intervalle de temps à observer, voici le rendu obtenu sur les 60 derniers jours.

Les métriques

Voici 3 exemples de métriques pertinentes pour suivre vos performances sur votre SQL Privé :

|RAM Maximum utilisable|memory.hierarchical_memory_limit| |RAM Utilisée|memory.rss| |Nombre de connexions MySQL actives|mysql.active_connections|

Vous retrouverez sur le lien suivant la documentation officielle sur les métriques Docker :