Saltar al contenido

Observabilidad del agente privado con Datadog

Introducción

Esta página muestra cómo se puede monitorear de forma remota el rendimiento y comportamiento de los agentes privados de Docker, Linux o Windows utilizando la plataforma de observabilidad de Datadog. Cuando se configura, las métricas de tus agentes privados se pueden ver utilizando el tablero preconstruido proporcionado por Jitterbit, o tu propio tablero personalizado.

Para configurar Datadog, sigue los pasos en estas secciones en orden:

  1. Satisfacer los requisitos previos.

  2. Instalar el agente de Datadog en el host del agente privado.

  3. Configurar el agente de Datadog.

  4. Configurar métricas de Datadog.

  5. (Opcional) Importar un tablero de Datadog.

Si tienes algún problema, consulta la sección de solución de problemas, o contacta al soporte de Jitterbit.

Requisitos previos

Debes tener lo siguiente:

  • Agente privado 11.37.0.7 o posterior instalado y en funcionamiento.

  • Una cuenta de Datadog.

  • Una cuenta de superusuario (root) en Linux, o una cuenta de Administrador en Windows.

    Importante

    Ejecuta todos los comandos en esta página como este usuario.

  • Un nombre de host RFC 1123 válido para el host donde se está ejecutando el agente privado.

  • Requisitos adicionales para agentes privados de Docker:

Instalar el agente de Datadog

Para instalar el agente de Datadog en un host de agente privado, sigue estos pasos:

  1. Inicia sesión en tu cuenta de Datadog.

  2. Desde el menú principal, selecciona Integraciones > Automatización de Flota > Instalar Agentes.

  3. En la página Seleccionar plataforma para instalar Agentes, selecciona la plataforma en la que se está ejecutando tu agente privado:

    Selecciona Basado en host > Linux.

    Selecciona Basado en host > Linux.

    Selecciona Host basado > Windows.

  4. En la página Instalar el Agente de Datadog en , hay estas tres secciones:

    • ① Personaliza tu cobertura de observabilidad: Habilita las características requeridas y selecciona una etiqueta de entorno.

    • ② Ejecuta el comando de instalación:

      1. Haz clic en el botón Seleccionar una clave API. Se abre el diálogo Seleccionar una clave API.

      2. Selecciona una clave API de la lista, luego haz clic en el botón Usar clave API.

        Si no tienes una clave, haz clic en el botón Crear nueva para crear una.

      3. Abre una consola (terminal o PowerShell) en el host del agente privado. Copia y pega el bloque de código en la consola.

      4. Haz lo siguiente:

        1. Agrega una línea para establecer el valor de la variable de entorno DD_HOSTNAME al nombre de host del agente privado.

        2. Cambia install_script_agent7.sh a install_script_agent6.sh.

          (Actualmente, el agente privado de Jitterbit solo es compatible con la versión 6 del agente de Datadog.)

        3. Tu comando debería verse así, con tu propia clave API (línea 1), nombre de host del agente privado (línea 3) y argumento curl editado (línea 4):

          1
2
3
4
          DD_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \
DD_SITE="datadoghq.com" \
DD_HOSTNAME="hostname" \
bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent6.sh)"

        4. Presiona Enter para ejecutar los comandos.

        Presiona Enter para ejecutar los comandos.

        Presiona Enter para ejecutar los comandos.

    • ③ Confirma la instalación del Agente: Cuando tengas el agente de Datadog instalado y en funcionamiento en tu host de agente privado, espera un momento para que aparezca en este panel antes de continuar.

  5. (Solo Docker) Crea un archivo de seguridad predeterminado para el agente de Datadog:

    Después de instalar, el agente de Datadog no inicia debido a un problema conocido de Datadog. Para corregir esto, haz una copia del archivo de agente de seguridad de ejemplo antes de proceder a la siguiente sección:

cp  /etc/datadog-agent/security-agent.yaml.example /etc/datadog-agent/security-agent.yaml

No se necesita ninguna acción.

No se necesita ninguna acción.

Configurar el agente de Datadog

El software del agente privado de Jitterbit incluye un script para configurar e iniciar el agente de Datadog. Se puede utilizar al instalar por primera vez o al actualizar desde una instalación basada en el agente privado 11.34. Para hacerlo, sigue estos pasos:

  1. Ejecuta lo siguiente en una terminal o PowerShell en el host del agente privado:

    cd /opt/jitterbit/scripts/
./configure_datadog.sh

    cd /opt/jitterbit/scripts/
./configure_datadog.sh

    cd "C:\Program Files\Jitterbit Agent\scripts\"
.\configure_datadog.ps

  2. Lee y responde a los siguientes mensajes:

    1. Mensaje 1:

      *************
