Ir para o conteúdo

Log de observabilidade do agente privado Jitterbit

Introdução

Quando habilitado, as métricas de observabilidade do agente privado são preenchidas pelo conteúdo do arquivo AgentMetric.log. Ele está localizado no diretório de logs, por padrão C:\Program Files\Jitterbit Agent\log no Microsoft Windows, /opt/jitterbit/log no Linux e Docker.

Habilitar observabilidade do agente privado

A observabilidade do agente privado não está habilitada por padrão. Para habilitá-la, siga estas etapas:

  1. Edite o arquivo de configuração do agente privado.

  2. Na seção [AgentCapability], defina pelo menos EnhancedCapabilityMetricsEnabled=true e EnhancedCapabilityMetricsSubmissionEnabled=true, e habilite quaisquer outras métricas necessárias.

  3. Reinicie os serviços Jitterbit.

Importante

Isso habilita apenas o serviço de criação de logs. Você também deve configurar uma plataforma de observabilidade para consumir o log.

Formato do arquivo de log

O conteúdo do arquivo de métricas de observabilidade do agente privado está em formato JSON. O arquivo contém 3 chaves raiz, conforme segue:

Chave Tipo de dado Descrição
name String Tipo de log.
timestamp String Timestamp Unix epoch para a entrada do log.
fields String Chaves e valores do log.

O valor da chave name indica o tipo da mensagem de log e quais chaves aparecem na chave fields:

Valor de name Descrição do log
operation_log O status da operação em cada etapa de seu processamento.
operation_running_over_scheduled_interval Indica que a operação está sendo executada fora do cronograma.
agent_sync_progress O status do processo de sincronização do ambiente do agente.
agent_sync_file_error Os detalhes de qualquer falha no download da sincronização do ambiente.

Exemplos de arquivo de log

name: "operation_log"

Agente agendou uma operação com sucesso
{
    "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
}
Operação cancelada (por usuário do Studio ou reinício do agente)
{
    "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
}
Operação alterada para o status 'Em Execução'
{
    "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
}
Operação alterada para o status final
{
    "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"

Operação em execução por mais tempo do que seu intervalo agendado
{
    "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"
}