Supervision des métriques avec OpenTelemetry

Vous devez d'abord activer le collecteur lorsque l'instance est arrêtée. Pour ce faire, connectez-vous en tant que utilisateur de l'instance via la ligne de commande et utilisez l'instruction « omd config » dans le menu de configuration textuel :

Accédez à Addons et activez l'option « OPENTELEMETRY_COLLECTOR » :

Vous n'avez pas besoin de modifier le port pour la supervision du collecteur, car il est défini sur le prochain port libre à partir de 14317, même si plusieurs instances sont utilisées.

Après avoir activé le collecteur, redémarrez l’instance avec omd start.

Accédez à Setup > Hosts > OpenTelemetry collector (experimental) et commencez à configurer un nouveau collecteur en cliquant sur le bouton « Add OpenTelemetry collector configuration » :

Dans General properties, attribuez un identifiant et un titre au nouveau collecteur. Pour « Site restriction », vous devez déplacer au moins une entrée de la gauche vers la droite. Dans la capture d'écran ci-dessus, l'instance locale mysite est la seule disponible.

Pour garantir la création automatique des hôtes, configurez une nouvelle connexion OpenTelemetry avec la gestion dynamique des hôtes. À titre de préparation — au moins pour les premiers tests —, nous vous recommandons de créer un dossier distinct dans lequel vous stockerez les hôtes OpenTelemetry générés automatiquement.

Pour configurer la nouvelle connexion pour la gestion dynamique des hôtes, accédez à Setup > Hosts > Dynamic host management > Add connection:

Effectuez les réglages suivants dans la case de dialogue « Connection properties » :

Terminez la nouvelle connexion avec Save.

Pour garantir que les services Checkmk soient également générés, au moins une configuration de l’agent spécial OpenTelemetry doit être créée. La règle requise se trouve sous « Setup > Agents > Other integrations > OpenTelemetry (experimental): »

Dans la case « OpenTelemetry (experimental) », décidez si vous souhaitez effectuer la supervision du collecteur OpenTelemetry lui-même — via le port qui s'est affiché lors de l'activation du collecteur.

Dans la condition de la règle, il est évident d’attribuer l’agent spécial au dossier dans lequel les ordinateurs hôtes seront créés automatiquement — dans l’exemple, il s’agit du dossier « OpenTelemetryTest ».

Enregistrez la règle sous le nom Save.

Maintenant que les trois composants — collecteur, gestion dynamique des hôtes et agent spécial — ont été configurés, vous devez activer les modifications en attente.

Vous souhaiterez probablement configurer le collecteur OpenTelemetry pour Checkmk, car quelque part dans votre environnement informatique, un élément génère déjà des métriques OpenTelemetry.

Si ce n’est pas encore le cas, ou si vous souhaitez tester rapidement la configuration d’exemple décrite dans cet article, vous pouvez le faire à l’aide de l’application d’exemple « Hello metric » fournie dans notre dépôt GitHub, qui s’exécute dans un environnement Python virtuel.

Il faut compter environ deux à trois minutes entre le moment où les premières données sont envoyées, la création de l’ordinateur hôte et la détection du service, avant que celui-ci ne devienne visible dans la supervision. L’image suivante montre les services de l’application d’exemple « Hello metric » :

Le nom de domaine hello-metric est généré à partir du nom du service fourni en option dans l’instruction opentelemetry-instrument — exactement comme spécifié dans la configuration du collecteur OpenTelemetry. Le nom du service OTel metric hellolevel dans Checkmk est généré à partir du nom de la métrique, avec le préfixe OTel metric ajouté par l’agent spécial.

Si vous activez l'option Monitor the collector dans la configuration de l'agent spécial, c'est-à-dire la supervision du collecteur, un certain nombre de services supplémentaires seront créés sur l'ordinateur hôte,

L'application d'exemple « Dice Roll » présentée sur le site web d'OpenTelemetry fonctionne de manière très similaire à « Hello métrique ». Cette application d'exemple est à bien des égards plus pratique que « Hello métrique ». Par exemple, « Dice Roll » envoie des métriques OpenTelemetry à chaque fois que le serveur d’application est appelé (et uniquement à ce moment-là !) et utilise le type de données « Compteur ». Vous pouvez utiliser l’environnement Python virtuel créé pour l’exemple « Hello metric » afin d’essayer également l’exemple « Dice Roll ». Cependant, vous devrez également installer le module Python flask (pip install flask) et créer le fichier app.py dans la version étendue avec les métriques, comme décrit dans cette instruction.

Dans l'appel suivant, remplacez le serveur Checkmk en tant que cible (ici 198.51.100.42 avec le port gRPC 4317) :

Votre serveur Flask est désormais prêt et accessible sur le port sélectionné (ici : 8080) pour lancer un dé à chaque appel. Vous pouvez consulter les données du dé, par exemple, via la sortie de curl -v http://localhost:8080/rolldice. Chaque lancer de dé que vous déclenchez de cette manière est transmis à Checkmk sous forme de point de données.

Au bout de quelques minutes, l’ordinateur hôte dice-server apparaîtra dans la supervision avec le service OTel metric dice.rolls. Celui-ci comporte six graphiques, de Value_1__Per_Sec à Value_6__Per_Sec, qui correspondent aux fréquences des chiffres de un à six obtenus jusqu’à présent. La raison de cette conversion est que les métriques OpenTelemetry utilisent des compteurs, qui ne peuvent qu’augmenter — un type de données qui n’est pas pris en charge par Checkmk. Pour un affichage plus clair, Checkmk effectue donc la conversion en tenant compte de la composante temporelle.

La capture d’écran montre l’un de ces graphiques, qui repose sur les appels à /rolldice effectués une fois par seconde au cours de la période de supervision.

Vous pouvez définir des valeurs seuils et d’autres paramètres pour les services à l’aide de la règle Setup > Services > Service monitoring rules > OpenTelemetry (experimental). Vous pouvez ici définir des règles pour des métriques individuelles ou pour toutes les métriques d’un service. La capture d’écran d’exemple montre la sélection du compteur pour les exceptions avec le numéro 5, comme indiqué ci-dessus. Les noms des métriques connues sont accessibles via la liste ou sous forme de suggestions lors de la saisie. Vous pouvez saisir des métriques qui ne sont pas encore connues mais dont vous savez qu’elles apparaîtront sous forme de texte libre.

En fonction du type de données fourni par le point de données OpenTelemetry, il peut être utile de calculer des taux. Ceci est utile pour les compteurs, par exemple pour les paquets réseau perdus. Si plusieurs sources de données fournissent des données attribuées au même service Checkmk, vous pouvez également spécifier si une agrégation (par exemple, somme ou moyenne) doit être effectuée ou si la priorité doit simplement être donnée aux points de données les plus récents, les plus élevés ou les plus bas d’un intervalle.