Registro de métricas del agente privado Jitterbit

Introducción

Las métricas del agente son mensajes de registro de rendimiento del agente privado escritos en un archivo de registro JSON diseñado para observabilidad plataformas como DataDog o ElasticSearch.

Nota

Los registros de métricas del Agente están disponibles en los agentes privados versión 11.39 o posterior.

Habilitar registros de métricas de agente

El registro de métricas del agente no está habilitado de forma predeterminada. Para habilitarlo, siga estos pasos:

1. Edite el archivo de configuración del agente privado.
2. Añade una nueva sección [MetricLogging].
3. Bajo la [MetricLogging] sección, conjunto EnableAgentMetricLogging=true.
4. Reinicie los servicios de Jitterbit.

Formato de archivo de registro

Cuando está habilitado, las métricas del agente se escriben en el JITTERBIT_HOME/log/AgentMetric.log archivo en formato JSON.

El archivo contiene 3 claves raíz, como se indica a continuación:

Clave	Tipo de datos	Descripción
name	Cadena	Tipo de registro.
timestamp	Cadena	Marca de tiempo de época Unix para la entrada del registro.
fields	Cadena	Registra claves y valores.

El valor de la name La clave indica el tipo de mensaje de registro y qué claves aparecen en el fields Clave:

name valor	Descripción del registro
operation_log	El estado de la operación en cada etapa de su tramitación.
operation_running_over_scheduled_interval	Indica que la operación está excediendo el tiempo programado.
agent_sync_progress	El estado de la sincronización del ambiente del agente proceso.
agent_sync_file_error	Los detalles de cualquier fallo en la descarga de sincronización del ambiente.

Ejemplos de archivos de registro

name: "operation_log"

Agent successfully scheduled an operation

{
    "fields": {
        "environment_id": "265580",
        "environment_name": "AS-Local-env-1",
        "operation_id": "6452590",
        "operation_instance_guid": "2cf46ed6-148a-4978-8bfe-dacd1c7a6579",
        "operation_name": "New Operation - 3",
        "organization_id": "36990",
        "project_guid": "5f3b6467-3390-4d3a-a0b2-6d97081ac304",
        "project_name": "Test-Charizard",
        "status": "SUBMITTED",
        "submitted_ts": "2024-12-18T01:13:04.055649"
    },
    "name": "operation_log",
    "timestamp": 1734484384070
}

Operation canceled (by Integration Studio user, or agent restart)

{
    "fields": {
        "agent_group_id": "228510",
        "agent_group_name": "AS-Local-Agent",
        "agent_id": "286110",
        "agent_name": "As-Local-Agent",
        "duration_seconds": "4",
        "entered_ts": "2024-12-19T02:34:11.322000",
        "environment_id": "265580",
        "environment_name": "AS-Local-env-1",
        "operation_id": "6452590",
        "operation_instance_guid": "40c8f4c8-c389-4711-92d9-c62d8f9b913c",
        "operation_name": "New Operation - 3",
        "organization_id": "36990",
        "project_guid": "5f3b6467-3390-4d3a-a0b2-6d97081ac304",
        "project_name": "Test-Charizard",
        "started_ts": "2024-12-19T02:34:28.441605",
        "status": "CANCELLED",
        "status_ts": "2024-12-19T02:34:33.136890"
    },
    "name": "operation_log",
    "timestamp": 1734575673160
}

Operation changed to 'Running' status

{
    "fields": {
        "agent_group_id": "228510",
        "agent_group_name": "AS-Local-Agent",
        "agent_id": "286110",
        "agent_name": "As-Local-Agent",
        "entered_ts": "2024-12-19T02:34:11.322000",
        "environment_id": "265580",
        "environment_name": "AS-Local-env-1",
        "operation_id": "6452590",
        "operation_instance_guid": "40c8f4c8-c389-4711-92d9-c62d8f9b913c",
        "operation_name": "New Operation - 3",
        "organization_id": "36990",
        "process_guid": "",
        "project_guid": "5f3b6467-3390-4d3a-a0b2-6d97081ac304",
        "project_name": "Test-Charizard",
        "started_ts": "2024-12-19T02:34:28.441605",
        "status": "RUNNING"
    },
    "name": "operation_log",
    "timestamp": 1734575668482
}

Operation changed to final status

{
    "fields": {
        "agent_group_id": "228510",
        "agent_group_name": "AS-Local-Agent",
        "agent_id": "286110",
        "agent_name": "As-Local-Agent",
        "duration_seconds": "4",
        "entered_ts": "2024-12-19T02:34:11.322000",
        "environment_id": "265580",
        "environment_name": "AS-Local-env-1",
        "operation_id": "6452590",
        "operation_instance_guid": "40c8f4c8-c389-4711-92d9-c62d8f9b913c",
        "operation_name": "New Operation - 3",
        "organization_id": "36990",
        "project_guid": "5f3b6467-3390-4d3a-a0b2-6d97081ac304",
        "project_name": "Test-Charizard",
        "started_ts": "2024-12-19T02:34:28.441605",
        "status": "SUCCESS_WITH_INFO",
        "status_ts": "2024-12-19T02:34:33.136890"
    },
    "name": "operation_log",
    "timestamp": 1734575673160
}

name: "operation_running_over_scheduled_interval"

Operation running longer than its scheduled interval

{
    "fields": {
        "environment_id": "265580",
        "environment_name": "AS-Local-env-1",
        "is_operation_over_schedule": "true",
        "operation_id": "6385330",
        "operation_instance_guid": "",
        "operation_name": "New Operation",
        "organization_id": "36990",
        "project_guid": "5f3b6467-3390-4d3a-a0b2-6d97081ac304",
        "project_name": "Test-Charizard"
    },
    "name": "operation_running_over_scheduled_interval",
    "timestamp": 1734484381615
}

name: "agent_sync_progress"

{
    "name": "agent_sync_progress",
    "@timestamp": 1736900182570,
    "fields": {
        "environmentId": 192660,
        "organizationId": 36990,
        "totalFiles": 6,
        "filesProcessed": 1,
        "totalBytes": 0,
        "bytesDownloaded": 0,
        "fileMetadata": {
            "fileId": 61840,
            "filename": "org.jitterbit.plugin.pipeline.user.S3Get",
            "filesize": 0,
            "agentSyncFileType": "FILE_DOWNLOAD"
        },
        "agentSyncFileDownloadProgress": {
            "duration": 39062,
            "speed": 0.0,
            "timeRemaining": 0.0,
            "percentage": 0.0
        }
    }
}

name: "agent_sync_file_error"

{
    "@timestamp": 1736900293034,
    "fields": {
        "environmentId": 0,
        "organizationId": 36990,
        "agentSyncFileMetadata": {
            "fileId": 5778250,
            "filename": "jitterbit-connector-bigcommerce-1.0.0-10170.jar",
            "filesize": 0,
            "agentSyncFileType": "FILE_DOWNLOAD"
        }
    },
    "name": "agent_sync_file_error"
}