Observabilidad (Beta) en agentes privados de Jitterbit 11.37 o posterior

Precaución

Esta función se encuentra disponible actualmente como versión beta, compatible con agentes privados versión 11.37.0.7 o posterior. Para enviar comentarios, comuníquese con el Equipo de productos de Jitterbit.

Introducción

Puedes supervisar de forma remota el rendimiento y el comportamiento de Docker, Linux, o Windows agentes privados con cualquiera de las siguientes plataformas de observación compatibles:

Datadog
Elasticsearch con Kibana

Debe instalar y configurar la plataforma de observación elegida en cada alojar de agente privado que desee monitorear. Una vez configurada correctamente, las métricas de sus agentes se pueden ver mediante el panel prediseñado provisto por Jitterbit. o su propio panel personalizado.

Utilice Datadog para monitorear un agente privado de Jitterbit

Prerrequisitos

Para utilizar Datadog para monitorear un alojar de agente privado, debe tener lo siguiente:

Agente privado 11.37.0.7 o posterior instalado y en ejecución.
Una cuenta Datadog.
Un superusuario (root) en Linux, o una cuenta de Administrador en Windows.

Importante

Ejecuta todos los comandos como este usuario.

Instalar el agente Datadog

Para instalar el agente Datadog en un alojar de agente privado, siga estos pasos:

Inicie sesión en su cuenta Datadog.
Desde el menú principal, seleccione Integraciones > Agente.
En la página Instrucciones de instalación del Agente, seleccione su tipo de alojar de agente privado.
Haga clic en el botón Clave API. Se abrirá el cuadro de diálogo Seleccionar una clave API.
Si no tiene ninguna clave API, haga clic en Botón Crear nuevo para crear uno. De lo contrario, seleccione la entrada de clave API y luego haga clic en el botón Usar clave API.
En el Comando de instalación del Agente, haga clic en Haga clic en el ícono copiar para copiar el comando a su portapapeles.
Abra una terminal o PowerShell en el alojar del agente privado, pegue el comando copiado y luego presione Enter para ejecutarlo.
Cierre la terminal o PowerShell.

Nota

Para habilitar la observabilidad en los agentes privados de Docker, debe usar variables de ambiente.

Configurar el agente Datadog

El software del agente privado Jitterbit incluye un secuencia de comandos para configurar Datadog. Para usarlo durante la primera instalación o al actualizar desde un agente privado instalación basada en 11.34, siga estos pasos:

Para los agentes privados de Docker, el valor de hostname propiedad en el /etc/datadog-agent/datadog.yaml Debe configurarse con el nombre de host del host. Si no es así, configúrelo manualmente.

Ejecute lo siguiente en una terminal o PowerShell en el alojar del agente privado:

AcopladorLinuxWindows

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

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

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

Lea y responda las siguientes indicaciones:
1. Indicación 1:
```
*************
***WARNING***
*************
Installing the metric configurations will backup and overwrite your datadog configuration files.
Do you wish to proceed?
1) Yes
2) No
```
  Ingrese el número correspondiente a su elección, seguido de la tecla Enter. Las opciones son las siguientes:
  - 1: Continúe con el secuencia de comandos. Si tiene un archivo de configuración de Datadog existente (/etc/datadog-agent/datadog.yaml), se realiza una copia de seguridad (/etc/datadog-agent/datadog.yml.jb.bak) y se crea uno nuevo.
  - 2:Detener el secuencia de comandos.
2. Indicación 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
```
  Ingrese el número correspondiente a su elección, seguido de la tecla Enter. Las opciones son las siguientes:
  - 1:Continúa el secuencia de comandos. Esto establece EnhancedCapabilityMetricsEnabled a true en el [AgentCapability] Sección de jitterbit.conf.
  - 2:Detener el secuencia de comandos.
3. Indicación 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
```
  Ingrese el número correspondiente a su elección, seguido de la tecla Enter. Las opciones son las siguientes:
  - 1: Continúe con la detención forzada y el reinicio del agente privado, reinicie el agente Datadog y luego salga del secuencia de comandos. Para confirmar que su agente Datadog está funcionando, inicie sesión en su cuenta Datadog y luego seleccione Integraciones > Automatización de flotas en el menú principal.
  - 2: Salga del secuencia de comandos sin reiniciar el agente privado ni el agente de Datadog. Debe 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 alojar. Debe iniciarlo manualmente con el siguiente comando:

sudo datadog-agent start

Configurar métricas de Datadog

Para definir facetas de Datadog, siga estos pasos:

Seleccione Registros > Explorador.
Filtre los registros por el Host de su agente y el servicio JitterbitAgentMetric.
(Opcional) Verifique que los registros de su agente estén en formato JSON. Para ello, seleccione una entrada de registro reciente y luego verifique que la columna CONTENIDO contenga un mensaje de registro con formato JSON.
En la barra Buscar facetas, haga clic en Agregar (Agregar una faceta).
En el campo Ruta del cuadro de diálogo Agregar faceta, ingrese el texto que se muestra a continuación y luego haga clic en el botón Agregar. Repita el procedimiento para cada elemento de 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, siga estos pasos:

Seleccione Registros > Explorador.
Haga clic en el botón Agregar y, luego, seleccione Campo calculado.
En el cuadro de diálogo Crear un campo calculado, establezca valores para los siguientes campos:
- Asignar un nombre al campo: operation_duration_seconds
- Define tu fórmula: @fields.duration_seconds
Haga clic en el botón Guardar.

Crear una medida

Para crear una medida, siga estos pasos:

Seleccione Registros > Explorador.
En la barra Facetas de búsqueda, haga clic en Agregar (Agregar una faceta).
En el cuadro de diálogo Agregar faceta, seleccione la pestaña Medida.
En el campo Ruta, ingrese @operation_duration_seconds.
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 puedes usar registros para crear métricas de Datadog.

Crea el `metric.operation.count.by.status` métrica de operación

Haga clic en Botón Nueva métrica.
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
Haga clic en el menú agrupar por y, a continuación, haga clic en cada uno de los siguientes elementos para agregarlos a la lista:
- @fields.operation_id
- @fields.operation_name
- @fields.status
- @agentgroup
- @host
Haga clic en el botón Crear métrica.

Crea el `metric.operation.running.over.scheduled.interval` métrica de operación

Haga clic en Botón Nueva métrica.
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
Haga clic en el menú agrupar por y haga clic en cada uno de los siguientes elementos para agregarlos a la lista:
- @fields.operation_id
- @fields.operation_name
- @agentgroup
- @host
Haga clic en el botón Crear métrica.

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

Haga clic en Botón Nueva métrica.
En el cuadro de diálogo Generar métrica, establezca 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
Haga clic en el menú agrupar por y haga clic en cada uno de los siguientes elementos para agregarlos a la lista:
- @fields.operation_id
- @fields.operation_name
- @agentgroup
- @host
Haga clic en el botón Crear métrica.

Crear métricas de proceso

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

Crea el `proc.openginebyname.cpu.num_threads` Métrica de proceso

Haga clic en el botón Nueva métrica.
En la sección 1, Filtrar procesos, en el campo Filtrar por, ingrese command:JitterbitOperationEngineProc.
En la sección 2, Seleccionar medida y dimensiones, establezca valores para los siguientes campos:
- Abra el menú Medida, luego seleccione # de hilos.
- Abra el menú Dimensiones, luego seleccione nombre.
En la sección 4, Nombre, en el campo metric.name, ingrese openginebyname para que el nombre sea proc.openginebyname.cpu.num_threads.
Haga clic en el botón Crear.

Crea el `proc.operationsengine.cpu.num_threads` Métrica de proceso

Haga clic en el botón Nueva métrica.
En la sección 1, Filtrar procesos, en el campo Filtrar por, ingrese command:JitterbitOperationEngineProc.
En la sección 2, Seleccionar medida y dimensiones, establezca valores para los siguientes campos:
- Abra el menú Medida y luego seleccione # de subprocesos.
- Abra el menú Dimensiones y luego seleccione agentgroup.
En la sección 4, Nombre, en el campo metric.name, ingrese operationsengine para que el nombre sea proc.operationsengine.cpu.num_threads.
Haga clic en el botón Crear.

Importar un panel de control de Datadog

Para importar el panel de control Datadog prediseñado de Jitterbit), siga estos pasos:

Descargue el archivo JSON del panel de control de Jitterbit Agente privado Datadog desde el portal Harmony Descargas página.
Seleccione Paneles de control > Nuevo panel.
En el cuadro de diálogo Crear un panel, ingrese un nombre en el campo Nombre del panel y luego haga clic en el botón Nuevo panel.
Haga clic en el botón Botón Configurar, luego seleccione Importar JSON del panel.
Busque el archivo JSON del panel descargado y selecciónelo.
Para usar el panel, seleccione Paneles > Lista de paneles, ingrese Jitterbit Harmony Agente privado en el campo Buscar paneles y luego seleccione el panel importado.

Solucionar problemas de Datadog

Para solucionar cualquier problema con Datadog, puede consultar la documentación de Datadog, inspeccionar los archivos de registro o ejecutar comandos para administrar 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:

LinuxWindows

/var/log/datadog/

Abra la aplicación Datadog Agente Manager y luego seleccione la pestaña Registro.

Archivos de configuración

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

LinuxWindows

