Observabilidad de agentes privados con Elasticsearch

Introducción

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

Para configurar Elasticsearch y Kibana, sigue los pasos en estas secciones en orden:

1. Satisfacer los requisitos previos.

2. Instalar los agentes Metricbeat y Filebeat en el host del agente privado.

3. Establecer la política de ciclo de vida de Kibana.

4. Crear plantillas de Kibana.

5. Configurar los agentes Metricbeat y Filebeat.

6. (Opcional) Importar un tablero.

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

Requisitos previos

Para usar Elasticsearch y Kibana para monitorear un host de agente privado, debes tener lo siguiente:

• Agente privado 11.37.0.7 o posterior instalado y en funcionamiento.

• Un sistema de Elasticsearch y Kibana funcionando, instalado y configurado. Para instalar estos, consulta las siguientes páginas:

  • Elasticsearch

  • Kibana

Instalar los agentes Metricbeat y Filebeat

Metricbeat y Filebeat son agentes de recolección de datos que envían métricas del agente privado a tu sistema de Elasticsearch/Kibana. Para instalarlos, sigue estos pasos:

• Metricbeat:

  1. Para instalar Metricbeat en un host de agente privado, sigue las instrucciones de Metricbeat en el sitio web de Elastic.co.

  2. Para iniciar Metricbeat cuando el host arranca, sigue las instrucciones de inicio de Metricbeat en el sitio web de Elastic.co.

  3. Para verificar la conexión de Metricbeat a Elasticsearch, ejecuta el siguiente comando:

     metricbeat test output
     

• Filebeat:

  1. Para instalar Filebeat en un host de agente privado, sigue las instrucciones de Filebeat en el sitio web de Elastic.co.

  2. Para iniciar Filebeat cuando el host arranca, sigue las instrucciones de inicio de Filebeat en el sitio web de Elastic.co.

  3. Para verificar la conexión de Filebeat a Elasticsearch, ejecuta el siguiente comando:

     filebeat test output
     

Configurar los agentes de Metricbeat y Filebeat

El agente privado de Jitterbit incluye un script para configurar Metricbeat y Filebeat. Para usarlo al instalar por primera vez, o al actualizar desde una instalación basada en el agente privado 11.34, sigue estos pasos:

1. Ejecuta lo siguiente en una terminal o PowerShell:

   DockerLinuxWindows

   cd /opt/jitterbit/scripts/
   ./configure_elasticsearch.sh
   

   cd /opt/jitterbit/scripts/
   ./configure_elasticsearch.sh
   

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

2. Lee y responde a los siguientes mensajes:

   1. Mensaje 1:

      *************
      ***WARNING***
      *************
      Installing the metric configurations will backup and overwrite your metricbeat 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 archivos de configuración existentes de Metricbeat y Filebeat (/etc/metricbeat/metricbeat.yml y /etc/filebeat/filebeat.yml), se hacen copias de seguridad (/etc/metricbeat/metricbeat.yml.jb.bak y /etc/filebeat/filebeat.yml.jb.bak) y se crean nuevos.

      • 2: Detener el script.

   2. Prompt 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:

      • 1: Continuar el script. Esto establece EnhancedCapabilityMetricsEnabled en true en la sección [AgentCapability] de jitterbit.conf.

      • 2: Detener el script.

Establecer la política de ciclo de vida del índice de Kibana

Para establecer la política de retención de datos, sigue estos pasos:

1. Abre tu consola web de Kibana.

2. Ingresa políticas de ciclo de vida de índices en la barra de búsqueda, luego selecciona la página resultante.

3. Haz clic en el botón Crear política.

4. En el diálogo Crear política, establece los siguientes valores:

   • Nombre de la política: private-agent-metrics-policy

5. Activa el interruptor de Fase cálida, luego establece los siguientes valores:

   • Mover datos a la fase cuando: tenga 30 días de antigüedad.

6. Activa el interruptor de Fase fría, luego establece los siguientes valores:

   • Mover datos a la fase cuando: tenga 90 días de antigüedad.

7. Haz clic en el botón Guardar política, luego cierra el panel de resumen.

Crear plantillas de Kibana

Para crear plantillas, sigue estos pasos:

