Présentation

Ce check permet de surveiller MarkLogic via l’Agent Datadog. MarkLogic Server est une base de données multi-modèle conçue pour regrouper vos données opérationnelles et analytiques.

Configuration

Suivez les instructions ci-dessous pour installer et configurer ce check lorsque l’Agent est exécuté sur un host. Consultez la documentation relative aux modèles d’intégration Autodiscovery pour découvrir comment appliquer ces instructions à des environnements conteneurisés.

Installation

Le check MarkLogic est inclus avec le package de l’Agent Datadog. Vous n’avez donc rien d’autre à installer sur votre serveur.

Préparer MarkLogic

À l’aide de l’API ou de l’interface d’administration, créez un utilisateur pour l’Agent Datadog avec les autorisations de rôle manage-user au minimum. Si vous prévoyez d’utiliser la configuration enable_health_service_checks, attribuez à l’utilisateur Datadog MarkLogic le rôle manage-admin au minimum.

API

1. Créez l’utilisateur Datadog en modifiant cette requête avec vos valeurs spécifiques :

   curl -X POST --anyauth --user <ADMIN_USER>:<ADMIN_PASSWORD> -i -H "Content-Type: application/json" -d '{"user-name": "<USER>", "password": "<PASSWORD>", "roles": {"role": "manage-user"}}' http://<HOSTNAME>:8002/manage/v2/users
   

   Définissez un <ADMIN_USER> et un <ADMIN_PASSWORD> valides, et remplacez <USER> et <PASSWORD> par le nom d’utilisateur et le mot de passe de l’Agent Datadog. Pour en savoir plus, consultez la section POST /manage/v2/users de la documentation MarkLogic (en anglais).

2. Pour vérifier que l’utilisateur a été créé avec les autorisations requises :

   curl -X GET --anyauth --user <USER>:<PASSWORD> -i http://<HOSTNAME>:8002/manage/v2
   

Interface d’administration

1. Connectez-vous à la QConsole avec un compte administrateur. Par défaut, la QConsole est disponible à l’adresse suivante : http://<HOSTNAME>:8000/qconsole.

2. Sélectionnez Security comme base de données et XQuery comme type de requête.

3. Exécutez la requête, en remplaçant <USER> et <PASSWORD> par le nom d’utilisateur et le mot de passe utilisés par l’Agent Datadog :

   xquery version "1.0-ml";
   import module namespace sec="http://marklogic.com/xdmp/security" at 
       "/MarkLogic/security.xqy";
   
   sec:create-user(
       "<USER>",
       "Datadog Agent user",
       "<PASSWORD>",
       "manage-user",
       (xdmp:permission("security", "read")),
       ("http://marklogic.com/dev_modules"))
   

   Pour en savoir plus, consultez la section sec:create-user de la documentation MarkLogic (en anglais).

4. Pour vérifier que l’utilisateur a été créé avec les autorisations requises, utilisez les champs <USER> et <PASSWORD> pour vous authentifier sur http://<HOSTNAME>:8002 (port par défaut).

Configuration

Host

1. Modifiez le fichier marklogic.d/conf.yaml dans le dossier conf.d/ à la racine du répertoire de configuration de votre Agent pour commencer à recueillir vos données de performance MarkLogic. Consultez le fichier d’exemple marklogic.d/conf.yaml pour découvrir toutes les options de configuration disponibles. Pour les paramètres liés à l’utilisateur dans le fichier de configuration, utilisez l’utilisateur de l’Agent Datadog que vous avez créé.

2. Redémarrez l’Agent.

Collecte de logs

Disponible à partir des versions > 6.0 de l’Agent

1. La collecte de logs est désactivée par défaut dans l’Agent Datadog. Vous devez l’activer dans datadog.yaml :

   logs_enabled: true
   

2. Ajoutez ce bloc de configuration à votre fichier marklogic.d/conf.yaml pour commencer à recueillir vos logs MarkLogic :

     logs:
       - type: file
         path: /var/opt/MarkLogic/Logs/ErrorLog.txt
         source: marklogic
       - type: file
         path: /var/opt/MarkLogic/Logs/80002_AccessLog.txt
         source: marklogic
   

   Modifiez la valeur path en fonction de votre environnement. Consultez le fichier d’exemple marklogic.d/conf.yaml pour découvrir toutes les options de configuration disponibles.

3. Redémarrez l’Agent.

Validation

Lancez la sous-commande status de l’Agent et cherchez marklogic dans la section Checks.

Données collectées

Métriques

Événements

MarkLogic n’inclut aucun événement.

Checks de service

marklogic.can_connect
Returns CRITICAL if the Agent is unable to reach the query endpoint. Returns OK otherwise.
Statuses: ok, critical, unknown

marklogic.database.health
Returns CRITICAL if the database state is critical; WARNING if it is maintenance, offline, or at-risk; and OK otherwise.
Statuses: ok, warning, critical, unknown

marklogic.forest.health
Returns CRITICAL if the forest state is critical; WARNING if it is maintenance, offline, or at-risk; and OK otherwise.
Statuses: ok, warning, critical, unknown

Dépannage

Besoin d’aide ? Contactez l’assistance Datadog.