Variáveis de ambiente

Esta referência lista as variáveis de ambiente usadas para configurar o Reporter, o serviço que gera relatórios regulatórios, de conformidade e contábeis a partir de templates configuráveis. O Reporter é entregue como um binário único cujas superfícies ativas são selecionadas por RUN_MODE — o manager da API, o worker de relatórios ou ambos. Você as define no momento da implantação, por valores Helm, Docker Compose ou pelo ambiente do seu orquestrador. Variáveis marcadas como obrigatórias fazem o servidor falhar na inicialização se não forem definidas. Para os blocos de configuração que todo produto Lerian compartilha — postura de TLS, OpenTelemetry, autenticação do Access Manager, multi-tenancy, service discovery e streaming de eventos — veja a referência de configuração BYOC. Esta página foca no que é distintivo do Reporter.

Modo de execução e portas

RUN_MODE decide quais superfícies o processo atende. Rode a API e o worker como um só processo (all) para implantações pequenas, ou separe-os em implantáveis distintos (api e worker) para escalar a geração de relatórios de forma independente. Veja a referência de saúde e prontidão para o contrato de sondas.

Variável	Descrição	Padrão	Obrigatória
`RUN_MODE`	Superfícies a executar: `api`, `worker` ou `all`	`all`	Não
`SERVER_PORT` / `SERVER_ADDRESS`	Endereço de bind da API (`RUN_MODE=api`/`all`), lido de `SERVER_ADDRESS`; `SERVER_PORT` é a convenção usada para construí-lo (`:4005`). Atende `/health`, `/readyz`, `/version`.	—	Sim (`api`/`all`)
`HEALTH_PORT`	Porta de saúde do worker (`RUN_MODE=worker`). Atende `/health`, `/readyz`.	`4006`	Não

Implantação e TLS

Variável	Descrição	Padrão	Obrigatória
`DEPLOYMENT_MODE`	Sabor de implantação: `local`, `byoc` ou `saas`. Em `saas`, o TLS é obrigatório para toda conexão de dependência e o servidor se recusa a iniciar sem ele. Em `byoc`, o TLS é recomendado e alertado em vez de imposto. Também marca a resposta de `/readyz`.	`local`	Não
`ALLOW_INSECURE_TLS`	Ignora a imposição de TLS por conexão nas DSNs de infraestrutura. Deixe sem definir ou `false` em produção.	`false`	Não

CORS e proxies

Variável	Descrição	Padrão	Obrigatória
`CORS_ALLOWED_ORIGINS`	Origens CORS permitidas (CSV, ou `*`). Restrinja a origens explícitas em produção.	`*`	Não
`CORS_ALLOWED_METHODS`	Métodos CORS permitidos	varia	Não
`CORS_ALLOWED_HEADERS`	Headers CORS permitidos	varia	Não
`TRUSTED_PROXIES`	CIDRs de proxy confiáveis para a análise de `X-Forwarded-For`. Defina ao rodar atrás de um load balancer.	—	Não
`SWAGGER_ENABLED`	Serve a UI do OpenAPI/Swagger	`false`	Não

Paginação da API

Variável	Descrição	Padrão	Obrigatória
`MAX_PAGINATION_LIMIT`	Maior `limit` que uma operação de listagem aceita. Uma requisição acima do teto é rejeitada com um erro de paginação, em vez de ser cortada.	`100`	Não

Pré-visualizações de templates

Variável	Descrição	Padrão	Obrigatória
`PREVIEW_MAX_CONCURRENT`	Máximo de pré-visualizações síncronas de templates que o manager da API renderiza ao mesmo tempo. Quando todas as vagas estão ocupadas, o Reporter rejeita uma nova pré-visualização imediatamente com HTTP `429` e `RPT-0108`; ele não a coloca em fila. É um limite de renderizações concorrentes, não um limite de requisições por intervalo. Valores menores que `1` usam o padrão.	`4`	Não

Banco de dados (MongoDB)

Armazena metadados de relatórios, templates e histórico de execuções.

Variável	Descrição	Padrão	Obrigatória
`MONGO_URI`	Esquema de conexão: `mongodb` ou `mongodb+srv`	`mongodb`	Não
`MONGO_HOST`	Host do MongoDB	—	Sim
`MONGO_PORT`	Porta do MongoDB	—	Sim
`MONGO_USER`	Usuário do banco de dados	—	Sim
`MONGO_PASSWORD`	Senha do banco de dados. Sensível.	—	Sim
`MONGO_NAME`	Nome do banco de dados	—	Sim
`MONGO_MAX_POOL_SIZE`	Tamanho máximo do pool de conexões	varia	Não
`MONGO_TLS_CA_CERT`	Certificado CA PEM codificado em Base64 para TLS (por exemplo AWS DocumentDB)	—	Não

Message broker (RabbitMQ)

Carrega a fila de comandos de geração de relatórios entre a API e o worker.

