agent

Tipo

Referência

Para

Desenvolvedor, Engenharia de dados

O arquivo agents/<slug>--<id>.yaml descreve um Agente ETL ligado ao Tenant, o programa que roda os Dataflows na rede onde estão as origens. Instalar um agente está em instalar o Agente ETL.

Não há lumo new agent: o agente é instalado na máquina e ligado ao Tenant pela tela ou por lumo agent link.

Campos

• fileName
  string · opcional · valores: regex ^[a-z0-9-]+--\d+\.yaml$
• header
  object · obrigatório
• header.id
  integer · obrigatório · valores: ≥ 1
• header.kind
  string · obrigatório · valores: agent (fixo)
• header.lumo
  string · obrigatório · valores: v2 (fixo)
• header.tenantId
  integer · obrigatório · valores: ≥ 1
• header.appId
  integer · opcional · valores: ≥ 1
• header.dashboardId
  integer · opcional · valores: ≥ 1
• body
  object · obrigatório
• body.criado_em
  string ou null · opcional · valores: regex ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z$
  Somente leitura: o servidor preenche.
• body.criado_por
  string ou integer ou null · opcional
  Somente leitura: o servidor preenche.
• body.publicado_em
  string ou null · opcional · valores: regex ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z$
  Somente leitura: o servidor preenche.
• body.publicado_por
  string ou integer ou null · opcional
  Somente leitura: o servidor preenche.
• body.nome
  string · obrigatório · valores: não vazio
• body.description
  string ou null · opcional
• body.token
  string · opcional
  Editable when present; omitted or masked on GET after initial creation.
• body.config
  object · obrigatório
• body.config.max_parallel_flows
  integer · opcional · valores: ≥ 1
• body.config.timeout_seconds
  integer · opcional · valores: ≥ 1
• body.config.log_level
  string · opcional · valores: debug, info, warn, error
• body.config.token
  string · opcional
  Editable when present; omitted or masked on GET after initial creation.

Exemplo

# agents/servidor-matriz--41.yaml
# yaml-language-server: $schema=https://docs.horusbi.com.br/schemas/v2/agent.schema.json
id: 41
kind: agent
lumo: v2
tenantId: 1200
---
nome: Servidor Matriz
description: Agente ETL no servidor do ERP, na matriz.
config: {}

Limites

• O pull traz também ativo, parallel_schedules e parallel_processors, que não estão no esquema. Mantenha os valores que vieram do servidor: são eles que o push grava.
• token só se escreve: o servidor não o devolve na leitura.
• Para passar Dataflows (e, se quiser, credenciais) de um agente para outro, use lumo agent migrate. Para um Dataflow só, edite o tokenId no arquivo dele.
• lumo rm agent:<id> desliga o agente do Tenant e abandona as execuções em andamento. Migre os Dataflows antes.
• lumo agent health mostra as últimas 24 horas do agente, lumo agent events lista agendamentos perdidos, atrasados ou com erro, e lumo agent restart reinicia o processo.