Información general

Este check monitoriza MarkLogic a través del Datadog Agent. MarkLogic Server es una base de datos multimodelo diseñada para ser un centro de datos para datos operativos y analíticos.

Configuración

Sigue las instrucciones de abajo para instalar y configurar este check para un Agent que se ejecuta en un host. En el caso de entornos en contenedores, consulta las Plantillas de integración de Autodiscovery para obtener orientación sobre la aplicación de estas instrucciones.

Instalación

El check de MarkLogic está incluido en el paquete del Datadog Agent. No necesitas instalar nada más en tu servidor.

Preparación de MarkLogic

Mediante la API o la interfaz de administrador, crea un usuario para el Datadog Agent con los permisos de rol manage-user como mínimo. Si planeas utilizar la configuración enable_health_service_checks, asigna al usuario MarkLogic de Datadog al menos el rol manage-admin.

API

1. Crea el usuario de Datadog modificando esta solicitud con tus valores específicos:

   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
   

   Utiliza los <ADMIN_USER> y <ADMIN_PASSWORD> correctos, y sustituye <USER> y <PASSWORD> por el nombre de usuario y la contraseña que utiliza el Datadog Agent. Para obtener más información, consulta la documentación de MarkLogic: POST /manage/v2/users.

2. Para verificar que el usuario se creó con suficientes permisos:

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

Interfaz de administrador

1. Inicia sesión en QConsole con una cuenta de administrador. Por defecto, QConsole está disponible en http://<HOSTNAME>:8000/qconsole.

2. Selecciona Security como base de datos y XQuery como tipo de consulta.

3. Ejecuta esta consulta, sustituyendo <USER> y <PASSWORD> por los que utiliza el Datadog Agent:

   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"))
   

   Para obtener más información, consulta la documentación de MarkLogic: sec:create-user.

4. Para verificar que el usuario se creó con suficientes permisos, utiliza <USER> y <PASSWORD> para autenticarte en http://<HOSTNAME>:8002 (puerto predeterminado).

Configuración

Host

1. Edita el archivo marklogic.d/conf.yaml en la carpeta conf.d/ que se encuentra en la raíz del directorio de configuración de tu Agent para comenzar a recopilar los datos de rendimiento de MarkLogic. Consulta el archivo de muestra marklogic.d/conf.yaml para ver todas las opciones de configuración disponibles. Para las configuraciones relacionadas con el usuario en el archivo de configuración, utiliza el usuario del Datadog Agent que creaste.

2. Reinicia el Agent.

Recopilación de logs

Disponible para las versiones del Agent a partir de la 6.0

1. La recopilación de logs se encuentra deshabilitada de manera predeterminada en el Datadog Agent; debes habilitarla en el archivo datadog.yaml:

   logs_enabled: true
   

2. Añade este bloque de configuración a tu archivo marklogic.d/conf.yaml para empezar a recopilar logs de 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
   

   Cambia el valor path y configúralo para tu entorno. Consulta el archivo de muestra marklogic.d/conf.yaml para ver todas las opciones de configuración disponibles.

3. Reinicia el Agent.

Validación

Ejecuta el subcomando de estado del Agent y busca marklogic en la sección Checks.

Datos recopilados

Métricas

Eventos

MarkLogic no incluye eventos.

Checks de servicio

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

Solucionar problemas

¿Necesitas ayuda? Ponte en contacto con el servicio de asistencia de Datadog.