Variável	Descrição	Padrão	Obrigatória
`RABBITMQ_HOST`	Host do broker	—	Sim
`RABBITMQ_PORT_AMQP`	Porta AMQP	—	Sim
`RABBITMQ_PORT_HOST`	Porta de gerenciamento/HTTP	—	Não
`RABBITMQ_URI`	Esquema de conexão: `amqp` ou `amqps`. Use `amqps` em produção.	`amqp`	Não
`RABBITMQ_DEFAULT_USER`	Usuário do broker	—	Sim
`RABBITMQ_DEFAULT_PASS`	Senha do broker. Sensível.	—	Sim
`RABBITMQ_EXCHANGE`	Exchange em que a API publica os comandos de geração de relatórios	—	Sim (`api`/`all`)
`RABBITMQ_GENERATE_REPORT_QUEUE`	Fila que leva os comandos de geração de relatórios da API até o worker	—	Sim (`api`/`worker`/`all`)
`RABBITMQ_GENERATE_REPORT_KEY`	Routing key usada pela API para os comandos de geração de relatórios	—	Sim (`api`/`all`)
`RABBITMQ_NUMBERS_OF_WORKERS`	Concorrência de consumidores do worker	`5`	Não

Object storage (compatível com S3)

Onde os relatórios renderizados são armazenados. Funciona com qualquer endpoint compatível com S3.

Variável	Descrição	Padrão	Obrigatória
`OBJECT_STORAGE_ENDPOINT`	URL do endpoint compatível com S3	—	Sim
`OBJECT_STORAGE_REGION`	Região de armazenamento	`us-east-1`	Não
`OBJECT_STORAGE_BUCKET`	Bucket para os relatórios renderizados	`reporter-storage`	Não
`OBJECT_STORAGE_ACCESS_KEY_ID`	ID da chave de acesso. Sensível.	—	Sim
`OBJECT_STORAGE_SECRET_KEY`	Chave de acesso secreta. Sensível.	—	Sim
`OBJECT_STORAGE_USE_PATH_STYLE`	Usa endereçamento path-style (necessário para alguns stores compatíveis com S3)	`false`	Não
`OBJECT_STORAGE_DISABLE_SSL`	Desativa o TLS para o endpoint de armazenamento. Deixe `false` em produção.	`false`	Não

Cache (Redis / Valkey)

Variável	Descrição	Padrão	Obrigatória
`REDIS_HOST`	Host e porta do Redis/Valkey	—	Sim
`REDIS_PASSWORD`	Senha de autenticação. Sensível.	—	Não
`REDIS_DB`	Índice do banco de dados lógico	`0`	Não
`REDIS_PROTOCOL`	Versão do protocolo RESP	varia	Não
`REDIS_TLS`	Ativa o TLS para a conexão	`false`	Não
`REDIS_CA_CERT`	Certificado CA PEM codificado em Base64 para TLS	—	Não
`REDIS_MASTER_NAME`	Nome do master do Sentinel (implantações com Sentinel)	—	Não
`REDIS_USE_GCP_IAM`	Autentica no GCP Memorystore com IAM em vez de senha	`false`	Não

Renderização de PDF (worker)

Variável	Descrição	Padrão	Obrigatória
`PDF_POOL_WORKERS`	Workers concorrentes de renderização de PDF	`2`	Não
`PDF_TIMEOUT_SECONDS`	Timeout de renderização de PDF por relatório (segundos)	`90`	Não

Datasources de relatórios

Os relatórios leem de datasources PostgreSQL e MongoDB no registro persistente. Crie e gerencie essas entradas pela API de fontes de dados. O bloco de ambiente abaixo é um caminho opcional de bootstrap single-tenant; implantações multi-tenant criam datasources por tenant pela API. DATASOURCE_{NAME}_CONFIG_NAME faz um bloco de semeadura pelo ambiente existir. O Reporter varre o ambiente por chaves que correspondem a DATASOURCE_*_CONFIG_NAME — o prefixo conta tanto quanto o sufixo, então uma chave que apenas termina em _CONFIG_NAME não declara nada. Na inicialização do Manager, um bloco completo semeia o seu configName apenas quando nenhuma entrada no registro, incluindo uma soft-deleted, já usa aquele nome. O valor é o nome pelo qual os seus templates endereçam a fonte. Dentro de um bloco, as variáveis marcadas como obrigatórias são as que o Reporter precisa antes de ler o bloco.