***WARNING***
*************
Installing the metric configurations will backup and overwrite your datadog configuration files.
Do you wish to proceed?
1) Yes
2) No

      Ingresa el número correspondiente a tu elección, seguido de la tecla Enter. Las opciones son las siguientes:

      • 1: Continuar con el script. Si tienes un archivo de configuración de Datadog existente (/etc/datadog-agent/datadog.yaml), se hace una copia de seguridad (/etc/datadog-agent/datadog.yml.jb.bak) y se crea uno nuevo.

      • 2: Detener el script.

    2. Mensaje 2:

      *************
***WARNING***
*************
Turning on Agent observability on the agent will turn on Enhanced Capability feature for the agent.
Enhanced Capability might affect the operation routing behavior for the agents.
Do you wish to proceed?
1) Yes
2) No

      Ingresa el número correspondiente a tu elección, seguido de la tecla Enter. Las opciones son las siguientes:

    3. Mensaje 3:

      Jitterbit agent needs to restart in order to load the new changes.
Do you wish to restart now? This will stop any in progress operations
1) Yes
2) No

      Ingresa el número correspondiente a tu elección, seguido de la tecla Enter. Las opciones son las siguientes:

      • 1: Continúa con la detención y reinicio del agente privado, reinicia el agente de Datadog y luego sal del script. Para confirmar que tu agente de Datadog está funcionando, inicia sesión en tu cuenta de Datadog y selecciona Integraciones > Automatización de Flota en el menú principal.

      • 2: Sal del script sin reiniciar el agente privado ni el agente de Datadog. Debes reiniciar tanto el agente privado como el agente de Datadog cuando sea conveniente.

Importante

En Docker, el agente de Datadog no se inicia automáticamente con el host. Debes iniciarlo manualmente con el siguiente comando:

sudo datadog-agent run

Configurar métricas de Datadog

Crear facetas

Para definir facetas de Datadog, sigue estos pasos:

  1. Selecciona Registros > Explorador.

  2. En la barra Buscar, filtra los registros por el Host de tu agente y el servicio JitterbitAgentMetric utilizando la siguiente cadena:

    host:<hostname> service:JitterbitAgentMetric

  3. (Opcional) Verifica que los registros de tu agente estén en formato JSON. Para hacer esto, selecciona una entrada de registro reciente y verifica que la columna CONTENIDO contenga un mensaje de registro en formato JSON.

  4. En la barra Buscar facetas, haz clic en el botón Agregar (Agregar una faceta). Se abre el diálogo Agregar faceta.

  5. En el campo Ruta, ingresa el texto que se muestra a continuación y luego haz clic en el botón Agregar. Repite para cada elemento en la siguiente lista:

    • @environment_id

    • @environment_name

    • @is_operation_over_schedule

    • @name

    • @operation_id

    • @operation_instance_guid

    • @operation_name

    • @organization_id

    • @project_guid

    • @project_name

    • @status

Crear un campo calculado

Para crear un campo calculado, sigue estos pasos:

  1. Selecciona Registros > Explorador.

  2. Haz clic en el botón Agregar y luego selecciona Campo Calculado. Se abre el diálogo Crear un campo calculado.

  3. Establezca valores para los siguientes campos:

    • Nombre de su campo: operation_duration_seconds

    • Defina su fórmula: @fields.duration_seconds

  4. Haga clic en el botón Guardar.

Crear una medida

Para crear una medida, siga estos pasos:

  1. Seleccione Registros > Explorador.

  2. En la barra de Facetas de búsqueda, haga clic en el botón Agregar (Agregar una faceta). Se abre el cuadro de diálogo Agregar faceta.

  3. Seleccione la pestaña Medida.

  4. En el campo Ruta, ingrese @operation_duration_seconds.

  5. Haga clic en el botón Agregar.

Crear métricas de operación

Para definir métricas de operación, seleccione Registros > Generar Métricas, luego siga los pasos a continuación para cada métrica de operación.

Consejo

También puede usar registros para crear métricas de Datadog.

Crear la métrica de operación metric.operation.count.by.status

  1. Haga clic en el botón Nueva Métrica.

  2. En el cuadro de diálogo Generar Métrica, establezca los valores de la siguiente manera:

    • Establecer Nombre de Métrica: metric.operation.count.by.status

    • Definir Consulta: service:JitterbitAgentMetric @name:operation_log

  3. Haga clic en el menú agrupar por, luego haga clic en cada uno de los siguientes para agregarlos a la lista:

    • @fields.operation_id

    • @fields.operation_name

    • @fields.status

    • @agentgroup

    • @host

  4. Haga clic en el botón Crear Métrica.