1. Crea la plantilla private-agent-metric-template:

   1. Ingresa gestión de índices en la barra de búsqueda, luego selecciona la página resultante.

   2. Selecciona la pestaña Plantillas de índice.

   3. Haz clic en el botón Crear plantilla.

   4. En la página Logística, ingresa valores para los siguientes campos:

      • Nombre: private-agent-metric-template

      • Patrones de índice: private-agent-metric-8.15-*

   5. Haz clic en el botón Siguiente .

   6. En la página Plantillas de componentes, haz clic en el botón Siguiente .

   7. En la página de Configuración del índice, reemplaza el contenido del campo Configuración del índice con lo siguiente:

      {
        "index": {
          "lifecycle": {
            "name": "private-agent-metrics-policy",
            "rollover_alias": "private-agent-metric-alias"
          },
          "number_of_shards": "1",
          "number_of_replicas": "1"
        }
      }
      

   8. Haz clic en el botón Siguiente .

   9. En la página de Mapeos, en la pestaña de Campos mapeados, agrega campos de acuerdo con la siguiente tabla. Haz clic en el botón Agregar campo después de cada entrada:

      Tipo de campo	Nombre del campo
      Palabra clave	fields.env
      Palabra clave	private-agent.group
      Palabra clave	private-agent.name

   10. Selecciona la pestaña de Opciones avanzadas, luego establece los siguientes interruptores en Activado:

       • Mapear cadenas numéricas como números

       • Mapear cadenas de fecha como fechas

   11. Haz clic en el botón Siguiente .

   12. En la página de Alias, haz clic en el botón Siguiente .

   13. En la página de Revisar detalles, haz clic en el botón Crear plantilla, luego cierra el panel de resumen.

2. Crea la plantilla private-agent-filebeat-template:

   1. En la pestaña de Plantillas de índice, haz clic en el botón Crear plantilla.

   2. En la página de Logística, ingresa valores para los siguientes campos:

      • Nombre: private-agent-filebeat-template

      • Patrones de índice: private-agent-filebeat-8.15-*

   3. Haz clic en el botón Siguiente .

   4. En la página de Plantillas de componentes, haz clic en el botón Siguiente .

   5. En la página de Configuración del índice, reemplaza el contenido del campo Configuración del índice con lo siguiente:

      {
        "index": {
          "lifecycle": {
            "name": "private-agent-metrics-policy",
            "rollover_alias": "private-agent-metric-alias"
          },
          "number_of_shards": "1",
          "number_of_replicas": "1"
        }
      }
      

   6. Haz clic en el botón Siguiente .

   7. En la página de Mapeos, en la pestaña de Campos mapeados, agrega campos de acuerdo con la siguiente tabla. Haz clic en el botón Agregar campo después de cada entrada:

      Tipo de campo	Nombre del campo
      Palabra clave	message.fields.environment_name
      Palabra clave	message.fields.operation_name
      Palabra clave	message.fields.project_name
      Palabra clave	message.fields.status
      Palabra clave	private-agent.group
      Palabra clave	private-agent.name

   8. Selecciona la pestaña Opciones avanzadas, luego activa los siguientes interruptores en On:

      • Mapear cadenas numéricas como números

      • Mapear cadenas de fecha como fechas

   9. Haz clic en el botón Siguiente .

   10. En la página de Alias, haz clic en el botón Siguiente .

   11. En la página de Revisar detalles, haz clic en el botón Crear plantilla, luego cierra el panel de resumen.

Importar un panel de Elasticsearch

Para importar un panel de Elasticsearch preconstruido, sigue estos pasos:

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

2. Ingresa kibana saved objects en la barra de búsqueda de Elasticsearch, luego selecciona la página resultante.

3. Haz clic en el botón Importar.

4. En el diálogo de Importar objetos guardados, haz clic en Importar, busca el archivo JSON del panel descargado y luego selecciónalo.

5. En Opciones de importación, selecciona Verificar objetos existentes con Sobrescribir conflictos automáticamente.

6. Haz clic en el botón Importar.

7. Haz clic en el botón Listo.

8. Para usar el panel, ingresa dashboards en la barra de búsqueda de Elasticsearch, selecciona la página resultante y luego selecciona Panel del Agente Privado de Jitterbit Harmony.

Solucionar problemas de Elasticsearch

Para ayudar a resolver cualquier problema con los componentes de Elasticsearch, puedes consultar la documentación de Elasticsearch, inspeccionar archivos de registro o ejecutar comandos de diagnóstico.

Documentación de Elasticsearch

• Metricbeat:

  • Preguntas frecuentes de Metricbeat

  • Depurar Metricbeat

• Filebeat:

  • Preguntas frecuentes de Filebeat

  • Depurar Filebeat

Ubicaciones de archivos de registro de Elasticsearch

• /var/log/metricbeat

• /var/log/filebeat