Variável	Descrição	Padrão	Obrigatória
`DATASOURCE_{NAME}_CONFIG_NAME`	Nome pelo qual os templates endereçam este datasource. Declara o bloco.	—	Sim
`DATASOURCE_{NAME}_TYPE`	Engine do datasource: `postgresql` ou `mongodb`	—	Sim
`DATASOURCE_{NAME}_HOST`	Host do datasource	—	Sim
`DATASOURCE_{NAME}_PORT`	Porta do datasource	—	Sim
`DATASOURCE_{NAME}_DATABASE`	Nome do banco de dados	—	Sim
`DATASOURCE_{NAME}_USER`	Usuário do datasource	—	Não
`DATASOURCE_{NAME}_PASSWORD`	Senha do datasource. Sensível.	—	Não
`DATASOURCE_CRED_ENC_KEY`	Chave AES persistente codificada em hexadecimal compartilhada pelo Manager e pelo worker para criptografar e descriptografar as credenciais do registro. Mantenha-a inalterada entre reinicializações e implantações; mudá-la impede a descriptografia das credenciais já armazenadas no registro. Gere-a com `openssl rand -hex 32`.	—	Sim
`DATASOURCE_{CONFIG_NAME}_SCHEMAS`	Schemas a expor do datasource (CSV). Essa chave usa o valor de `CONFIG_NAME` em maiúsculas, diferente das demais chaves do bloco.	`public`	Não
`DATASOURCE_{NAME}_SSLMODE`	Modo SSL para uma conexão PostgreSQL	—	Não
`DATASOURCE_{NAME}_SSLROOTCERT`	Caminho para o certificado raiz SSL do PostgreSQL	—	Não
`DATASOURCE_{NAME}_SSL`	Ativa o TLS em uma conexão MongoDB	—	Não
`DATASOURCE_{NAME}_SSLCA`	Caminho para o arquivo de certificado CA do MongoDB	—	Não
`DATASOURCE_{NAME}_OPTIONS`	Opções adicionais da URI do MongoDB	—	Não
`CRYPTO_HASH_SECRET_KEY_CRM`	Chave de hashing para ler os PII do datasource CRM. Sensível.	—	Não
`CRYPTO_ENCRYPT_SECRET_KEY_CRM`	Chave de criptografia para ler os PII do datasource CRM. Sensível.	—	Não

A seguir está um bloco de semeadura completo por datasource. Defina separadamente a chave global DATASOURCE_CRED_ENC_KEY como descrito acima. Recomendamos usar o mesmo nome para CONFIG_NAME e {NAME}, com o segmento da variável de ambiente em letras maiúsculas (por exemplo, ONBOARDING para CONFIG_NAME=onboarding). Assim a chave de schema fica intuitiva, pois SCHEMAS usa o valor de CONFIG_NAME e todos os outros campos usam {NAME}:

DATASOURCE_ONBOARDING_CONFIG_NAME=onboarding
DATASOURCE_ONBOARDING_TYPE=postgresql
DATASOURCE_ONBOARDING_HOST=midaz-postgres-replica
DATASOURCE_ONBOARDING_PORT=5702
DATASOURCE_ONBOARDING_DATABASE=onboarding
DATASOURCE_ONBOARDING_USER=reporter
DATASOURCE_ONBOARDING_PASSWORD=<secret>
DATASOURCE_ONBOARDING_SCHEMAS=public

Um template então endereça essa fonte pelo config name, como em {{ onboarding.accounts }}. Use a API para adicionar ou atualizar um datasource. No modo single-tenant, um bloco de ambiente apenas semeia uma entrada ausente; ele nunca sobrescreve uma entrada gerenciada pela API nem restaura uma entrada soft-deleted.

Base de configuração compartilhada

Os blocos a seguir são idênticos entre os produtos Lerian e estão documentados por completo na referência de configuração BYOC. Eles vêm desativados.

Autenticação do Access Manager — PLUGIN_AUTH_ENABLED, PLUGIN_AUTH_ADDRESS. Ative em produção.
Multi-tenancy — MULTI_TENANT_*, mais RABBITMQ_MULTI_TENANT_SYNC_INTERVAL e RABBITMQ_MULTI_TENANT_DISCOVERY_TIMEOUT. Desativado por padrão.
Service discovery — SD_* (Consul; o Reporter também aceita os aliases legados SD_ADVERTISE_* / CONSUL_ADDR). Desativado por padrão.
Streaming de eventos — STREAMING_ENABLED, STREAMING_BROKERS, STREAMING_CLOUDEVENTS_SOURCE, mais RABBITMQ_REPORT_EVENTS_EXCHANGE para o exchange de eventos. Desativado por padrão.
OpenTelemetry — ENABLE_TELEMETRY, OTEL_*, OTEL_INSECURE_EXPORTER. A telemetria é push OTLP.

Visão geral

Conceitos

Guias

Integração

Console

Operações

Variáveis de ambiente

Modo de execução e portas

Implantação e TLS

CORS e proxies

Paginação da API

Pré-visualizações de templates

Banco de dados (MongoDB)

Message broker (RabbitMQ)

Object storage (compatível com S3)

Cache (Redis / Valkey)

Renderização de PDF (worker)

Datasources de relatórios

Base de configuração compartilhada

​Modo de execução e portas

​Implantação e TLS

​CORS e proxies

​Paginação da API

​Pré-visualizações de templates

​Banco de dados (MongoDB)

​Message broker (RabbitMQ)

​Object storage (compatível com S3)

​Cache (Redis / Valkey)

​Renderização de PDF (worker)

​Datasources de relatórios

​Base de configuração compartilhada

Modo de execução e portas

Implantação e TLS

CORS e proxies

Paginação da API

Pré-visualizações de templates

Banco de dados (MongoDB)

Message broker (RabbitMQ)

Object storage (compatível com S3)

Cache (Redis / Valkey)

Renderização de PDF (worker)

Datasources de relatórios

Base de configuração compartilhada