Crear la métrica de operación metric.operation.running.over.scheduled.interval

  1. Haga clic en el botón Nueva Métrica.

  2. En el cuadro de diálogo Generar Métrica, establezca los valores de la siguiente manera:

    • Establecer Nombre de Métrica: metric.operation.running.over.scheduled.interval

    • Definir Consulta: service:JitterbitAgentMetric @name:operation_running_over_scheduled_interval

  3. Haga clic en el menú agrupar por, y haga clic en cada uno de los siguientes para agregarlos a la lista:

    • @fields.operation_id

    • @fields.operation_name

    • @agentgroup

    • @host

  4. Haz clic en el botón Crear Métrica.

Crea la métrica de operación metric.operation.duration.seconds

  1. Haz clic en el botón Nueva Métrica.

  2. En el diálogo Generar Métrica, establece los valores de la siguiente manera:

    • Establecer Nombre de Métrica: metric.operation.duration.seconds

    • Definir Consulta: service:JitterbitAgentMetric @name:operation_running_over_scheduled_interval

  3. Haz clic en el menú agrupar por, y haz clic en cada uno de los siguientes para agregarlos a la lista:

    • @fields.operation_id

    • @fields.operation_name

    • @agentgroup

    • @host

  4. Haz clic en el botón Crear Métrica.

Crea métricas de proceso

Para definir métricas de proceso, selecciona Infraestructura > Procesos, selecciona la pestaña Administrar Métricas, y luego sigue los pasos a continuación para cada métrica de proceso.

Crea la métrica de proceso proc.openginebyname.cpu.num_threads

  1. Haz clic en el botón Nueva Métrica.

  2. En la sección 1, Filtrar Procesos, en el campo Filtrar por, ingresa command:JitterbitOperationEngineProc.

  3. En la sección 2, Seleccionar Medida y Dimensiones, establece los valores para los siguientes campos:

    • Abre el menú Medida, luego selecciona # de Hilos.

    • Abre el menú Dimensiones, luego selecciona nombre.

  4. En la sección 4, Nombre, en el campo metric.name, ingresa openginebyname para que el nombre sea proc.openginebyname.cpu.num_threads.

  5. Haz clic en el botón Crear.

Crea la métrica de proceso proc.operationsengine.cpu.num_threads

  1. Haz clic en el botón Nueva Métrica.

  2. En la sección 1, Filtrar Procesos, en el campo Filtrar por, ingresa command:JitterbitOperationEngineProc.

  3. En la sección 2, Seleccionar Medida y Dimensiones, establece los valores para los siguientes campos:

    • Abre el menú Medir, luego selecciona # de Hilos.

    • Abre el menú Dimensiones, luego selecciona agentgroup.

  4. En la sección 4, Nombre, en el campo metric.name, ingresa operationsengine para que el nombre sea proc.operationsengine.cpu.num_threads.

  5. Haz clic en el botón Crear.

Importar un panel de Datadog

Para importar el panel de Datadog preconstruido de Jitterbit, sigue estos pasos:

  1. Descarga el archivo JSON del panel de Datadog del Agente Privado de Jitterbit desde la página de Descargas del portal Harmony.

  2. Selecciona Paneles > Nuevo Panel.

  3. En el cuadro de diálogo Crear un Panel, ingresa un nombre en el campo Nombre del Panel, luego haz clic en el botón Nuevo Panel.

  4. Haz clic en el botón Configurar, luego selecciona Importar JSON del panel.

  5. Busca el archivo JSON del panel descargado, luego selecciónalo.

  6. Para usar el panel, selecciona Paneles > Lista de paneles, ingresa Agente Privado de Jitterbit Harmony en el campo Buscar paneles, luego selecciona el panel importado.

Solucionar problemas de Datadog

Para ayudar a resolver cualquier problema con Datadog, puedes consultar la documentación de Datadog, inspeccionar archivos de registro o ejecutar comandos para gestionar usuarios y permisos.

Documentación de Datadog

Ubicaciones de archivos de Datadog

Archivos de registro

Los archivos de registro de Datadog se pueden encontrar en la siguiente ubicación:

/var/log/datadog/

/var/log/datadog/

Abre la aplicación Administrador del Agente de Datadog, luego selecciona la pestaña Registro.

Archivos de configuración

El archivo de configuración de Datadog se puede encontrar en la siguiente ubicación:

/etc/datadog-agent/datadog.yaml

/etc/datadog-agent/datadog.yaml

Abre la aplicación Datadog Agent Manager, luego selecciona la pestaña Settings.

En este archivo, debes verificar que tengas valores correctos para las siguientes claves:

  • api_key

  • site

  • $hostname

  • tags

Comandos de usuarios y permisos de Datadog

Para crear un usuario y un grupo de Datadog, ejecuta estos comandos:

usermod -a -G root dd-agent
usermod -a -G jitterbit dd-agent

Para establecer la propiedad del archivo de configuración de Datadog, ejecuta estos comandos:

chown dd-agent:dd-agent /etc/datadog-agent/conf.d/logs.d/conf.yaml
chown dd-agent:dd-agent /etc/datadog-agent/conf.d/logs.d