/etc/datadog-agent/datadog.yaml

Abra la aplicación Datadog Agente Manager y luego seleccione la pestaña Configuración.

En este archivo, debe verificar que tenga los 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, ejecute 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, ejecute 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

Utilice Elasticsearch y Kibana para monitorear un agente privado de Jitterbit

Prerrequisitos

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

Agente privado 11.37.0.7 o posterior instalado y en ejecución.
Un sistema Elasticsearch y Kibana en funcionamiento instalado y configurado. Para instalarlos, consulte las siguientes páginas:
- Elasticsearch
- Kibana

Instalar Metricbeat y Filebeat

Metricbeat y Filebeat son agentes de recopilación de datos que envían métricas de agentes privados a su sistema Elasticsearch/Kibana. Para instalarlos, siga estos pasos:

Ritmo métrico:
1. Para instalar Metricbeat en un alojar de agente privado, siga las instrucciones de Metricbeat en el sitio web de Elastic.co.
2. Para iniciar Metricbeat cuando se inicia el alojar, siga las instrucciones de inicio de Metricbeat en el sitio web de Elastic.co.
3. Para verificar la conexión de Metricbeat a Elasticsearch, ejecute el siguiente comando:
```
metricbeat test output
```
Archivo Beat:
1. Para instalar Filebeat en un alojar de agente privado, siga las instrucciones de Filebeat en el sitio web de Elastic.co.
2. Para iniciar Filebeat cuando se inicia el alojar, siga las instrucciones de inicio de Filebeat en el sitio web de Elastic.co.
3. Para verificar la conexión de Filebeat a Elasticsearch, ejecute el siguiente comando:
```
filebeat test output
```

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

Para configurar la política de retención de datos, siga estos pasos:

Abra la consola web de Kibana.
Ingrese index lifecycle policies en la barra de búsqueda, seleccione la página resultante.
Haga clic en Botón Crear política.
En el cuadro de diálogo Crear política, configure los siguientes valores:
- Nombre de la política: private-agent-metrics-policy
Active el interruptor Fase cálida y, a continuación, configure los siguientes valores:
- Mover datos a la fase cuando: Tengan 30 días de antigüedad.
Active el interruptor Fase fría y, a continuación, configure los siguientes valores:
- Mover datos a la fase cuando: Tengan 90 días de antigüedad.
Haga clic en el botón Botón Guardar política y luego cerrar el cuadro de resumen.

Crear plantillas de Kibana

Para crear plantillas, siga estos pasos:

Cree la private-agent-metric-template modelo:
1. Ingresar index management en la barra de búsqueda, luego seleccione la página resultante.
2. Seleccione la pestaña Plantillas de índice.
3. Haga clic en Botón Crear modelo.
4. En la página Logística, ingrese valores para los siguientes campos:
  - Nombre: private-agent-metric-template
  - Patrones de índice: private-agent-metric-8.15-*
5. Haga clic en Siguiente botón.
6. En la página Plantillas de componentes, haga clic en el botón Siguiente botón.
7. En la página Configuración del índice, reemplace el contenido del campo Configuración del índice por lo siguiente:
```
{
  "index": {
    "lifecycle": {
      "name": "private-agent-metrics-policy",
      "rollover_alias": "private-agent-metric-alias"
    },
    "number_of_shards": "1",
    "number_of_replicas": "1"
  }
}
```
8. Haga clic en Siguiente botón.
9. En la página Mappings, en la pestaña Mapped fields, agregue campos según la siguiente tabla. Haga clic en el botón Add field 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. Seleccione la pestaña Opciones avanzadas y luego configure los siguientes botones en Activado:
  - Asignar cadenas numéricas a números
  - Asignar cadenas de fecha como fechas
11. Haga clic en Siguiente botón.
12. En la página Alias, haga clic en el botón Siguiente botón.
13. En la página Revisar detalles, haga clic en el botón Botón Crear modelo, luego cierre el cajón de resumen.

Crea el private-agent-filebeat-template modelo:

En la pestaña Plantillas de índice, haga clic en el botón Botón Crear modelo.
En la página Logística, ingrese valores para los siguientes campos:
- Nombre: private-agent-filebeat-template
- Patrones de índice: private-agent-filebeat-8.15-*
Haga clic en Siguiente botón.
En la página Plantillas de componentes, haga clic en el botón Siguiente botón.

En la página Configuración del índice, reemplace el contenido del campo Configuración del índice por lo siguiente:

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

Haga clic en Siguiente botón.

