Surveiller votre Load Balancer Public Cloud avec Prometheus

Objectif

Le Load Balancer Public Cloud peut être surveillé de 2 façons. Vous pouvez soit interroger une API pour obtenir des statistiques d'utilisation, soit configurer un listener Prometheus pouvant être scrapé par votre infrastructure Prometheus pour collecter des métriques.

Ce guide vous explique comment surveiller votre Load Balancer Octavia à l'aide de ces deux méthodes.

Prérequis

• Un Load Balancer créé. Si ce n'est pas le cas, consultez le guide « Premiers pas avec le service Load Balancer pour Public Cloud ».

Accès à l'espace client OVHcloud

• Lien direct : Projets Public Cloud
• Pour accéder à vos services : Public Cloud > Sélectionnez votre projet

Instructions

Surveillance via CLI

Le service Load Balancer agrège ces statistiques et les met à disposition via l'API OpenStack. Ces statistiques sont disponibles au niveau du Load Balancer ou du listener.

Les statistiques du Load Balancer peuvent être interrogées via le Client OpenStack. Elles incluent les métriques de tous les listeners configurés pour le Load Balancer interrogé.

$ openstack loadbalancer stats show <lb id>

+--------------------+-----------+
| Field              | Value     |
+--------------------+-----------+
| active_connections | 0         |
| bytes_in           | 2236722   |
| bytes_out          | 100973832 |
| request_errors     | 0         |
| total_connections  | 3606      |
+--------------------+-----------+

Les statistiques d'un listener individuel peuvent également être interrogées via le Client OpenStack.

$ openstack loadbalancer listener stats show <listener id>

+--------------------+-------+
| Field              | Value |
+--------------------+-------+
| active_connections | 0     |
| bytes_in           | 89    |
| bytes_out          | 237   |
| request_errors     | 0     |
| total_connections  | 1     |
+--------------------+-------+

Surveillance avec Prometheus

Pour ajouter un endpoint Prometheus sur un Load Balancer Public Cloud, créez un listener avec le protocole PROMETHEUS. Cela activera l'endpoint /metrics qui, par défaut, écoute sur toutes les interfaces de votre Load Balancer. Si votre Load Balancer utilise une Floating IP, l'endpoint /metrics sera par défaut ouvert sur Internet. Pour éviter cela, nous recommandons de définir l'option allowed_cidrs afin de protéger vos métriques, par exemple avec le CIDR du sous-réseau où le Load Balancer est déployé.

Ce type de listener offre les mêmes fonctionnalités que les listeners « classiques » mais ne prend pas en charge l'association de pools ni de politiques L7. Toutes les métriques sont identifiées par l'ID d'objet Octavia (UUID) des ressources.

Créer un listener Prometheus

Espace client OVHcloud

API OVHcloud

Horizon

CLI OpenStack

Terraform

Warning

L'option allowed_cidrs n'est pas encore disponible dans l'espace client OVHcloud : vous pouvez créer le listener ici, mais pour restreindre l'accès à l'endpoint de métriques, définissez allowed_cidrs via l'API OVHcloud, la CLI OpenStack ou Horizon.

Dans la catégorie Network, sélectionnez Load Balancer. Une page listant les Load Balancers s'affiche.

Cliquez sur le nom du Load Balancer.

La page de détails du Load Balancer s'affiche. Cliquez sur l'onglet Listeners puis sur Ajouter un listener.

Dans le formulaire :

• Renseignez le Nom.
• Sélectionnez prometheus comme Protocole.
• Choisissez un port (différent des ports déjà utilisés par les listeners existants de votre Load Balancer).

Le pool par défaut est grisé car le listener prometheus ne nécessite pas de pool, contrairement aux autres types de listeners.

Cliquez sur Ajouter pour déclencher la création du listener. Le nouveau listener apparaît dans la liste.

Vous pouvez créer le listener Prometheus directement via l'API OVHcloud, ce qui permet de définir allowedCidrs dès la création :

🇪🇺EU▾

POST/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener

Dans les paramètres de chemin, serviceName correspond à l'ID de votre projet Public Cloud et regionName à la région de votre Load Balancer (par exemple GRA11). Dans le corps de la requête, définissez protocol sur prometheus, choisissez un port, indiquez votre loadbalancerId, et renseignez allowedCidrs avec les sous-réseaux autorisés à joindre l'endpoint de métriques (par exemple ["192.0.2.0/24"]).

Pour modifier les CIDR autorisés sur un listener existant, utilisez la même propriété allowedCidrs sur l'endpoint de mise à jour, où listenerId est l'ID du listener existant :

🇪🇺EU▾

PUT/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener/{listenerId}

Connectez-vous à Horizon en suivant le guide « Présentation de Horizon ».

Cliquez sur Réseau puis sur Load Balancers. La liste des Load Balancers s'affiche.

Cliquez sur le nom du Load Balancer. La page de détails du Load Balancer s'affiche.

Cliquez sur l'onglet Listeners puis sur Créer un Listener.