En la página Mappings, en la pestaña Mapped fields, agregue campos según la siguiente tabla. Haga clic en el botón Add field 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`

Seleccione la pestaña Opciones avanzadas y luego configure los siguientes botones en Activado:
- Asignar cadenas numéricas a números
- Asignar cadenas de fecha como fechas
Haga clic en Siguiente botón.
En la página Alias, haga clic en el botón Siguiente botón.
En la página Revisar detalles, haga clic en el botón Botón Crear modelo, luego cierre el cajón de resumen.

Configurar Metricbeat y Filebeat

El agente privado Jitterbit incluye un secuencia de comandos para configurar Metricbeat y Filebeat. Para usarlo durante la primera instalación o al actualizar desde un agente privado instalación basada en 11.34, siga estos pasos:

Ejecute 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

Lea y responda las siguientes indicaciones:
1. Indicación 1:
```
*************
***WARNING***
*************
Installing the metric configurations will backup and overwrite your metricbeat configuration files.
Do you wish to proceed?
1) Yes
2) No
```
  Ingrese el número correspondiente a su elección, seguido de la tecla Enter. Las opciones son las siguientes:
  - 1: Continúe con el secuencia de comandos. Si tiene archivos de configuración de Metricbeat y Filebeat existentes (/etc/metricbeat/metricbeat.yml y /etc/filebeat/filebeat.yml), se realizan copias de seguridad (/etc/metricbeat/metricbeat.yml.jb.bak y /etc/filebeat/filebeat.yml.jb.bak) y se crean otros nuevos.
  - 2:Detener el secuencia de comandos.
2. Indicación 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
```
  Ingrese el número correspondiente a su elección, seguido de la tecla Enter. Las opciones son las siguientes:
  - 1:Continúa el secuencia de comandos. Esto establece EnhancedCapabilityMetricsEnabled a true en el [AgentCapability] Sección de jitterbit.conf.
  - 2:Detener el secuencia de comandos.

Nota

Para habilitar la observabilidad en los agentes privados de Docker, debe usar variables de ambiente.

Importar un panel de Elasticsearch

Para importar un panel de Elasticsearch prediseñado, siga estos pasos:

Descargue el archivo JSON del panel de Elasticsearch del Agente privado Jitterbit desde el portal Harmony Descargas página.
Ingresar kibana saved objects en la barra de búsqueda de Elasticsearch, luego seleccione la página resultante.
Haga clic en el botón Importar.
En el cuadro de diálogo Importar objetos guardados, haga clic en Importar, busque el archivo JSON del panel descargado y selecciónelo.
En Opciones de importación, seleccione Verificar objetos existentes con Sobrescribir conflictos automáticamente.
Haga clic en el botón Importar.
Haga clic en el botón Listo.
Para utilizar el panel de control, ingrese dashboards En la barra de búsqueda de Elasticsearch, seleccione la página resultante y luego seleccione Jitterbit Harmony Agente privado Dashboard.

Solucionar problemas de Elasticsearch

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

Documentación de Elasticsearch

Ritmo métrico:
- preguntas frecuentes Metricbeat
- Depuración de Metricbeat
Archivo Beat:
- preguntas frecuentes Filebeat
- Filebeat de depuración

Ubicaciones de los archivos de registro de Elasticsearch

/var/log/metricbeat
/var/log/filebeat

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

Observabilidad (Beta) en agentes privados de Jitterbit 11.37 o posterior

Introducción

Utilice Datadog para monitorear un agente privado de Jitterbit

Prerrequisitos

Instalar el agente Datadog

Configurar el agente Datadog

Configurar métricas de Datadog

Crear facetas

Crear un campo calculado

Crear una medida

Crear métricas de operación

Crea el metric.operation.count.by.status métrica de operación

Crea el metric.operation.running.over.scheduled.interval métrica de operación

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

Crear métricas de proceso

Crea el proc.openginebyname.cpu.num_threads Métrica de proceso

Crea el proc.operationsengine.cpu.num_threads Métrica de proceso

Importar un panel de control de Datadog

Solucionar problemas de Datadog

Documentación de Datadog

Ubicaciones de archivos de Datadog

Archivos de registro

Archivos de configuración

Comandos de usuarios y permisos de Datadog

Utilice Elasticsearch y Kibana para monitorear un agente privado de Jitterbit

Prerrequisitos

Instalar Metricbeat y Filebeat

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

Crear plantillas de Kibana

Configurar Metricbeat y Filebeat

Importar un panel de Elasticsearch

Solucionar problemas de Elasticsearch

Documentación de Elasticsearch

Ubicaciones de los archivos de registro de Elasticsearch

Crea el `metric.operation.count.by.status` métrica de operación

Crea el `metric.operation.running.over.scheduled.interval` métrica de operación

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

Crea el `proc.openginebyname.cpu.num_threads` Métrica de proceso

Crea el `proc.operationsengine.cpu.num_threads` Métrica de proceso