Dans la page de création du listener, renseignez le Nom et passez le Protocole à PROMETHEUS. Le port sera prédéfini, modifiez-le si nécessaire.

Vous pouvez également renseigner le champ Allowed CIDRs pour restreindre l'accès à l'endpoint de métriques. Entrez le CIDR du sous-réseau où s'exécute votre scraper Prometheus (ex. 192.0.2.0/24). Laissez-le vide uniquement si votre Load Balancer n'utilise pas de Floating IP.

Pour créer un endpoint Prometheus sur le port 9100 pour le Load Balancer lb1, exécutez la commande suivante :

$ openstack loadbalancer listener create --name stats-listener --protocol PROMETHEUS --protocol-port 9100 lb1

+-----------------------------+--------------------------------------+
| Field                       | Value                                |
+-----------------------------+--------------------------------------+
| admin_state_up              | True                                 |
| connection_limit            | -1                                   |
| created_at                  | 2023-11-30T01:44:25                  |
| default_pool_id             | None                                 |
| default_tls_container_ref   | None                                 |
| description                 |                                      |
| id                          | fb57d764-470a-4b6b-8820-627452f55b96 |
| insert_headers              | None                                 |
| l7policies                  |                                      |
| loadbalancers               | b081ed89-f6f8-48cb-a498-5e12705e2cf9 |
| name                        | stats-listener                       |
| operating_status            | OFFLINE                              |
| project_id                  | 4c1caeee063747f8878f007d1a323b2f     |
| protocol                    | PROMETHEUS                           |
| protocol_port               | 9100                                 |
| provisioning_status         | PENDING_CREATE                       |
| sni_container_refs          | []                                   |
| timeout_client_data         | 50000                                |
| timeout_member_connect      | 5000                                 |
| timeout_member_data         | 50000                                |
| timeout_tcp_inspect         | 0                                    |
| updated_at                  | None                                 |
| client_ca_tls_container_ref | None                                 |
| client_authentication       | NONE                                 |
| client_crl_container_ref    | None                                 |
| allowed_cidrs               | None                                 |
| tls_ciphers                 | None                                 |
| tls_versions                | None                                 |
| alpn_protocols              | None                                 |
| tags                        |                                      |
+-----------------------------+--------------------------------------+

Pour restreindre l'accès à l'endpoint de métriques à un sous-réseau spécifique, ajoutez l'option --allowed-cidr à la commande ci-dessus :

$ openstack loadbalancer listener create --name stats-listener --protocol PROMETHEUS --protocol-port 9100 --allowed-cidr 192.0.2.0/24 lb1

Remplacez 192.0.2.0/24 par le CIDR du sous-réseau où s'exécute votre scraper Prometheus. Vous pouvez répéter l'option pour autoriser plusieurs CIDRs.

La ressource openstack_lb_listener_v2 du provider OpenStack permet de configurer un listener Prometheus. L'extrait suivant est tiré d'un exemple complet disponible sur Github, adaptez-le à vos besoins.

resource "openstack_lb_listener_v2" "prom_listener" {
  protocol        = "PROMETHEUS"
  protocol_port   = 9100
  loadbalancer_id = openstack_lb_loadbalancer_v2.tf_lb.id
  #restreindre l'accès du listener au sous-réseau privé
  allowed_cidrs = [openstack_networking_subnet_v2.tf_lb_subnet.cidr]
}

Configurer Prometheus pour collecter vos métriques

Une fois le listener PROMETHEUS à l'état ACTIVE, vous pouvez configurer Prometheus pour collecter les métriques du Load Balancer en mettant à jour le fichier prometheus.yml.

[scrape_configs]
- job_name: 'Octavia LB1'
  static_configs:
  - targets: ['192.0.2.10:9100']

Pour plus d'informations sur la configuration de Prometheus, consultez le site du projet Prometheus.

Vous pouvez connecter Grafana à l'instance Prometheus pour obtenir des capacités graphiques et de tableau de bord supplémentaires. Un tableau de bord Grafana pour les Load Balancers Octavia est disponible ici.

Les métriques ont le format de nommage suivant :

• Les métriques octavia_loadbalancer_xxx ou octavia_memory_pool_xxx sont globales au Load Balancer
• Les métriques octavia_listener_xxx sont instanciées par listener via le label {listener=ID}
• Les métriques octavia_pool_xxx sont instanciées par pool via le label {pool=ID}
• Les métriques octavia_member_xxx sont instanciées par membre via le label {member=ID}

Aller plus loin

Si vous souhaitez automatiser ce scénario avec Terraform et notre service Grafana managé, vous trouverez un exemple prêt à l'emploi sur ce dépôt Github.

Rejoignez notre canal Discord dédié : https://discord.gg/ovhcloud. Posez vos questions, donnez votre avis et échangez directement avec l'équipe qui développe nos services de bases de données.

Si vous avez besoin d'une formation ou d'une assistance technique pour mettre en œuvre nos solutions, contactez votre commercial ou consultez notre page Services Professionnels pour obtenir un devis et demander une analyse personnalisée de votre projet par nos experts.

Rejoignez notre communauté d'utilisateurs.