Esta página foi traduzida por máquina. Leia o original em inglês. English

Este guia é para as pessoas que usam o console do HQ Monitor: DBAs, engenheiros de suporte e administradores. Ele mostra cada página do console, explica o que você vê nela e mostra como usar as páginas para encontrar um problema.

O HQ Monitor é um console web para servidores Firebird. Ele não se conecta ao Firebird. Ele mostra os dados que o agente HQbird (fbagent) coleta em cada servidor: CPU e memória, conexões, transações, trace, logs, estatísticas e relatórios do gstat.

Sobre as imagens. As imagens vêm de um console em funcionamento (HQ Monitor 1.57.0, agentes 3.4.0, editor de configuração 1.61.0) com o modo demo ativado (veja Configurações). Elas mostram 12 horas de trabalho (08:00-20:00) do dia anterior ao das capturas. A exceção é a página Servers: ela não tem seletor de dia e sempre mostra as horas mais recentes (nas imagens, 00:00-02:44 do dia da captura). Nomes de servidores, bancos de dados e processos e caminhos nas imagens são palavras inventadas do mesmo comprimento que as reais, por exemplo siserikoditobefikepebur. O modo demo também altera algumas palavras da interface do usuário, por exemplo “Security” em Security.fdb/Users; este texto usa os nomes reais. Endereços IP começam com 192.168. Valores secretos estão ocultos. Neste texto, SRV representa um nome de servidor e employee um nome de banco de dados.


Conteúdo

  1. Como o HQ Monitor funciona
  2. Entrar e controles gerais
  3. Página Servers
  4. Dashboard do servidor
  5. Páginas do banco de dados
  6. Estatísticas: relatórios e tendências do gstat
  7. Ferramentas do servidor: Logs, Configs, Errors, Conflicts, Perf Report
  8. Relatório de saúde do servidor
  9. Editor de configuração do agente, Backups e Activity
  10. Licenças
  11. Administração: usuários, clusters, notificações e atualizações
  12. Instalação e configurações para administradores
  13. Solução de problemas

1. Como o HQ Monitor funciona

De onde vêm os dados

Where the data comes from
  • O agente coleta os dados no servidor Firebird e os grava em arquivos.
  • Em um centro de coleta, os agentes enviam seus arquivos por meio do goafts. Os arquivos chegam à pasta de dados do console (data_path), uma pasta por servidor.
  • Ao lado de um agente (instalação local), o console lê a pasta desse agente diretamente. Veja LOCAL_INSTALL.md.
  • O console apenas lê arquivos. Ele nunca se conecta ao Firebird.
  • As alterações vão no sentido oposto (linhas tracejadas). Em um centro de coleta, uma alteração de configuração, uma solicitação Run now ou uma licença vai para o goafts. O agente a recebe na próxima sincronização, geralmente em até um minuto. Em uma instalação local, o console entrega essas alterações diretamente ao agente ao lado dele.

As páginas são as mesmas nos dois tipos de instalação.

Mapa das páginas

Page map
  • O dashboard tem dois caminhos para o relatório de saúde do servidor:
    • Server status na barra de tempo abre o relatório do snapshot de status mais recente no intervalo de tempo;
    • Report for this minute (abaixo do minuto selecionado) abre o relatório do snapshot que cobre aquele minuto.
  • Toda página de servidor tem o mesmo menu de cabeçalho: Logs, Configs, Errors, Conflicts, Perf Report, Jobs e Backups. As páginas do banco de dados também o têm. Veja Cabeçalho e linha de breadcrumb.
  • O ícone de engrenagem no cabeçalho abre as Configurações a partir de qualquer página.
  • As páginas do banco de dados têm uma linha abaixo do cabeçalho com o nome do banco de dados e as páginas do banco de dados. O item Performance report abre o Perf Report do servidor para aquele banco de dados.

Uma investigação típica

A typical investigation
  1. Comece na página Servers. Procure um status vermelho ou laranja.
  2. Abra Report para esse servidor. As descobertas mostram o que o agente viu.
  3. Abra o dashboard. Encontre o horário do problema nos gráficos.
  4. Clique nesse ponto (veja Selecionar um minuto). Os gráficos marcam esse minuto, e as tabelas das linhas de banco de dados abertas mostram esse minuto.
  5. Abra a linha do banco de dados. Leia as consultas mais pesadas e as conexões desse minuto.
  6. Vá para a página que se adequa ao problema.

2. Entrar e controles gerais

Entrar

The sign-in page
A página de entrada

O que você vê

  1. O cabeçalho: o logotipo HQbird com a versão do console abaixo dele (aqui 1.57.0), e a lista de idiomas (EN) à direita.
  2. A caixa de entrada: Login, Password e o botão Sign in.

Para entrar:

  1. Abra o endereço do console em um navegador, por exemplo http://192.168.0.10:8080. Seu administrador fornece o endereço e a porta.
  2. Digite Login e Password, depois clique em Sign in.
  3. O console abre a página Servers.

Como a sessão funciona:

  • O nome de login não diferencia maiúsculas de minúsculas.
  • Uma sessão dura 7 dias. Depois disso, ou após o console reiniciar, você entra novamente.
  • O navegador mantém a sessão em um cookie com o nome da porta do console, por exemplo fbmonitor_auth_8080. Assim, dois consoles em um mesmo host (em portas diferentes) mantêm sessões separadas. Ao entrar em um, você permanece conectado ao outro.
  • Log out (canto superior direito de cada página) encerra todas as sessões do seu login, em todos os navegadores. No modo de usuário único, há apenas um login, então Log out desconecta todos que usam este console.
  • Quando a senha muda (na página Configurações ou no host do agente), todas as outras sessões terminam. Esses navegadores entram novamente.
  • No modo de usuário múltiplo (veja Usuários), o console verifica sua conta em cada requisição. Quando um administrador exclui sua conta ou define uma nova senha para ela, suas sessões terminam.

De onde vem a senha no modo de usuário único: o console verifica a senha que o agente local mantém, como hash, em seu agent_config.json (fbagent 2.80.0 ou mais recente). O agente a grava na configuração e quando importa o access.properties do FBDataGuard. Sem ela, o console lê o access.properties como antes.

Se você entrar com uma senha fraca no modo único, uma linha abaixo do cabeçalho diz Your password is weak, change it. Uma senha fraca é a senha padrão do FBDataGuard strong password, uma senha com menos de 7 caracteres, ou uma sem letra ou sem dígito. A linha leva a Change password na página de Configurações. Quando o console não consegue alterar a senha, a linha indica o comando a executar no host do agente: fbagent --reset-hqmonitor-password.

Mensagens que você pode ver

Mensagem O que significa
Invalid login or password Login ou senha incorretos.
Too many login attempts. Try again in 15 minutes 8 tentativas falhas do seu endereço em 15 minutos. Aguarde e tente novamente. Uma entrada bem-sucedida zera a contagem.
access.properties is missing or cannot be read Modo de usuário único: o console não encontrou nenhuma senha, nem no agent_config.json do agente nem no access.properties. Consulte o administrador.
users.enc is missing or cannot be read Modo de usuário múltiplo: o arquivo de usuários está ausente ou danificado. Consulte o administrador.

Cabeçalho e linha de breadcrumb

Toda página após a entrada tem um cabeçalho no topo. Em uma página de servidor (o dashboard, as páginas do banco de dados, as ferramentas do servidor), ele tem, da esquerda para a direita:

  1. O logotipo HQbird com a versão do console. Em uma build de release, aponte para a versão para ver o número da build e o horário da build, por exemplo build 128 · 2026-09-04 03:12 UTC.
  2. ← Servers: retorna à página Servers.
  3. O nome do servidor. Clique nele para abrir o dashboard do servidor.
  4. O menu: Logs, Configs, Errors, Conflicts, Perf Report, Jobs e Backups. A página em que você está fica destacada. Jobs e Backups aparecem apenas quando o console consegue abrir o editor de configuração para este servidor.
  5. À direita: o ícone de engrenagem (Configurações), Log out e a lista de idiomas.

A linha do banco de dados. Uma página de banco de dados tem mais uma linha abaixo do cabeçalho. Ela começa com o rótulo DB e o nome do banco de dados, depois vêm as páginas do banco de dados. O menu do servidor acima dela permanece como está, então os logs ou os erros do servidor estão a um clique de distância. Veja Páginas do banco de dados.

Outras páginas têm um cabeçalho mais curto:

Página Cabeçalho
Servers Logotipo, ícone de engrenagem, Log out, idioma. Sem ← Servers, sem menu.
Licenses, Updates, Notifications, User management, Clusters Logotipo, ← Servers, ícone de engrenagem, Log out, idioma. Sem nome de servidor, sem menu.
Configurações O cabeçalho da última página de servidor que você abriu nesta aba do navegador, sem o nome do servidor.
Editor de configuração (Jobs, Backups, Activity) O cabeçalho completo do servidor. Veja capítulo 9.

A linha de breadcrumb. Abaixo do cabeçalho, uma linha fina mostra onde você está. Ela sempre começa com Servers. Clique em qualquer etapa para voltar a ela. A última etapa é a página em que você está. Exemplos:

  • Servers › SRV: o dashboard do servidor;
  • Servers › SRV › Logs: uma ferramenta do servidor;
  • Servers › SRV › employee › Statistics › Report: uma página do banco de dados;
  • Servers › SRV › Jobs › Activity: o editor de configuração;
  • Servers › Licenses, Servers › Users › Add user, Servers › Settings: páginas que não são sobre um servidor.

Aponte para uma etapa de servidor ou banco de dados para ver seu nome completo. A página Servers e a página de entrada não têm linha de breadcrumb.

Linhas abaixo do cabeçalho. Abaixo da linha de breadcrumb, o console pode mostrar estas linhas (não nas páginas do editor de configuração):

  • a linha de licença vermelha, quando um agente interrompeu tarefas de licença: “No license. Backups, restore, sweep, tracing, statistics and replication are stopped. The databases work.”;
  • a linha de avaliação amarela, quando uma avaliação termina em 7 dias ou menos: “Trial: 5 days left. To extend it to 30 days, enter a work email.”;
  • a linha de senha fraca (somente no modo de usuário único, veja Entrar).

As linhas de licença e de avaliação indicam até três servidores e o link License page ou Enter an email. Veja O banner de licença.

Idioma

Use a lista de idiomas (EN) no canto superior direito. Ela mostra RU, EN, DE, PT e ES: russo, inglês, alemão, português (Brasil) e espanhol.

  • Na primeira visita, o console usa o idioma do navegador, se estiver na lista. Caso contrário, usa inglês.
  • O navegador mantém sua escolha por um ano (cookie fbmonitor_lang).
  • Os relatórios de estatísticas também seguem esse idioma.

Configurações (ícone de engrenagem)

O ícone de engrenagem abre Settings. Densidade de exibição, esquema de cores e modo demo

aplicar somente a este navegador. A página mantém o nome do servidor e o menu do servidor de onde você veio, para que você possa voltar a ele com um clique.

Settings: display density, color scheme and demo mode
Settings: display density, color scheme and demo mode

O que você vê

  1. O cabeçalho da última página de servidor (sem o nome do servidor) e a linha de navegação Servers › Settings.
  2. Display density: quatro opções, cada uma com uma breve descrição.
  3. Color scheme: três opções.
  4. Demo mode: uma descrição e a caixa de seleção Hide server and database names and paths.
  5. Console password: somente no modo de usuário único, por isso não está na imagem.

A opção selecionada tem uma moldura azul. Cada clique é salvo imediatamente, e o console mostra Saved por um instante. O navegador mantém a densidade e o esquema de cores por um ano. O modo de demonstração permanece ativo neste navegador até você desativá-lo.

  • Display density: o tamanho do texto e das linhas da tabela em todas as páginas. Os rótulos dos eixos e as legendas dos gráficos também o seguem.

    • Old style: a aparência original.
    • Compact: texto menor, linhas mais compactas, mais linhas na tela.
    • Normal (padrão): tamanhos de texto equilibrados.
    • Sparse: texto maior e mais espaço.
  • Color scheme: Light (padrão), Dark, High contrast (texto preto e bordas sólidas sobre branco).

  • Demo mode: Hide server and database names and paths. Use-o quando você mostrar o console para outras pessoas.

    • Nomes de servidores, bancos de dados e processos e caminhos tornam-se palavras inventadas do mesmo comprimento.
    • Endereços IP começam com 192.168..
    • Logs e texto SQL também são mascarados. Valores de texto em SQL (entre aspas) são substituídos; nomes de tabelas e colunas permanecem.
    • Texto livre é mascarado em todas as páginas: o resumo da IA, o relatório de integridade, os arquivos de configuração, as páginas de licença e de cluster, o editor de configuração e os relatórios de estatísticas. As chaves de configuração permanecem como estão.
    • A linha de navegação mostra os nomes mascarados.
    • Um campo de formulário mostra o valor mascarado, mas mantém o real. Um campo que tem um valor não pode ser editado enquanto o modo de demonstração estiver ativo.
    • Os botões de cópia para caminhos e SQL ficam ocultos. O botão Export CSV na página Errors também fica oculto.
    • Somente a tela muda. O endereço do navegador e os dados permanecem como estão. O modo fica desativado por padrão.
  • Console password (somente no modo de usuário único): altera a senha do login do console.

    1. Digite Current password.
    2. Digite New password e Repeat the new password: pelo menos 7 caracteres, com letras e dígitos.
    3. Clique em Change password.

    O agente armazena a nova senha como um hash em seu agent_config.json. Isso requer o fbagent 2.80.0 ou mais recente na mesma máquina. Todas as outras sessões são desconectadas. Uma senha atual incorreta conta como uma tentativa de login malsucedida, com o mesmo limite da página de login. A alteração é gravada no log de auditoria. Quando o console não consegue alterar a senha, o bloco informa o motivo; então execute fbagent --reset-hqmonitor-password no host do agente.

Mensagens que você pode ver (Console password)

Mensagem O que significa
Password changed. Other sessions are signed out. Concluído. Use a nova senha a partir de agora.
The current password is wrong. Verifique Current password.
The two new passwords are different. New password e Repeat the new password devem ser iguais.
The new password is weak: use at least 7 characters with letters and digits. Escolha uma senha mais longa com letras e dígitos.
The new password is the current one. Escolha uma senha diferente.
The new password is empty. / The new password is too long. Digite uma senha de comprimento normal.
Too many attempts. Try again later. Muitas tentativas malsucedidas do seu endereço. Aguarde até 15 minutos.
The password cannot be changed here: … O console não consegue alterá-la (o motivo segue). Execute fbagent --reset-hqmonitor-password no host do agente.
The agent did not apply the new password; nothing was changed. O agente recusou a alteração. A senha antiga ainda funciona.

Hora e fuso horário

  • As páginas de servidor mostram a hora no fuso horário do servidor, não no do seu navegador. Um selo próximo aos controles de hora mostra o deslocamento do fuso, por exemplo UTC+03:00. Passe o mouse sobre o selo para ver o nome do fuso.
  • A página Servers usa o fuso horário da máquina do console. O relógio à direita mostra a hora atual nesse fuso. Consulte Date and time range.
  • A maioria das páginas tem os mesmos controles de hora:
    • o botão de data (Choose date, depois a data escolhida) abre um calendário. Somente dias que têm dados podem ser selecionados. Um calendário sem dados mostra No data;
    • From e To definem o intervalo de tempo dentro desse dia, em passos de um minuto. Se From não for anterior a To, To passa para um minuto depois de From;
    • a lista de predefinições define um intervalo típico. Selected fica ativo quando você define From e To manualmente.
  • Um intervalo nunca atravessa a meia-noite.

As predefinições funcionam de forma diferente em cada página:

Página Predefinições Padrão Como uma predefinição define o intervalo
Servers Last 6h, Last 12h, Full day Last 6h Conta para trás a partir do relógio para hoje, ou a partir de 23:59 para um dia passado.
Dashboard, Database, Metrics Last 1h, Last 6h, Last 12h, Full day Last 1h Conta para trás a partir do último ponto de dados do dia escolhido.
Logs Full day, Last 1h, Last 6h, Last 12h Full day Last 1h termina na entrada mais recente. Last 6h é sempre 18:00–23:59, Last 12h é sempre 12:00–23:59.
Errors Full day, Last 1h, Last 6h, Last 12h Last 1h Last 1h termina no erro mais recente do dia. Last 6h e Last 12h como em Logs.

Conflicts, Perf Report e Clients Versions têm apenas o botão de data e o selo do fuso horário.

As páginas não são atualizadas sozinhas. Para ver novos dados, pressione F5 ou altere a data ou o intervalo de tempo.


3. Página Servers

A página Servers (/servers) é a página inicial. Ela lista todos os servidores que você pode ver. No modo multiusuário, uma conta vê apenas os servidores que seu administrador lhe concedeu.

The Servers page
The Servers page

O que você vê

  1. O cabeçalho: o logotipo com a versão, o ícone de engrenagem, Log out e a lista de idiomas. Esta página não tem ← Servers nem linha de navegação.
  2. A linha de licença, somente quando um agente interrompeu tarefas de licença ou uma avaliação termina em breve (consulte Header and breadcrumb line).
  3. A linha superior:
    • User management (administradores no modo multiusuário, consulte Users), Clusters (administradores, consulte Clusters), Licenses (todos, consulte Licenses), Updates e Notifications (todos, consulte Updates e Notifications);
    • os controles de hora: o selo do fuso horário, a data, From — To, a lista de predefinições e o relógio (consulte Date and time range).
  4. A linha de seção: Servers com o número de servidores (aqui 51), a caixa de pesquisa Search servers… e Collapse all.
    • A pesquisa encontra texto no nome do servidor ou no caminho da pasta. Maiúsculas e minúsculas não importam. Enquanto você pesquisa, o número mostra os servidores encontrados e todos os servidores, por exemplo 1 / 51.
    • Collapse all fecha todas as linhas abertas. Ele aparece somente enquanto uma linha está aberta.
  5. A linha de resumo: quantos servidores têm cada nível, e quantos não enviam dados, por exemplo 2 serious · 22 warning · 2 ok · 25 no data.
  6. A tabela de servidores, uma linha por servidor. Uma lista longa rola dentro da tabela. Os servidores que não enviam dados ficam na parte inferior.

Data e intervalo de tempo

  • O selo mostra o deslocamento do fuso horário da máquina do console, por exemplo UTC+03:00; o nome do fuso está na dica. O relógio à direita mostra a hora atual nesse fuso e é atualizado a cada segundo.
  • A data abre no dia mais recente que tem dados em qualquer servidor.
  • As predefinições são Last 6h (padrão), Last 12h e Full day. Não há Last 1h nesta página. Para hoje, uma predefinição conta para trás a partir da hora atual; para um dia passado, a partir de 23:59. O intervalo começa no máximo às 00:00. Full day é 00:00 até agora (hoje) ou 00:00 até 23:59.
  • A data e o intervalo de tempo se aplicam às linhas abertas (a faixa de status e os gráficos) e ao dia do relatório que o selo de status abre.
  • A coluna Status sempre mostra o status mais recente do agente, em qualquer data.

A tabela

Coluna O que mostra
Server name O nome do agente, o link Details para o dashboard, e a pasta de dados do servidor em data_path. Um nome ou caminho longo é encurtado no meio; aponte para ele para vê-lo por completo.
DB O número de bancos de dados, ou “—” quando o agente não o informou.
Server/Agent version/Remote control Primeira linha: a versão do Firebird, por exemplo WI-V5.0.5.1880 Firebird 5.0 HQbird, e o modo em que o Firebird é executado: SuperServer, SuperClassic ou Classic. Segunda linha: a versão do agente, o link Jobs e o status de entrega da última alteração de configuração.
License O estado da licença que o agente informa, e a data que importa abaixo dele. Clique nele para abrir a página License do servidor.
Status O selo de nível do servidor (um link para o relatório), o título do veredito do agente e a idade do último status.

Server/Agent version/Remote control. Aponte para a célula para ver ambas as versões por completo.

  • O modo vem do agente, fbagent 2.94.0 ou mais recente. Com um agente mais antigo, a linha mostra apenas a versão.

  • Quando firebird.conf define outro modo, uma seta o mostra, por exemplo SuperServer → Classic. Aponte para a seta: “firebird.conf sets Classic: it takes effect after a Firebird restart”.

  • Jobs abre o editor de configuração. Ele aparece somente quando o console consegue abrir o editor para este servidor.

  • O selo de entrega mostra até onde chegou a última alteração de configuração: SENT, TAKEN, APPLIED, RESTART NEEDED, REJECTED, ALREADY SET, SUPERSEDED, UNKNOWN ou NOT READ. Consulte Delivery status.

  • Após o selo: push 11:10 · ack 11:10, a hora em que a alteração foi enviada e a hora em que o agente a confirmou. Esses horários estão no fuso horário do console. DRIFT 15′ significa que o agente não respondeu por 15 minutos.

  • Aponte para o selo para ver o motivo do agente e os horários exatos.

  • “—”: nenhuma alteração de configuração foi enviada a este servidor.

  • HQCenter link is not set: o console não consegue mostrar a entrega. Aponte para ele para ver o motivo.

License. O selo mostra o estado, por exemplo LICENSED, UNLICENSED ou NO DATA.

  • Abaixo do selo: a data que importa para o estado, por exemplo a data de expiração ou o fim da avaliação. Quando faltam 60 dias ou menos, os dias aparecem em seguida, por exemplo 2026-12-01 (26 d).
  • ⚠ após o selo: o relatório de licença do agente tem mais de 72 horas.
  • Aponte para a célula para ver o motivo, o cliente, Enforcement is off: nothing is blocked. quando for o caso, e Jobs that need a license: N.

Status. O selo de nível (consulte Status colors), o

manchete e a idade do status.

  • O selo é o nível do servidor, a partir do veredito do agente (esquema do fbagent 26 ou mais recente). Um agente mais antigo não envia veredito: então o selo mostra sua severidade antiga.
  • Quando o nível do próprio agente é pior, um segundo selo pequeno o mostra, por exemplo Agent: WARNING. Problemas do agente (fila de upload, fontes, autoatualização) não alteram o nível do servidor.
  • Clique no selo para abrir o relatório de integridade do servidor do snapshot mais recente do dia selecionado.
  • Sob o selo: a manchete do veredito, por exemplo “no registered backups for employee.fdb”. Aponte para ela para ver o texto completo.
  • A última linha é a idade do status, por exemplo 9 min ago. Aponte para ela para ver o horário completo. Quando o fuso horário do agente difere do da console, a dica também mostra o deslocamento do agente naquele momento.
  • no data since <time>: o status mais recente tem mais de 30 minutos (3 ciclos do agente). O selo é cinza e mostra o horário do último status, não um nível. A linha não tem manchete. Clique no selo para abrir o último dia com dados.
  • Uma mudança de idioma redesenha os selos e a linha de resumo.

Cores de status

O agente calcula o status. A console apenas o exibe.

Selo Cor Significado
CRITICAL, SERIOUS Vermelho Um problema sério. Aja agora.
WARNING, MINOR Laranja Algo precisa de atenção.
OK Verde Nenhum problema encontrado.
INFO, — Cinza Sem status, ou um status informativo.

| no data since … | Cinza | O agente não enviou status por mais de 30 minutos. |

O status vem do arquivo de status mais recente do agente. Um selo cinza no data since significa que o agente parou de enviar dados.

Abrir uma linha de servidor

Clique em uma linha (ou no triângulo à sua esquerda) para abri-la. Clique novamente para fechá-la. Você pode abrir várias linhas. Os links em uma linha (Details, Jobs, o selo de licença, o selo de status) não abrem a linha.

Uma linha aberta mostra, para a data e o intervalo de tempo selecionados:

  1. SERVER STATE BY SERVER_STATUS SNAPSHOTS: a faixa de status.
  2. CPU LOAD / LOAD AVERAGE / MEMORY: um gráfico.
  3. CONNECTIONS & DATABASES: um gráfico.
A server row with its charts
A server row with its charts

A faixa de status é uma barra de células coloridas, uma célula para cada snapshot de status do agente (ou para um grupo de snapshots quando o intervalo é longo; um grupo assume a cor do seu pior snapshot). Os rótulos de tempo sob a barra estão no fuso horário do servidor.

  • verde, laranja, vermelho: o nível do servidor daquele snapshot (OK, WARNING, SERIOUS). Problemas do agente (fila, fontes, atualização) não colorem a faixa.
  • hachurado: nenhum snapshot naquele momento (o agente não enviou dados).
  • vazio: nenhum dado (antes do snapshot mais antigo, ou no futuro).

Aponte para uma célula para ver o horário, o nível, a manchete e as áreas de problema, por exemplo 10:20–10:30 · SERIOUS · … · Disk speed, Locks. Clique em uma célula para abrir o relatório de integridade do servidor daquele snapshot.

  • Com o teclado: Tab até a faixa, depois as teclas de seta, Home e End. Enter abre o relatório, Escape oculta a dica.
  • Em uma tela sensível ao toque, o primeiro toque mostra a dica, o segundo toque abre o relatório.

Tanto o selo de status quanto a faixa mostram o nível do servidor. O nível do agente é apenas o pequeno selo Agent:.

Os gráficos também usam o fuso horário do servidor. Quando o fuso do servidor difere do da console, os horários sob a faixa e os gráficos diferem do intervalo no topo. Na imagem, ambos os fusos são UTC+03:00, então o intervalo 00:00–02:44 é o mesmo nos dois relógios. A predefinição é Last 6h, mas o intervalo começa às 00:00, o início do dia.

  • CPU Load / Load Average / Memory: legenda CPU %, Load Avg, RAM %. CPU em porcentagem (barras), load average e memória em porcentagem (linhas), em uma escala de 0–100. Uma barra de CPU é verde até 70%, laranja de 70% a 90%, e vermelha a partir de 90%. Um minuto sem dados não tem barra. A dica da linha de memória também mostra a RAM usada e total, por exemplo RAM %: 63 (10.1 GB / 16.0 GB). O Windows não tem load average: o gráfico é CPU Load / Memory, sem essa linha.
  • Connections & Databases: legenda Connections e Databases. O número de conexões e de bancos de dados ativos.

Aponte para um gráfico para ver todos os valores daquele minuto em uma caixa acima do gráfico. Quando você altera a data ou o intervalo de tempo, todas as linhas abertas são recarregadas.

Mensagens na página Servers

Mensagem O que significa
No server_status snapshots for this interval A faixa não tem snapshots de status no intervalo, ou eles não podem ser carregados. Escolha um intervalo maior ou outra data.
Loading… O gráfico está carregando.
No data O gráfico não tem dados no intervalo.
Error Os dados do gráfico não podem ser carregados. Pressione F5.
No data / cannot load servers A lista de servidores não pode ser carregada. O texto do erro vem a seguir. Pressione F5; se persistir, pergunte ao administrador.
Waiting for the first data from the agent Nenhum servidor enviou dados para esta console ainda, por exemplo logo após uma nova instalação. Isso leva de 1 a 2 minutos. A página verifica novamente a cada 10 segundos e abre a tabela sozinha quando um servidor aparece.
Still no data after 5 minutes. Check that the HQbird agent service is running and that it sends data to this console. Aparece sob a mensagem acima após 5 minutos. Verifique o serviço do agente e o endereço da console dele.
“—” em Status A console não consegue ler um arquivo de status deste servidor (nenhum ainda, ou ele está danificado).
no data since <time> (Status) O status mais recente deste servidor tem mais de 30 minutos. Verifique se o serviço do agente está em execução e enviando dados.
NO DATA (License) O agente não relatou um estado de licença.
HQCenter link is not set (Remote control) A console não consegue mostrar a entrega de configuração. Aponte para ele para ver o motivo.

Dicas

  • Digite parte de um nome em Search servers… para encontrar um servidor em uma lista longa.
  • Um selo cinza no data since significa que o agente parou de enviar dados. Abra a linha: células hachuradas na faixa mostram quando ele parou.
  • A linha de resumo conta os servidores por nível. Os servidores sem dados ficam na parte inferior da tabela.
  • Para comparar a carga de vários servidores, abra suas linhas uma sob a outra.

4. Dashboard do servidor

O dashboard (/dashboard?server=<name>) mostra um servidor. Abra-o com o link Details na página Servers. A página abre com hoje e o intervalo de tempo Last 1h.

The server dashboard with all cards closed
The server dashboard with all cards closed

O que você vê (a imagem mostra o intervalo 08:00–20:00 definido manualmente, então a lista de predefinições mostra Selected):

  1. O cabeçalho: ← Servers, o nome do servidor e o menu de ferramentas do servidor (veja Header).
  2. A linha de navegação estrutural: Servers › SRV.
  3. A barra de tempo. À esquerda: a versão do Firebird e Root. À direita: Server status com seu selo e manchete, o fuso horário, a data, o horário de início e fim, e a predefinição de tempo.
  4. Dois gráficos que estão sempre abertos: CPU % / Load Avg / RAM % e Connections / Databases.
  5. Os cartões que você pode abrir e fechar: CPU usage details (10 min), Who uses the disk (10 min), Who uses memory (10 min), Temp files, Disk space, Read/write latency com a lista de discos, e Read/write speed.
  6. A tabela de bancos de dados: Databases com sua contagem, a caixa de pesquisa e uma linha por banco de dados.

A barra de tempo:

  • A versão do Firebird, por exemplo LI-V4.0.5 Firebird 4.0. Ela mostra — quando a versão não é conhecida.
  • Root: a pasta do Firebird no servidor, por exemplo /opt/firebird. Ela fica oculta quando o agente não a enviou.
  • Server status: veja Server status.
  • O fuso horário dos horários do servidor na página. Veja Time and time zone.
  • O botão de data: escolha outro dia no calendário.
  • O horário de início e fim: defina o intervalo manualmente.
  • A predefinição de tempo: Last 1h (o padrão), Last 6h, Last 12h, Full day e Selected. Selected fica ativo somente depois que você define o horário de início ou fim manualmente.

Cartões fechados e abertos

Sete cartões podem ser fechados: CPU usage details, Who uses the disk, Who uses memory, Temp files, Disk space, Read/write latency e Read/write speed. Todos eles começam fechados: uma linha fina com o título e More. A imagem acima mostra esta visualização padrão. A imagem abaixo mostra a mesma página com todos os cartões abertos.

The server dashboard with all cards open
The server dashboard with all cards open
  • Para abrir um cartão, clique na linha do título ou em More.
  • Para fechá-lo, clique em Less ou na linha do título novamente.
  • O navegador mantém a lista de cartões abertos no cookie fbmonitor.dashboard.open por 365 dias. A lista é a mesma para todos os servidores: um cartão que você abre em um servidor fica aberto nos outros servidores também.
  • A linha sob o título (o horário do snapshot, a CPU do host, a RAM e assim por diante) aparece somente quando o cartão está aberto.
  • A lista de discos de Read/write latency permanece na linha do título quando o cartão está fechado. Você pode escolher um disco sem abrir o cartão. Um clique na lista não abre nem fecha o cartão.
  • Um cartão aparece somente quando tem dados. Por exemplo, um agente que não envia a lista de programas não mostra o cartão CPU usage details.

Layout. A partir de uma largura de 769 px, os cartões ficam em duas colunas iguais. Who uses the disk fica na coluna da direita, também quando CPU usage details não é mostrado. Who uses memory ocupa a largura total. Em um telefone há um cartão por linha.

  • ← Servers à esquerda retorna à lista de servidores. Todas as outras páginas de servidor também têm este botão.
  • O nome do servidor.
  • O menu de ferramentas do servidor: Logs, Configs, Errors, Conflicts, Perf Report, Jobs e Backups. Jobs e Backups aparecem somente quando a configuração do agente deste servidor está disponível. Nas outras páginas de servidor, o menu marca a página em que você está.
  • À direita: o ícone de engrenagem (veja Settings (gear icon)), Log out e a lista de idiomas.
  • A linha de navegação estrutural sob o cabeçalho: Servers › SRV no dashboard, Servers › SRV › Logs em uma página de ferramenta. Todos os passos, exceto o último, são links; Servers retorna à lista de servidores.
  • Um banner de licença vermelho ou amarelo pode aparecer sob a linha de navegação estrutural quando um servidor não tem licença ou seu período de teste termina em breve.

Server status

Server status na barra de tempo abre o relatório de integridade do servidor do snapshot de status mais recente no intervalo selecionado.

  • O selo ao lado dele é o nível daquele snapshot, por exemplo WARNING. Aponte para ele para ver Last snapshot: HH:MM.

  • Após o selo, uma linha mostra a manchete daquele snapshot e os sistemas com constatações, por exemplo “vbackup job … failed on …”. Aponte para ela para ver o texto completo. Clique nela para abrir o relatório daquele snapshot. No modo demo, os nomes nela são mascarados.

  • Quando o intervalo não tem snapshot, não há selo nem manchete. O link então abre o relatório da data selecionada.

  • A faixa de snapshots por minuto está na página Servers e no próprio relatório.

Gráficos do servidor

Os gráficos não têm números no eixo de valores, apenas os horários abaixo dele: aponte para um gráfico para ver os valores com suas unidades. As legendas são curtas, porque o título do card já diz o que é o gráfico. Aponte para um item da legenda para ver seu nome completo.

Aponte para um gráfico para ver todos os valores daquele minuto. A caixa aparece acima do gráfico, para não cobrir as linhas (abaixo dele quando a janela não tem espaço acima).

Mensagens que você pode ver:

Mensagem O que significa
No data / cannot load dashboard O console não conseguiu carregar os dados deste servidor. A caixa lista as Requests e o Diagnostics: uma linha por fonte de dados com OK ou MISSING. Verifique se o agente envia dados.

CPU % / Load Avg / RAM %

Sempre aberto. Um ponto por minuto.

Linha O que mostra
CPU % A carga do processador do host, como barras. Uma barra é verde até 70%, laranja de 70% a 90% e vermelha a partir de 90%. Cinza significa sem dados.
Load Avg A carga média do host. O Windows não tem carga média: sem linha e sem item de legenda.
RAM % O uso de memória. A dica acrescenta a memória usada e a total, por exemplo RAM %: 63 (10.1 GB / 16.0 GB).
New RAM % basis Uma linha tracejada âmbar no minuto em que o agente mudou a forma de contar a RAM %. O item de legenda aparece apenas quando o intervalo tem esse minuto.
  • No Linux o agente conta a memória usada como total − disponível, então tmpfs e memória compartilhada entram nela (fbagent 2.93.0 e mais recente).
  • Um agente que contava da forma antiga passa para a nova base quando é atualizado. A dica naquele minuto diz: The agent changed how RAM % is counted (now: total − available). The step here is not a change of memory use. A mesma marca está no gráfico Memory by kind de Who uses memory.

Connections / Databases

Sempre aberto. Um ponto por minuto.

Linha O que mostra
Connections O número de conexões com todos os bancos de dados do servidor.
Databases O número de bancos de dados ativos.

CPU usage details

O card CPU usage details (10 min) mostra como o host usou sua CPU nos 10 minutos anteriores a um snapshot de status do servidor:

  • sem minuto selecionado: o snapshot mais recente do intervalo;
  • com um minuto selecionado: o snapshot cujos 10 minutos contêm esse minuto.

Os cards Who uses the disk e Who uses memory usam o mesmo snapshot.

The CPU usage details card
The CPU usage details card

O que você vê:

  1. A linha 10 minutes to 20:00 · Host CPU 1.9%: o fim dos 10 minutos e a CPU média de todo o host. Host CPU unknown quando o agente não conseguiu lê-la.
  2. Uma barra da CPU do host com sua legenda: Firebird, Agent, Other, Short e Idle, cada uma com seu percentual. Short são processos que começaram e terminaram entre duas passagens do agente: curtos demais para nomear. Idle aparece apenas quando a CPU do host é conhecida.
  3. A tabela de programas (veja as colunas abaixo).
  4. No Linux: Firebird disk IO: read 57.9 KiB/s, write 811.2 KiB/s, a leitura e a escrita em disco dos processos do Firebird. A escrita é — quando o agente não a enviou (um agente anterior a 2.89.0, ou os primeiros minutos após uma atualização).
  5. CPU by kind over the range: a mesma divisão de CPU para cada snapshot do intervalo, como áreas empilhadas Firebird, Agent, Other e Short, com a linha Host (CPU do host).
Coluna O que mostra
Program O nome do programa. A linha do Firebird é destacada.
Kind Firebird, agent, kernel ou other.
Processes Quantos processos deste programa rodaram.
CPU avg A CPU média do programa nos 10 minutos, em % de todo o host.
CPU max A maior CPU do programa nos 10 minutos, em % de todo o host.
Memory A memória que os processos do programa ocupam (RSS).
% RAM Essa memória em % da RAM do host.

Mensagens que você pode ver:

Mensagem O que significa
This snapshot has no list of programs (an older agent, or system_metrics.programs is off). Outros snapshots do intervalo têm a lista, este não. Selecione outro minuto, atualize o agente ou ative a opção.
  • O card precisa do fbagent 2.89.0 ou mais recente e da opção CPU and memory by program (system_metrics.programs) na aba Settings da configuração do agente.
  • Quando nenhum snapshot do intervalo tem a lista, não há card.

Who uses the disk

O card Who uses the disk (10 min) mostra quem movimentou os bytes de um disco nos 10 minutos do snapshot de CPU usage details. O disco é o que você escolhe na lista de Read/write latency.

The Who uses the disk card
The Who uses the disk card

A imagem mostra o card em um servidor Linux onde a contabilização de IO está desativada: o card diz isso e fornece o comando que a ativa (veja as mensagens abaixo).

O que você vê quando o agente tem dados:

  1. A linha 10 minutes to 19:50 · disk sda: read 38.5 KiB/s, write 15.7 MiB/s · by systemd service: o fim dos 10 minutos, a leitura e a escrita de todo o disco e a origem das linhas. by systemd service no Linux (uma linha é um serviço systemd), by process (ETW) no Windows (uma linha é um processo).
  2. A tabela (veja as colunas abaixo).
  3. A linha Not in the rows: 2.1 MiB/s (other services, the kernel): os bytes do disco que nenhuma linha explica.
Coluna O que mostra
Service O serviço ou processo. A linha do Firebird é destacada.
Kind Firebird, agent, other ou user session. · shared significa que outros programas rodam no mesmo grupo, então esses bytes não vêm apenas deste serviço.
Programs Os programas da linha. Aponte para a célula para ver a lista completa.
Read/s Bytes lidos por segundo.
Write/s Bytes escritos por segundo.
% of disk A participação da linha em todos os bytes do disco.

Mensagens que você pode ver:

Mensagem O que significa
IO accounting is off, so the agent cannot see who uses the disk. Turn it on: sudo systemctl set-property <unit> IOAccounting=yes O Linux não conta IO por serviço. Execute o comando uma vez no servidor. A unit é o serviço do agente; <agent unit> quando o console não a conhece.
Needs cgroup v2: this host runs cgroup v1. O host usa o sistema cgroup antigo. O card não pode funcionar nele.
No cgroup v2 file system is mounted: the agent cannot see who uses the disk. Monte o sistema de arquivos cgroup v2 ou use um host que o tenha.
The agent could not start its ETW session (it needs administrator rights). Windows: execute o serviço do agente com direitos de administrador.
The ETW session lost events: no table for these 10 minutes. Windows: as contagens não estão completas, então o card não mostra tabela. Selecione outro minuto.
Not measured: {reason} O agente não conseguiu medir este disco. O motivo vem em seguida.
No data for this disk in these 10 minutes. O snapshot tem linhas para outros discos, não para o escolhido.
  • O card precisa do fbagent 2.90.0 ou mais recente e da opção Disk IO by service (disk_io.by_service) na aba Settings.
  • Não há card quando a linha Read/write latency está oculta, ou quando o snapshot não tem linhas nem motivo.

Who uses memory

O card Who uses memory (10 min) mostra quem ocupa a RAM, a partir do snapshot de CPU usage details. Ele ocupa a largura total sob os cards de CPU e disco.

The Who uses memory card
The Who uses memory card

O que você vê:

  1. A linha sob o título.
    • Linux: 10 minutes to 20:00 · RAM 24.5 GiB: used 6.5 GiB (26.6%) · swap 504.1 MiB of 4.0 GiB · waits for memory: some 0.0%, full 0.0% · by systemd service. waits for memory é a parcela de tempo em que alguns ou todos os processos esperaram por memória (PSI).
    • Windows: 10 minutes to 19:50 · RAM 16.0 GiB: available 6.1 GiB, used 62.0% · commit 11.2 GiB of 20.0 GiB · by program.
  2. Uma barra de toda a RAM com sua legenda.
    • Linux: Firebird, agent, Other services, File cache, Kernel and the rest e Free. As partes dos serviços não incluem seu cache de arquivos. Kernel and the rest é o kernel, a memória que nenhum serviço é cobrado e os serviços abaixo do limite de linha.
    • Windows: Firebird, agent, Other programs, System file cache, System and shared pages e Available. As partes dos programas são seus working sets privados.
  3. A tabela de serviços (Linux) ou programas (Windows). Veja as colunas abaixo.
  4. A linha sob a tabela:
    • Below the row threshold: {bytes}: os serviços pequenos demais para uma linha. Uma linha de outro serviço precisa de 64 MiB, ou 1% da RAM quando isso for menor. A tabela tem no máximo 8 linhas.
    • Other services: {bytes} (the names are off: system_metrics.programs): a opção CPU and memory by program está desativada, então apenas o Firebird e o agente têm linhas.
    • Not charged to any service: {bytes} (Linux): memória que não pertence a nenhum serviço.
  5. Databases in the OS cache (Linux): veja abaixo.
  6. Memory by kind over the range, % RAM: veja abaixo.

Colunas do Linux (uma linha é um serviço systemd):

Coluna O que mostra
Service O serviço systemd. A linha do Firebird é destacada. · gone significa que o serviço não está no minuto mais recente: os números são do último minuto que o listou.
Kind Firebird, agent, other ou user session. · shared: outros programas rodam no mesmo grupo. · limit X: o limite rígido de memória do serviço. · high X: seu limite flexível (o kernel desacelera o serviço acima dele).
Programs Os programas do serviço.
Total Toda a memória cobrada do serviço.
Processes A memória de seus processos.
File cache O cache de arquivos cobrado do serviço.
tmpfs/shm Arquivos em memória e memória compartilhada.
Kernel Memória do kernel cobrada do serviço.
Swap A parte de sua memória em swap.
% RAM A memória em % da RAM do host.
Peak 10 min A maior memória do serviço nos 10 minutos.
OOM Quantos processos o out-of-memory killer encerrou. Aponte para ele para ver os programas que provavelmente foram encerrados.
PSI some A parcela de tempo em que alguns processos do serviço esperaram por memória. Aponte para ela para ver a parcela em que todos esperaram.

Colunas do Windows (uma linha é um programa):

Coluna O que mostra
Program O programa. A linha do Firebird é destacada.
Kind Firebird, agent ou other, com as mesmas marcas do Linux.
Services Até 3 serviços do Windows do programa.
Processes Quantos processos do programa rodaram.
Committed A memória privada que o programa confirmou.
Private WS A parte privada de seu working set.
Working set Todo o seu working set, com páginas compartilhadas.

| Pools de kernel | Memória do pool de kernel do programa. | | % RAM | A memória em % da RAM do host. | | Pico de 10 min | A maior memória do programa nos 10 minutos. |

Compare com MON$. O próprio Firebird informa a memória que alocou (MON$MEMORY_USAGE). Aponte para a célula Processes (Linux) ou para a célula Committed (Windows) da linha do Firebird. A dica compara os dois números. Ela só aparece quando há exatamente uma linha do Firebird e o agente leu MON$ nos 10 minutos do snapshot.

Quem detém o cache de arquivos. O Linux cobra uma página de cache de arquivos ao serviço que a leu primeiro. Assim, um backup pode deter uma grande parte do cache de um banco de dados.

Bancos de dados no cache do SO (Linux 6.5 e mais recente): quanto de cada arquivo de banco de dados o cache do SO detém. A tabela tem no máximo 8 linhas, o maior cache primeiro.

Coluna O que mostra
Database O nome do banco de dados. Aponte para ele para ver o caminho. · O_DIRECT significa que o Firebird abre este arquivo com O_DIRECT: suas páginas não estão no cache do SO.
File O tamanho do arquivo.
In the OS cache Quanto do arquivo o cache detém.
% of file O mesmo em % do arquivo.
Dirty Páginas alteradas que ainda não estão no disco.
Recently evicted Quanto o cache descartou recentemente.

Abaixo da tabela: Other database files: {files}, {bytes} in the cache. e The OS cache is shared: the kernel gives it back when programs need memory.

Memória por tipo ao longo do intervalo, % RAM: a divisão da RAM para cada snapshot do intervalo, como áreas empilhadas Firebird, Agent, Other (outros serviços), Cache (cache de arquivos) e Kernel (kernel e o resto), de 0 a 100%. A linha Used é a % de RAM. New RAM % basis marca o minuto em que o agente mudou como conta a % de RAM. Apenas snapshots do fbagent 2.93.0 e mais recente têm essa divisão, então minutos mais antigos ficam vazios.

Mensagens que você pode ver:

Mensagem O que significa
Memory accounting is off, so the agent cannot see which service holds the memory. Turn it on: sudo systemctl set-property <unit> MemoryAccounting=yes O Linux não conta memória por serviço. Execute o comando uma vez no servidor.
Needs cgroup v2: this host runs cgroup v1. O host usa o sistema cgroup antigo. A tabela não pode funcionar nele.
No cgroup v2 file system is mounted: the agent cannot see which service holds the memory. Monte o sistema de arquivos cgroup v2.
The agent could not read the process list in these 10 minutes. O agente não conseguiu listar os processos. Selecione outro minuto.
This snapshot has no memory by service (an older agent, or system_metrics.memory_by_service is off). Atualize o agente ou ative a opção.
The kernel has no cachestat (Linux 6.5+ is needed): the OS cache of the databases is not measured. O kernel é mais antigo que 6.5. Databases in the OS cache fica vazio.
no access to the file (em uma linha) O agente não consegue abrir este arquivo de banco de dados.
the file is gone (em uma linha) O arquivo de banco de dados não existe mais.
  • O card precisa do fbagent 2.93.0 ou mais recente e da opção Memory by service (system_metrics.memory_by_service) na aba Settings.
  • Não há card quando o snapshot não tem dados de memória nem motivo, e o intervalo não tem divisão de memória para desenhar.

Arquivos temporários

Arquivos temporários do Firebird: quantos e qual o tamanho, um ponto por minuto.

Item da legenda O que mostra
Count O número de arquivos temporários. A dica lista os tipos de arquivos, mais arquivos primeiro: arquivos temporários por prefixo de nome (fb_sort, fb_blob, fb_undo, …) e os arquivos da própria pasta de lock do Firebird (fb_lock, fb_monitor, fb_trace, …). A contagem inclui ambos.
Size O tamanho dos arquivos temporários.
Disk, MiB/s (sda, with DB) A velocidade do disco com a pasta temporária: leitura + gravação, MiB por segundo (a soma quando o temp está em vários discos). with DB significa que os bancos de dados estão no mesmo disco.
  • Temp files in memory: no disk line: a pasta temporária está na memória, então não há linha de disco.
  • Temp disk not measured: {disk} network disk (ou no counters): o agente não tem contadores de disco para a pasta temporária.
  • Agentes sem a tarefa de IO de disco não mostram linha de disco nem item de legenda.

Espaço em disco

Uma barra por disco: espaço usado e livre em porcentagem, com os tamanhos sob as porcentagens. Os dados são do último snapshot de disco do dia escolhido.

  • Aponte para uma barra para ver o ponto de montagem, Disk space used, Disk space free e Disk size.
  • Os caminhos à direita são as pastas naquele disco que o agente monitora. Até 5 são exibidas; More mostra todas, Less as oculta.
  • Um agente mais antigo que os campos de tamanho mostra apenas porcentagens.
Mensagem O que significa
No disk usage data for the selected day. O agente não enviou nenhum snapshot de disco para o dia escolhido.

Latência de leitura/gravação

Para um disco com bancos de dados ou arquivos temporários do Firebird: o tempo médio de uma leitura e de uma gravação no minuto, e as operações por segundo.

A lista de discos está na linha do título. Cada item é um disco com seu papel, por exemplo sda (databases, temp). Discos com bancos de dados vêm primeiro. A lista fica desabilitada quando o servidor tem um disco. Sua escolha também altera Read/write speed e Who uses the disk.

Item da legenda O que mostra
Read A latência de leitura, em ms.
Write A latência de gravação, em ms.
IOPS Operações por segundo. A dica acrescenta quão ocupado o disco estava, por exemplo IOPS: 120 (busy 35%).
Agent task Uma faixa amarela nos minutos em que uma das tarefas pesadas do próprio agente rodou por 5 segundos ou mais: teste de velocidade de disco, backup, restore, sweep, validação, estatísticas completas ou recálculo de índices. A dica nomeia a tarefa. Minutos lentos dentro da faixa vêm do agente, não dos usuários.
  • Não há linha com Read/write latency e Read/write speed para agentes sem a tarefa de IO de disco, ou quando nenhum disco foi medido.

Velocidade de leitura/gravação

O mesmo disco: bytes lidos e gravados por segundo.

Item da legenda O que mostra
Read Bytes lidos por segundo no disco.
Write Bytes gravados por segundo no disco.
Firebird, read, all disks Linha tracejada: o que os processos do Firebird leram em todo o servidor, não apenas neste disco (Linux).
Firebird, write, all disks Linha tracejada: o que os processos do Firebird gravaram em todo o servidor (Linux).
  • Quando o agente vê os serviços do disco (Who uses the disk) em todos os minutos do gráfico, as linhas tracejadas são o IO do Firebird apenas neste disco. A legenda então diz Firebird, read e Firebird, write; aponte para um item da legenda para ver Firebird reads per second, this disk. A dica nomeia a fonte de cada minuto.
  • Quando as linhas do Firebird são muito menores que as leituras ou gravações do disco, outro programa carrega o disco.
  • As gravações do Firebird não contam os dados de arquivos temporários excluídos antes de chegarem ao disco (arquivos de ordenação, memória compartilhada). A dica mostra isso como Firebird, dropped before the disk. Agentes anteriores a 2.89.0 contavam isso, então para eles a linha de gravação não é desenhada.
  • Abaixo do gráfico: Not measured: com as pastas temporária ou de bancos de dados que não têm contadores de disco (in memory, network disk, no counters).
  • No Windows apenas a linha de leitura, para este disco: gravações através do cache pertencem ao sistema.

Selecionar um minuto

Clique em qualquer ponto de qualquer gráfico, também nos gráficos de uma linha de banco de dados aberta. O console:

  • desenha uma linha azul naquele minuto em todos os gráficos;
  • mostra Selected minute: HH:MM ao lado da caixa de busca, com o link Report for this minute quando um snapshot de status cobre aquele minuto: o relatório de saúde daquele snapshot;
  • muda CPU usage details, Who uses the disk e Who uses memory para o snapshot cujos 10 minutos contêm aquele minuto;
  • carrega dados de trace e conexões para aquele minuto em cada linha de banco de dados aberta.

Alterar a data, o preset de hora ou a hora de início ou fim limpa o minuto selecionado.

Tabela de bancos de dados

The databases table of the dashboard
The databases table of the dashboard

O que você vê:

  1. Databases e sua contagem.
  2. Search by name or path…: digite para filtrar a lista.
  3. Selected minute: HH:MM e Report for this minute, quando um minuto está selecionado.
  4. Collapse all: fecha todas as linhas abertas. Aparece apenas enquanto uma linha está aberta.
  5. Uma linha por banco de dados. Clique em uma linha para abri-la (veja Open a database row).
Coluna O que mostra
Database(Name) O nome do banco de dados, encurtado no meio quando é longo (aponte para ele para ver o nome completo). Abaixo dele: os badges de estado. Details abre as páginas do banco de dados com a mesma data e intervalo de tempo.
Statistics Badges do snapshot gstat mais recente (veja abaixo).
Path · Size / Page size · Dialect · Creation date · Owner Primeira linha: o caminho do arquivo do banco de dados, o botão de copiar, o tamanho, o chip Sweep e o chip de segurança. Segunda linha: tamanho da página, dialeto SQL, data de criação e proprietário.
Conns Conexões no último snapshot do intervalo. Aponte para ele para ver As of HH:MM:SS. — significa nenhum dado para este banco de dados no intervalo. Clique no cabeçalho para ordenar.
  • Path: um caminho longo é encurtado no meio. O botão de copiar (Copy path) o copia; ele fica oculto no modo demo.
  • Size é o tamanho de todos os arquivos do banco de dados no disco, da medição mais recente no intervalo selecionado. É em MB abaixo de 1024 MB e em GB acima. Aponte para ele para ver o número exato de bytes. Um banco de dados sem essa medição não mostra tamanho.
  • Owner é o proprietário do banco de dados (MON$OWNER). — marca um campo vazio na segunda linha.
  • O chip de segurança mostra onde os logins no banco de dados são verificados quando este não é o próprio banco de dados de segurança do servidor: sec: <file> para um banco de dados de segurança privado, self quando o banco de dados verifica seus próprios logins.
  • Owner e o chip de segurança precisam do fbagent 2.78.0 ou mais recente.

Badges de estado e o chip Sweep

Um badge de estado sob o nome aparece quando o banco de dados não está em estado normal:

Badge Cor
Full shutdown vermelho
Single-user shutdown, Multi-user shutdown, Shutdown (maintenance), nbackup lock âmbar
nbackup merge, Replica (read-only), Replica (read-write), Replica, Read only azul
  • Aponte para um badge para ver sua origem: From the database header, HH:MM ou From MON$DATABASE, HH:MM. O mais recente dos dois prevalece.
  • stale é adicionado, e o badge fica esmaecido, quando a amostra tem mais de 15 minutos a mais que o fim do intervalo.
  • Um banco de dados em full shutdown não tem conexões, então o agente o lista a partir de seu header.

O chip Sweep após o tamanho mostra o intervalo de sweep automático do header do banco de dados: Sweep 20000, ou Sweep off (borda tracejada) quando o intervalo é 0. Aponte para ele para ver o texto completo.

Badges de estado do header e o chip Sweep precisam do fbagent 2.91.0 ou mais recente.

Badges de estatísticas

  • critical - {n} (vermelho) e warnings - {n} (âmbar): problemas que o analisador de estatísticas encontrou no snapshot gstat mais recente. Aponte para um badge para ver a hora e o arquivo do snapshot. Clique nele para abrir a página Statistics na aba Analysis and Recommendations.
  • +25% in {n} days: a tabela ou índice de crescimento mais rápido crescerá 25% em tantos dias. Aponte para ele para ver o objeto, a data e o crescimento por dia. O badge é cinza, e vermelho quando isso é 30 dias ou menos. Clique nele para abrir Trends › Forecasts com a sensibilidade mais fina.

Mensagens que você pode ver:

Mensagem O que significa
No data / cannot load databases A lista de bancos de dados não carregou. O texto do erro vem em seguida.
— em Conns Nenhum dado de conexão para este banco de dados no intervalo.

Abrir uma linha de banco de dados

Clique em uma linha de banco de dados. Ela mostra dois gráficos:

  • Transactions: Next-Oat, OST − OIT e Active Δ (veja Contadores de transação).
  • LWM: anexos ativos (activeAtt), requisições ativas (activeReq), tempo de execução (execTime Δ), fetches e erros, por minuto.

Clique em um item da legenda para ocultar ou mostrar sua linha.

An open database row with a selected minute
An open database row with a selected minute

Até 3 linhas de banco de dados podem ficar abertas. Abrir uma 4ª fecha a mais antiga.

Quando um minuto é selecionado, a linha aberta também mostra duas tabelas. Cada tabela mostra 5 linhas. Rows: n mostra quantas existem. Clique em More para ver todas as linhas, Less para ver 5 novamente. Clique em um cabeçalho para ordenar.

Top queries from trace: as instruções mais pesadas daquele minuto, ordenadas por Fetches. Aponte para um cabeçalho para ver sua dica.

Coluna O que mostra
StmtID O id da instrução.
SQL Text O início do texto SQL.
IP Address O endereço do cliente.
Process Name O programa cliente.
Time O tempo total de todas as execuções desta instrução.
Runs Quantas vezes ela foi executada neste minuto.
Fetches, Reads, Writes, Marks Os totais de todas as execuções neste minuto.

Clique em uma linha para ver o texto SQL completo, o PLAN e os PARAMETERS. Copy SQL copia o texto; Copy SQL with parameters aparece quando a instrução tem parâmetros.

Connections: todos os anexos naquele minuto, ordenados por Fetches.

Coluna O que mostra
AttachID O id do anexo.
Process Name, IP Address, Process ID O programa cliente, seu endereço e seu id de processo.
Transactions Transações concluídas do anexo.
Act.Tran Transações ativas.
Prepared, Executed, Active Instruções preparadas, executadas e ativas.
Fetched Rows Linhas buscadas por instruções concluídas neste minuto.
Time Tempo de execução das instruções concluídas neste minuto.
Errors Erros neste minuto.
Fetches, Reads, Marks, Writes Operações de página das instruções concluídas neste minuto.

Mensagens que você pode ver:

Mensagem O que significa
Loading… O gráfico está carregando.
No data Nenhum dado para este banco de dados no intervalo.
Loading trace…, Loading connections… As tabelas do minuto selecionado estão carregando.
lwmmon files are missing for this minute. O agente não tem dados de conexão para este minuto. Selecione outro minuto.

Quando o trace não tem instruções para o minuto, a tabela de trace não aparece.

Contadores de transação

O Firebird mantém quatro números de transação. Eles sempre crescem e mantêm esta ordem:

Transaction counters
  • Next-Oat é a transação Next menos a Oldest active. Uma linha que sobe o tempo todo significa que uma transação permanece aberta por muito tempo. Encontre-a na tabela Connections ou no relatório de saúde (transações longas).
  • OST − OIT é Oldest snapshot menos Oldest interesting. Ela cresce quando a coleta de lixo fica atrasada, por exemplo quando um sweep é necessário.
  • Active Δ é o número de novas transações por minuto.

5. Páginas de banco de dados

Todo banco de dados tem quatro páginas: Database, Metrics, Clients Versions e Statistics. Para abri-las, clique em Details ao lado de um banco de dados na tabela Databases do dashboard. Os chips gstat na mesma tabela abrem a página Statistics diretamente.

Todas as quatro páginas têm o mesmo cabeçalho e a mesma linha abaixo dele:

  1. O logo e a versão.
  2. ← Servers: volta para a página Servers.
  3. O nome do servidor, por exemplo SRV. Ele abre o dashboard deste servidor, no mesmo dia.
  4. O menu do servidor: Logs, Configs, Errors, Conflicts, Perf Report, Jobs e Backups. É o menu das páginas do servidor: um clique abre os logs ou os erros deste servidor. Nenhum item fica destacado em uma página de banco de dados.
  5. O ícone de engrenagem (Settings), Log out e a lista de idiomas.
  6. A linha do banco de dados. Ela começa com o rótulo DB e o nome do banco de dados. Depois vêm as páginas do banco de dados: Database, Metrics, Clients Versions, Statistics e Performance report. A página aberta fica sublinhada. A linha permanece sob o cabeçalho quando você rola a página.
  7. A linha de breadcrumb: Servers › SRV › employee na página Database. As outras páginas adicionam seu nome, por exemplo Servers › SRV › employee › Metrics.

Performance report abre a página Perf Report do servidor com este banco de dados escolhido na lista Database. A linha do banco de dados permanece nessa página, então um clique leva você de volta para Database ou Metrics.

Alterar o banco de dados. Clique no nome do banco de dados na linha. Uma lista dos bancos de dados deste servidor é aberta, com o nome, o caminho e o tamanho de cada um. O banco de dados atual fica marcado. Clique em outro banco de dados para abrir a mesma página para ele, no mesmo dia e intervalo de tempo. Esc ou um clique fora fecha a lista. As teclas de seta percorrem a lista.

The list of databases under the database name
The list of databases under the database name
Texto na lista O que significa
Cannot load the list of databases O console não recebeu resposta. Feche a lista e abra-a novamente.
No databases for this day O agente não enviou nenhuma lista de bancos de dados para o dia escolhido. Escolha outro dia.

Você pode adicionar estas páginas aos favoritos. O endereço mantém o banco de dados, a data e o intervalo de tempo.

Database

The Database page
The Database page

O que você vê

  1. O cabeçalho, a linha do banco de dados e a linha de breadcrumb.
  2. A linha do banco de dados: Database:, o nome do banco de dados, os badges de estado (somente quando o banco de dados tem um estado), o caminho, o tamanho e o chip Sweep. Por exemplo: employee /data/employee.fdb 58.1 GB Sweep off. O tamanho é em MB abaixo de 1024 MB e em GB acima. Aponte para o tamanho para ver o número exato de bytes.
  3. A segunda linha: Page size, Dialect, Creation date, Owner e Security DB. Owner aparece somente quando o agente o conhece. Security DB aparece somente quando o banco de dados não usa o banco de dados de segurança padrão: self significa que o banco de dados verifica os logins por conta própria, sec: … significa que ele usa outro banco de dados de segurança.
  4. A barra de tempo: o fuso horário dos dados do servidor (veja Time and time zone), o botão de data, From — To, e a lista de predefinições: Last 1h (padrão), Last 6h, Last 12h, Full day, Selected. Depois que você clica em um gráfico, Selected minute: HH:MM também aparece aqui.
  5. Quatro gráficos por minuto para o intervalo selecionado.

O tamanho, os badges de estado e o chip Sweep mostram os valores mais recentes até o fim do intervalo selecionado. Assim, um dia anterior mostra os valores daquele dia.

Badges de estado e Sweep

Eles significam o mesmo que na tabela Databases do dashboard.

Cor Badges
Vermelho Full shutdown
Âmbar Single-user shutdown, Multi-user shutdown, Shutdown (maintenance), nbackup lock
Azul nbackup merge, Replica (read-only), Replica (read-write), Replica, Read only
  • O estado vem do cabeçalho do banco de dados ou de MON$DATABASE, o que for mais recente. Aponte para um badge para ver a origem e o horário: From the database header, 01:00 ou From MON$DATABASE, 01:00.
  • Se os dados estiverem mais de 15 minutos mais antigos que o fim do intervalo, o badge fica mais claro e a dica termina com (stale).
  • Sweep 20000: o intervalo de sweep automático do cabeçalho do banco de dados, em transações. Sweep off (moldura tracejada): o intervalo de sweep é 0, então o sweep automático está desativado. O chip requer fbagent 2.91.0 ou posterior.

Gráficos

Gráfico Séries
LWM activeAtt, activeReq, execTime Δ, fetches
Transactions Next-Oat, OST − OIT, Active Δ (o mesmo que no dashboard, veja Contadores de transação)
Fetches, reads, writes, marks, rowsFetched fetches Δ, reads Δ, writes Δ, marks Δ, rowsFetched Δ: operações de página por minuto
Requests: prepReq Δ, execReq Δ, activeReq, rowsFetched Δ prepared (Δ), prepared now, execReq Δ, activeReq, rowsFetched Δ

Δ significa a mudança em relação ao minuto anterior. Uma lacuna significa que o contador foi reiniciado, por exemplo após uma reinicialização do Firebird, ou que o agente foi atualizado para novos contadores naquele minuto (fbagent 2.67.0 e posteriores também contam as conexões abertas). Quando o agente informa que a entrada LWM do banco de dados foi recriada, o minuto mostra o trabalho desde então em vez de uma lacuna.

prepared (Δ) é o contador prepReq antigo (agentes anteriores a 2.67.0): instruções preparadas por minuto. prepared now vem de agentes mais novos: instruções preparadas naquele momento. Um dia de uma atualização de agente mostra a primeira linha antes da atualização e a segunda depois dela.

Dicas:

  • O nome do servidor no cabeçalho abre o dashboard com a mesma data e intervalo de tempo.
  • Alterar a data, o intervalo ou a predefinição limpa o minuto selecionado.

Principais consultas e conexões

Clique em um gráfico para selecionar um minuto. O console pega o minuto mais próximo com dados e o marca com uma linha vertical em todos os quatro gráficos. Duas tabelas aparecem sob os gráficos.

Top queries and connections for the selected minute
Top queries and connections for the selected minute

O que você vê

  1. Top queries from trace e sua contagem de linhas (Rows: n). Uma linha por instrução do trace neste minuto.
  2. Connections e sua contagem de linhas. Uma linha por anexo (dos dados LWM deste minuto).

Ambas as tabelas funcionam da mesma forma:

  • Elas mostram as primeiras 5 linhas. More mostra todas as linhas, Less mostra 5 novamente.
  • Elas são ordenadas por Fetches, do maior para o menor. Clique em um cabeçalho de coluna para ordenar por ele. O primeiro clique em uma coluna numérica ordena os maiores valores primeiro. Um segundo clique inverte a ordem. A coluna ordenada fica azul.
  • Tabelas largas rolam para a direita.

Colunas de Top queries from trace:

Coluna O que mostra
StmtID O id da instrução do trace.
SQL Text O início da instrução. Clique na linha para abri-la.
IP Address O endereço do cliente, por exemplo 192.168.0.10.
Process Name O programa cliente.
Time O tempo total decorrido de todas essas consultas neste minuto.
Runs Quantas vezes esta consulta foi executada neste minuto.
Fetches, Reads, Writes, Marks Totais de todas as execuções neste minuto.

Clique em uma linha de consulta para abri-la. Um segundo clique a fecha. Apenas uma linha fica aberta por vez.

  • SQL: o texto completo da instrução.
  • PLAN: o plano que o Firebird usou. NATURAL significa uma varredura completa da tabela.
  • PARAMETERS: os tipos e valores dos parâmetros.
  • Copy SQL copia a instrução. Copy SQL with parameters aparece apenas quando a instrução tem parâmetros. No modo de demonstração, esses botões ficam ocultos.
An open Top queries row with the SQL, PLAN and PARAMETERS blocks
An open Top queries row with the SQL, PLAN and PARAMETERS blocks

Colunas de Connections:

Coluna O que mostra
AttachID O id da conexão (attachment).
Process Name, IP Address, Process ID O programa cliente, seu endereço e seu id de processo.
Transactions Transações concluídas nesta conexão.
Act.Tran Transações ativas.
Prepared Preparações de instruções.
Executed Instruções executadas.
Active Instruções ativas.
Fetched Rows, Time, Errors, Fetches, Reads, Marks, Writes Valores das instruções que foram concluídas neste minuto nesta conexão.

Um valor que o agente não reportou aparece como —. Por exemplo, ordene por Act.Tran para encontrar as conexões que mantêm transações abertas.

Mensagens que você pode ver

Mensagem O que significa
Loading trace… / Loading connections… O console carrega a tabela.
No trace data for this minute. O trace não tem instruções para este banco de dados neste minuto. Selecione outro minuto.
No connections data for this minute. Os dados LWM deste minuto não têm conexões (attachments).
lwmmon files are missing for this minute. O agente não coletou dados de conexão naquele momento.
Trace error: … / Connections error: … Os dados não puderam ser carregados. O texto mostra o motivo.

Métricas

Tabelas detalhadas a partir de um snapshot MON$ do banco de dados.

  1. Selecione uma data e um intervalo de tempo.
  2. Clique em um botão de horário de snapshot. O mais recente é selecionado por padrão.
The Metrics page
The Metrics page

O que você vê

  1. O cabeçalho, a linha do banco de dados e a linha de navegação (Servers › SRV › employee › Metrics).
  2. A barra de tempo: o botão de data, From — To e a lista de predefinições. A página lê os snapshots do dia do fim do intervalo.
  3. Uma caixa de aviso, apenas quando a página precisa explicar dados ausentes (veja as mensagens abaixo).
  4. O painel de snapshots: Snapshot: 20:00 (o horário selecionado) e um botão por horário de snapshot. O botão selecionado é azul. Um botão com moldura laranja marca um snapshot em que o agente não conseguiu ler MON$. Aponte para ele para ver a mensagem do agente.
  5. Cinco tabelas. O título de cada tabela mostra o número de linhas.
Tabela Colunas O que mostra
Aggregated activity #, inserts, updates, deletes, total_dml, backouts, purges, expunges, total_versioning Operações de registro de todo o banco de dados (MON$RECORD_STATS).
Total connections total_connections, total_transactions, tx/conn, total_statements, stmt/tx Conexões, transações e instruções no momento do snapshot.
Process memory Process, Connections, memory_used, memory_allocated, max_memory_used, max_memory_allocated Memória por programa cliente. As conexões de um mesmo programa são somadas.
Top connections by memory Process, IP address, as mesmas quatro colunas de memória As 5 conexões que usam mais memória.
Top connections by load Process, IP address, inserts, updates, deletes, total_dml, statement_count As 5 conexões com mais alterações e as 5 com mais instruções.
  • Clique no cabeçalho de uma coluna para ordenar. A coluna ordenada mostra ▼ ou ▲. Colunas numéricas ordenam do maior para o menor; Process e IP address ordenam de A a Z.
  • A memória é mostrada em MB, por exemplo 139.3 Mb.
  • Uma célula Process vazia significa que a conexão não reportou seu programa.

Por que um banco de dados não tem dados de Métricas

O agente lê MON$ a cada hora, e apenas para os bancos de dados que estão ativos (têm conexões) naquele momento: até 10 por servidor por padrão. A configuração do agente firebird.database_metrics.max_active_databases altera o limite (-1 significa sem limite). Os bancos de dados listados em conf/database_metrics_targets.json são sempre lidos primeiro, quando estão ativos. Bancos de dados de segurança não são lidos.

Em um servidor com muitos bancos de dados pequenos, a maioria deles não tem dados de Métricas, ou tem dados apenas para algumas horas. Isso é esperado. A página então mostra um aviso:

The Metrics page with no snapshots in the selected range
The Metrics page with no snapshots in the selected range

Mensagens que você pode ver

Mensagem O que significa
The agent does not collect MON$ statistics for this database. … O agente não tem dados MON$ para este banco de dados em nenhum dia. Veja o limite acima.
The agent read this database at other times. Choose another date or a longer range. … Há dados MON$ para este banco de dados, mas não no intervalo selecionado.
The agent could not read MON$ at 01:00: … O agente tentou, mas não conseguiu conectar ou ficou sem tempo. O texto mostra a mensagem do agente, por exemplo record_stats: context deadline exceeded.
Select a snapshot time / No snapshots in the selected time range. O intervalo não tem snapshots. Escolha outra data ou um intervalo maior.
No data for the selected snapshot. A tabela não tem linhas para este snapshot. Um snapshot com moldura laranja mostra isso em suas tabelas.
Failed to load metrics: … Os dados não puderam ser carregados. O texto mostra o motivo.

Versões dos Clientes

As versões do cliente Firebird que se conectam a este banco de dados, e quantas conexões cada uma tem.

The Clients Versions page
The Clients Versions page

O que você vê

  1. O cabeçalho, a linha do banco de dados e a linha de navegação (Servers › SRV › employee › Clients Versions).
  2. Check time: o horário em que o agente leu as versões dos clientes, ou —.
  3. O fuso horário de Check time (veja Hora e fuso horário) e o botão de data. O calendário oferece apenas os dias com dados de versão de cliente. O dia mais recente abre por padrão.
  4. A tabela Clients versions e sua contagem de linhas.
Coluna O que mostra
# O número da linha.
Client version A string de versão que o cliente reportou, por exemplo WI-V5.0.1.1469 Firebird 5.0. Not detected. Old version? significa que o cliente não reportou sua versão. Isso geralmente é uma biblioteca de cliente antiga. Uma linha como fbagent/2.93.0 conta as conexões do próprio agente.
Connection count O número de conexões com esta versão.

Clique em Connection count para ordenar: o primeiro clique ordena do maior para o menor, o segundo clique do menor para o maior, o terceiro clique retorna à ordem original.

O agente lê as versões dos clientes uma vez por dia (11:00 por padrão), para os mesmos bancos de dados que as Métricas (veja Por que um banco de dados não tem dados de Métricas).

Mensagens que você pode ver

Mensagem O que significa
The agent does not collect client versions for this database. … O agente nunca leu versões de clientes para este banco de dados.
The agent could not read client versions at 11:00: … O agente tentou e falhou. O texto mostra o motivo. skipped significa Firebird 2.5, que não tem MON$CLIENT_VERSION.
No data for the selected date. O dia selecionado não tem linhas. Escolha outra data.
No ClientVersions files for this database. Mostrado no calendário: não há dias para escolher.
Failed to load client versions: … / Failed to load dates: … Os dados não puderam ser carregados. O texto mostra o motivo.

6. Estatísticas: relatórios gstat e tendências

A página Statistics analisa os arquivos gstat que o agente coleta para o banco de dados. O agente executa gstat uma vez por dia (02:00 por padrão). Em um servidor com muitos bancos de dados, o agente também limita o número de bancos de dados por execução, então alguns bancos de dados não têm arquivos gstat.

A página tem dois botões no topo: Report e Trends. A linha de navegação segue a aba aberta: Servers › SRV › employee › Statistics › Report ou … › Statistics › Trends. O endereço mantém o arquivo selecionado, a aba e as configurações de tendências, para que você possa favoritar um relatório.

Os chips gstat na tabela Databases do dashboard abrem esta página: os chips críticos e de aviso abrem a aba Analysis and Recommendations, e +25% abre Trends com a aba Forecasts.

Relatório

The Statistics report: Summary tab
The Statistics report: Summary tab

O que você vê

  1. O cabeçalho, a linha do banco de dados e a linha de navegação.
  2. Os botões Report e Trends. O aberto é laranja.
  3. A barra do relatório:
    • Select snapshot: os arquivos gstat, mais recentes primeiro. Cada item mostra a data e o nome do arquivo.
    • Os badges: critical - {n} (vermelho), warnings - {n} (âmbar), notes - {n} (azul). Um badge com 0 fica oculto.
    • Download JSON: os valores medidos.
    • Download Excel: a análise completa como uma pasta de trabalho .xlsx no idioma atual.
  4. Uma caixa de observações, apenas quando o analisador tinha observações sobre o arquivo.
  5. O relatório com suas próprias abas:
    • Summary: o tamanho dos dados, índices e BLOBs, as maiores tabelas, os índices em profundidade 3, as principais descobertas e as consultas mais pesadas quando são conhecidas.
    • Tables e Indexes: uma linha por tabela ou índice.
    • Analysis and Recommendations: o que está errado e o que fazer.
    • Queries e Links: apenas quando o agente tem relatórios de desempenho próximos ao horário do snapshot (veja Aba Queries).

Aba Tables

The Tables tab
The Tables tab

Digite em Filter by name para mostrar apenas as tabelas correspondentes. Clique no cabeçalho de uma coluna para ordenar.

Coluna O que mostra
Table O nome da tabela, seu id, um link queries (n) quando consultas leem a tabela, e Details com mais valores.
Size: Data, Indexes, BLOB, Total O tamanho de cada parte. Abaixo: a participação no banco de dados, o número de índices, as páginas de BLOB.
Records A contagem de registros e o comprimento médio do registro (avg).
Versions / MaxV O número de versões anteriores (back versions) e o máximo de versões de um registro.

| BLOB | O número de BLOBs e suas páginas. | | Outros | O preenchimento médio das páginas de dados, o número de índices e a maior profundidade de índice. |

A aba Índices tem o mesmo filtro. Suas colunas: Índice (nome, id, consultas (n)), Tabela, Tamanho (com a participação dos dados da tabela), Estrutura (profundidade, páginas, baixo preenchimento) e Chave (nós, valores distintos, duplicatas, comprimento médio da chave). Linhas com profundidade 4 são amarelas. Linhas com profundidade 5 ou mais são vermelhas.

Aba Análise e Recomendações

The Analysis and Recommendations tab
A aba Análise e Recomendações
  • Um cartão por categoria, por exemplo Alto Uso de BLOB ou Ineficiência de Índice.
  • Uma caixa colorida por problema: Problema:, a descrição e Número de problemas:. Abaixo dela, Objetos afetados: lista as tabelas e índices. Cada nome é um link.
  • Uma caixa de recomendação: Recomendação:, Justificativa:, Impacto: e Ação:. Uma lista longa de objetos mostra 3 objetos e Mais (n).

Mensagens que você pode ver

Mensagem O que significa
Nenhum arquivo gstat encontrado O agente não tem nenhum arquivo gstat para este banco de dados. Veja o limite na introdução.
Gerando relatório… O console analisa o arquivo. Aguarde.
Falha ao carregar o relatório O arquivo não pôde ser lido ou analisado.
Este snapshot não tem cabeçalho de banco de dados, então as verificações baseadas no cabeçalho foram ignoradas. O arquivo gstat não tem a parte do cabeçalho. As verificações que precisam dele estão ausentes.
O analisador fez observações sobre este arquivo: As observações do analisador seguem como uma lista.

Aba Consultas

A aba Consultas une as estatísticas do gstat com as consultas que foram executadas no servidor. Ela mostra quais instruções leram quais tabelas e índices, para que você possa encontrar a consulta por trás de uma tabela problemática.

The Queries tab
A aba Consultas
Coluna O que mostra
SQL / processo A instrução, o programa cliente e o número de variantes de texto. SQL abre o texto completo.
Tempo O tempo total em ms e sua participação no tempo total.
Contagem / média Quantas vezes a instrução foi executada e o tempo médio.
Fetches Total de fetches e fetches por linha. computed in cache significa muitos fetches, mas quase nenhuma leitura de página.
Leituras, Gravações, Marcas Totais de leituras, gravações e marcas de páginas.
  • Os dados vêm dos relatórios de desempenho do agente (os mesmos dados do Perf Report).
  • O console usa janelas de relatório que terminam no máximo 23 horas antes do momento do snapshot do gstat. Janelas mais antigas ou mais recentes não são usadas.
  • Arquivos de relatório vazios, expirados ou danificados são ignorados. Se nenhuma janela utilizável restar, a aba Consultas não aparece.
  • O relatório de desempenho cobre o servidor inteiro. Em um servidor com vários bancos de dados, a aba pode mostrar instruções que foram executadas em outros bancos de dados.
  • Filtrar por nome mostra apenas as instruções correspondentes.
  • Links lista tabelas e índices com o número de ocorrências de consultas. Nas abas Tabelas e Índices, um link consultas (n) abre as consultas correspondentes.
  • O arquivo Excel então também tem as planilhas Consultas, Processos e endereços e Endereços.

Tendências

A aba Tendências compara os snapshots mais recentes e mostra como tabelas e índices mudam ao longo do tempo. Ela não usa o snapshot selecionado na aba Relatório. A aba carrega quando você a abre pela primeira vez.

The Trends tab
A aba Tendências

O que você vê

  1. O cabeçalho, a linha do banco de dados e a linha de navegação (termina com Tendências).
  2. A barra de tendências:
    • Comparar últimos: quantos snapshots comparar. A lista oferece 5 snapshots, 10 snapshots, 20 snapshots e 30 snapshots, mas apenas até o número de arquivos. Com menos de 30 arquivos, a lista também oferece todos eles. O padrão é 10, ou a maior opção quando há menos arquivos.
    • Relatar mudanças acima de: a menor mudança a relatar: ≥ 10% (padrão), ≥ 2% ou ≥ 0.5%. Se um banco de dados tranquilo não mostrar nada, escolha um valor menor.
    • Baixar JSON e Baixar Excel, como na aba Relatório.
  3. O relatório de tendências: Relatório de Tendências do Gstat, o banco de dados, o número de snapshots, suas datas e o momento em que o relatório foi gerado. Suas abas:
    • Resumo: Maiores mudanças de tamanho (Objeto, Propriedade, Mudança, Mudança %) e Snapshots (Rótulo, Tempo de execução, Tamanho da página, Total de páginas de dados, Total de registros).
    • Tabelas e Índices: os valores de cada objeto em cada snapshot.
    • Mudanças: cada mudança acima do limite escolhido, com o primeiro e o último valor e o nível.
    • Previsões: Previsões de Crescimento (atingindo +25%): o tamanho atual, o crescimento por dia e a data em que o objeto cresce 25%. A estimativa precisa de pelo menos três snapshots.
    • Gráficos: tamanhos de tabelas, tamanhos de índices, tamanhos totais, contagens de versões e transações e conexões.

Mensagens que você pode ver

Mensagem O que significa
Nenhum arquivo gstat encontrado O agente não tem nenhum arquivo gstat para este banco de dados.
Comparando snapshots… O console monta o relatório de tendências.
Um relatório de tendências precisa de pelo menos dois snapshots Há apenas um arquivo gstat. Aguarde a próxima execução diária.
Falha ao montar o relatório de tendências Os arquivos não puderam ser comparados.
Aviso: o tamanho da página ou a versão do ODS mudou entre os snapshots - as tendências podem não ser diretamente comparáveis Mostrado no relatório. O tamanho da página ou a versão do ODS não é o mesmo em todos os snapshots, por exemplo após um restore.
Nenhuma previsão de crescimento. Mostrado em Previsões: o relatório não tem previsão para nenhuma tabela ou índice.

7. Ferramentas do servidor

Estas páginas abrem a partir do menu no cabeçalho do servidor: Logs, Configs, Erros, Conflitos e Perf Report. Toda página tem ← Servidores à esquerda do cabeçalho e uma linha de navegação sob o cabeçalho, por exemplo Servidores › SRV › Logs. Todos os horários estão no fuso horário do servidor (veja Horário e fuso horário).

Logs, Erros e Conflitos filtram linhas da mesma forma:

  • Incluir: e Excluir: aceitam uma ou mais partes de palavras, separadas por vírgulas ou ponto e vírgula. Maiúsculas e minúsculas não importam.
  • Incluir mantém uma linha que tenha qualquer uma das partes. Excluir oculta uma linha que tenha qualquer uma das partes.

Logs

Os logs do Firebird do servidor, com duas abas: Firebird.log e Replication.log. O agente envia as entradas de log dia a dia.

The Logs page
A página Logs

O que você vê

  1. A linha de filtro: Incluir:, Excluir: e Aplicar (ou Enter em um campo de filtro).
  2. A barra de tempo: o selo do fuso horário, o botão de data, o horário de início e fim, e a lista de predefinições.
  3. As abas Firebird.log e Replication.log.
  4. A barra de paginação: Anterior, os números de página, Próxima, o campo Página e Total de registros: N. A mesma barra também aparece sob a tabela.
  5. A tabela de entradas de log.

Filtros. Os filtros examinam a mensagem, a origem e o banco de dados de cada entrada. Clique em Aplicar, ou pressione Enter em um campo de filtro, para usá-los. Na aba Firebird.log, Excluir é INET por padrão: ele oculta as mensagens de rede como INET/inet_error. Na aba Replication.log, Excluir está vazio. Quando você troca de aba, Incluir é limpo e Excluir recebe o padrão daquela aba novamente.

Data e hora.

  • O calendário tem os dias de ambos os logs. A página abre no dia mais recente. Quando você escolhe outro dia, a tabela carrega novamente.
  • A lista de predefinições define o intervalo do dia:
    • Dia inteiro (o padrão): 00:00–23:59.
    • Última 1h: a hora que termina na entrada mais recente do dia.
    • Últimas 6h: 18:00–23:59.
    • Últimas 12h: 12:00–23:59.
    • Selecionado: o intervalo que você define manualmente.
  • Uma predefinição carrega a tabela imediatamente. Depois de alterar o horário de início ou fim manualmente, clique em Aplicar.

A tabela

Coluna O que mostra
# O número da entrada no resultado.
Data / Hora A data e a hora da entrada.
Origem O nome do computador na entrada.
Banco de dados O banco de dados da entrada, ou — quando a entrada não nomeia nenhum.
Status Apenas em Replication.log: o status da entrada. Clique no cabeçalho para ordenar por ele; clique novamente para inverter a ordem.
Mensagem O texto da entrada.
  • Uma linha é vermelha quando sua mensagem contém bugcheck, internal consistency check, abnormal termination ou operating system. Leia estas entradas primeiro.
  • A tabela tem 100 entradas por página. Ela abre na última página, com as entradas mais recentes. Para ir a uma página, digite seu número no campo Página e pressione Enter. Uma tabela ordenada abre na página 1.

Mensagens que você pode ver

Mensagem O que significa
Nenhuma entrada para a data e o intervalo de tempo selecionados. Nenhuma entrada corresponde ao dia, ao intervalo e aos filtros. Escolha Dia inteiro ou limpe os filtros.
firebird.log ainda não tem entradas. O servidor não tem esse log, ou ele está vazio. O agente não enviou nenhum dia deste log. A mesma mensagem nomeia replication.log na outra aba. Um servidor sem replicação não tem log de replicação.
Nenhuma data no log O calendário não tem dias: o agente ainda não enviou nenhum log.
Falha ao carregar datas: … / Falha ao carregar logs: … O console não pôde ler os dados. O texto após os dois-pontos dá o motivo.

Configs

As cópias salvas de databases.conf, firebird.conf e replication.conf. O agente copia um arquivo cada vez que ele muda. Escolha uma cópia em cada lista para ver as configurações em momentos diferentes.

The Configs page
A página Configs

O que você vê

  1. Recarregar no canto superior direito. Ele lê novamente as cópias mais recentes dos arquivos. O agente copia um arquivo alterado em até um minuto, então após uma edição manual no servidor, aguarde um minuto e clique em Recarregar.
  2. Três painéis: databases.conf, firebird.conf e replication.conf. Cada painel tem uma lista de cópias e o texto do arquivo abaixo dela.
  3. O botão Editar no painel databases.conf (não no modo demo, então ele não está na imagem).
  4. Sob o painel databases.conf: a lista de problemas na cópia escolhida. Ela aparece apenas quando a cópia tem problemas.
  • Cada item de uma lista é o nome do arquivo e o horário da cópia, por exemplo databases.conf (2026-06-26 13:22). A cópia mais recente vem primeiro.
  • Um item é uma versão do arquivo. O agente 2.98.0 e mais recentes grava uma cópia de cada arquivo a cada inicialização e atualização. Cópias iguais que se sucedem aparecem como um único item, com o horário da primeira delas: o momento em que o conteúdo mudou. A lista lê as 500 cópias mais recentes de um arquivo.
  • Em uma janela de desktop, os três painéis preenchem a janela até a borda inferior, e

cada painel rola internamente. A lista de problemas ocupa no máximo um quarto da altura da janela. Em uma janela estreita, os painéis ficam em uma coluna.

Problemas no databases.conf. O console verifica a sintaxe da mesma forma que o Firebird lê o arquivo. Ele também verifica cada parâmetro em um bloco por banco de dados em relação ao que aquela versão do Firebird permite por banco de dados. Cada problema é uma linha: Line 12: <message>. Uma linha de erro é vermelha, uma linha de aviso é âmbar. Quando as chaves { } não correspondem, o texto do arquivo tem fundo vermelho.

O console lê a versão do Firebird a partir dos dados do agente. Quando não consegue encontrar a versão, ele verifica em relação a todas as versões e avisa que a versão é desconhecida. Um nome de parâmetro com um erro de digitação de uma ou duas letras recebe uma dica, por exemplo unknown parameter "DefaultDBCachPages" — did you mean "DefaultDbCachePages"?.

O botão Editar abre o editor de databases.conf. Os outros dois painéis permanecem somente leitura. O botão aparece apenas quando todas estas condições são verdadeiras:

  • O modo demo está desativado.
  • O console consegue abrir o arquivo deste servidor:
    • Modo local (o console roda na máquina com o agente): o agente responde em sua Local API.
    • Modo remoto: o administrador configurou a entrega de configuração (goafts_push_enabled e as chaves goafts_admin_*), o goafts responde e há um arquivo para começar. Ou seja, um arquivo enviado a este servidor antes, ou pelo menos uma cópia de databases.conf do agente.
  • Você pode salvar o arquivo:
    • Modo local: o modo de usuário único, um administrador ou uma conta com o direito May push configuration to agents.
    • Modo remoto: uma conta com o direito May push configuration to agents (veja Users). Um administrador também precisa desse direito.

Se um servidor não tiver o botão Editar no modo remoto, verifique três coisas: o agente ainda não enviou nenhuma cópia de databases.conf (a lista mostra No files), sua conta não tem o direito de push, ou o goafts não responde.

Mensagens que você pode ver

Mensagem O que significa
No files O agente não enviou nenhuma cópia deste arquivo. A lista está desativada.
Error: … O console não conseguiu ler as cópias. O texto informa o motivo.
"}" without an opened block e outras mensagens de sintaxe O Firebird não consegue ler o arquivo neste ponto. Corrija a linha.
parameter “…” cannot be set per database (Firebird …) Este parâmetro funciona apenas em firebird.conf. O Firebird o ignora no bloco.
alias “…” is also defined on line … O mesmo alias está no arquivo duas vezes.
path … has more than one parameter block: … O Firebird usa apenas um dos blocos.
include is not checked: … (aviso) O console não abre arquivos incluídos.
Firebird version is unknown — parameters were checked against all versions (aviso) O agente não enviou nenhuma versão do Firebird.
the file contains binary data O arquivo não é um arquivo de texto.

editor de databases.conf

O editor mostra databases.conf como uma lista de caminhos de banco de dados. Cada caminho tem seus aliases e no máximo um bloco de parâmetros. No Firebird 2.5 o arquivo é aliases.conf: a página o nomeia assim e o mostra apenas na visualização Texto (veja Firebird 2.5: aliases.conf abaixo).

The databases.conf editor in demo mode
The databases.conf editor in demo mode

O que você vê

  1. A linha de cabeçalho:
    • ← Configs volta para a página Configs. Com alterações não salvas, ele pergunta primeiro: “Leave the page? Unsaved changes are lost.”
    • O título databases.conf e a linha de origem: File: <path> no modo local, Delivered through the control center no modo remoto. Em seguida, a versão do Firebird e, no modo remoto, Copy of the server file from <time> ou o resultado do Last delivery.
    • Unsaved changes (âmbar) aparece após sua primeira alteração.
    • À direita: o botão de problemas (No problems, ou Problems: n: vermelho com erros, âmbar apenas com avisos), Form e Text, Reload, Check e Save (chamado Send no modo remoto).
  2. Uma linha de status para os resultados de Check e Save, e uma linha de aviso quando aplicável.
  3. À esquerda: Add database no topo, depois Find alias or path, a lista de caminhos de banco de dados com seus aliases e Included files (as linhas include do arquivo).
  4. À direita: os cartões do caminho selecionado.

A lista de caminhos (esquerda). Find alias or path filtra a lista. Um ponto vermelho ● marca um caminho com erros. Selos marcam um alias que contém o bloco de parâmetros (params), um bloco que o Firebird ignora (ignored) e um alias repetido (duplicate).

Add database. O botão fica no topo da lista de caminhos. Na visualização Texto o mesmo botão fica acima do texto, à esquerda. Ambos abrem o diálogo Add database:

  • Digite o Alias e o Database path. Ambos os campos são obrigatórios: Add permanece desativado enquanto um deles estiver vazio. No modo local, o exemplo no campo de caminho segue o SO do caminho do arquivo (C:\db\name.fdb ou /db/name.fdb); caso contrário, é /db/name.fdb.
  • Add (ou Enter) adiciona a linha ao texto na página. Cancel (ou Esc) fecha o diálogo.
  • Quando o console recusa a entrada, o diálogo permanece aberto com seus valores e mostra o motivo: o alias já existe, o caminho já está no arquivo, o alias ou o caminho tem caracteres que o arquivo não pode conter, ou Fix the text first: it has structural errors. (corrija o texto na visualização Texto e tente novamente).
  • Após Add, a visualização Form seleciona o novo caminho, e a visualização Texto mostra a nova linha. A página mostra Unsaved changes: apenas Save grava o arquivo.
  • Os botões ficam desativados no modo demo, enquanto uma requisição está em execução, quando o editor não consegue abrir o arquivo e quando você não pode salvá-lo.

Os cartões (direita).

  • Database path: o caminho. Remove path remove o caminho e todos os seus aliases, após uma pergunta.

  • Um aviso quando o caminho tem dois blocos de parâmetros: o Firebird usa apenas um deles. Merge into “<alias>” os une; Delete the block of “<alias>” remove um.

  • Aliases: todos os aliases do caminho.

    Coluna O que mostra
    Params Qual alias contém o bloco de parâmetros. Selecione outro alias para mover o bloco para lá.
    Alias O nome do alias, sua linha no arquivo e seus selos.
    Remove Remove o alias, após uma pergunta.

    Digite um nome no campo new alias e clique em + Alias para adicionar um.

  • Parameters (block of “<alias>”): os parâmetros do bloco.

    Coluna O que mostra
    Parameter O nome do parâmetro.
    Value O valor no bloco.
    firebird.conf O valor do servidor de firebird.conf, quando conhecido.
    Remove Remove o parâmetro.

    Para adicionar um, escolha um nome na lista Parameter… (ela tem apenas os parâmetros que esta versão do Firebird permite por banco de dados), digite o Value e clique em + Parameter. Um valor vazio significa que o valor do servidor se aplica. DatabaseAccess não está na lista: o Firebird o ignora dentro de um bloco. Um arquivo que o define em um bloco falha no Check; defina-o em firebird.conf.

  • Ignored block of “<alias>”: um bloco que o Firebird não usa.

Form e Text. Form e Text alternam entre esta visualização e o arquivo bruto. Toda alteração no formulário altera o texto, e comentários e finais de linha permanecem. Quando o formulário não consegue ler o arquivo, corrija-o na visualização Texto.

Firebird 2.5: aliases.conf. O Firebird 2.5 mantém seus aliases em aliases.conf: uma linha alias = path cada, sem blocos de parâmetros. Para esta versão o título da página diz aliases.conf, o editor abre a visualização Texto, e Form e Text não são mostrados. Add database funciona lá também. Quando o console não conhece a versão do Firebird, a visualização Form permanece disponível.

Reload lê o arquivo do servidor novamente. Se você tiver alterações não salvas, o editor pergunta primeiro. Quando você volta para a aba, ou volta para a página no navegador, e o arquivo mudou no servidor, o editor o lê novamente por conta própria (apenas quando você não tem alterações não salvas). Em uma janela de desktop, a lista, o formulário e o texto preenchem a janela até a borda inferior e rolam internamente.

Check e Save.

  • Um alias repetido e um segundo bloco de parâmetros em um caminho são erros. O console os encontra antes que o arquivo vá para o agente, então um agente mais antigo também não consegue salvar tal arquivo.

  • Check valida o arquivo e não grava nada. Save fica desativado enquanto o arquivo tiver erros (dica Fix the errors first) e quando você não pode salvar (dica You have no right to change this file).

  • Modo local: o editor abre o arquivo ativo. Save o envia para o agente. O agente o valida novamente, mantém um backup ao lado do arquivo e recusa o salvamento se o arquivo mudou nesse meio tempo. Então o editor mantém seu texto e oferece Reload. Isso requer fbagent 2.77 ou mais recente. O fbagent 2.83 ou mais recente mantém um backup por sessão de edição, não um por Save, e um Save que não altera nada não grava nada.

  • Modo remoto: o editor abre a cópia que o goafts mantém. Antes do primeiro salvamento, ele abre a cópia mais recente do agente:

    • O fbagent 2.94.0 ou mais recente envia o arquivo byte a byte, com seus comentários, linhas vazias e finais de linha. O cabeçalho mostra Copy of the server file from <time>.
    • Um agente mais antigo envia o arquivo sem comentários e linhas vazias. Então Send primeiro pergunta se deve continuar: o salvamento os remove do arquivo no servidor.

    Send armazena o arquivo no goafts. O agente o pega na próxima sincronização. Ele recusa a alteração quando seu arquivo mudou depois que o editor o abriu. Caso contrário, ele aplica o arquivo com um backup e reporta de volta. Enquanto uma alteração aguarda o agente, a página é somente leitura. O cabeçalho mostra o resultado na próxima vez que você abrir o editor.

  • Todo salvamento é gravado no log de auditoria.

  • No modo demo o editor é somente leitura: todos os botões ficam desativados.

Mensagens que você pode ver

Mensagem O que significa
No problems found Check não encontrou nada.
No errors. See the warnings. Você pode salvar. Leia os avisos primeiro.
The file has errors. / Not saved: the file has errors. Corrija os erros que a lista de problemas mostra.
Saved. The agent keeps one backup next to the file: the file as it was before this editing session. Modo local: o agente gravou o arquivo.
Sent. The agent applies it within about a minute; the result shows here after its report. Modo remoto: o goafts mantém o arquivo para o agente.
The file changed on the server. Your text stays here: copy it, then reload. Alguém alterou o arquivo depois que você o abriu. O editor muda para a visualização Texto. Copie seu texto, clique em Reload e faça sua alteração novamente.
The file changed on the server. The page shows the new version. Você não tinha alterações não salvas, então o editor leu o novo arquivo.
The form cannot read this file. Fix it in the Text view. O arquivo tem um erro de sintaxe que o formulário não consegue mostrar.
Change refused: … / Agent error: … O agente não aceitou o arquivo. O texto informa o motivo.
The agent has not applied the last change yet. Reload the page in a few minutes. Modo remoto: uma alteração enviada aguarda o agente. A página é somente leitura até que o agente reporte.
The agent refused the last change: the file on the server changed after the editor opened it. The page shows the current file. Make the change again. Modo remoto: alguém alterou o arquivo no servidor nesse meio tempo. Faça sua alteração novamente no arquivo que a página mostra agora.
This file is from a snapshot without comments and empty lines. Saving removes them from the file on the server. Continue? Modo remoto com um agente 2.93.0 ou mais antigo. Clique em Cancel para manter os comentários; edite o arquivo no servidor em vez disso.

| A edição não está disponível: … | O console não consegue abrir o arquivo deste servidor (veja as regras do botão Editar em Configs). | | O agente ainda não enviou uma cópia do arquivo. A cópia chega depois que o agente reiniciar. | Modo remoto: o goafts não tem arquivo para este servidor e o console não tem cópia do agente. Reinicie o agente, aguarde a cópia dele e abra o editor novamente. | | Corrija o texto primeiro: ele tem erros estruturais. | Na caixa de diálogo Adicionar banco de dados: o texto tem um erro que o editor não consegue contornar. Feche a caixa de diálogo e corrija o texto na visualização Texto. | | Modo de demonstração: o editor é somente leitura. | Desative o modo de demonstração para editar. |

Erros

Erros do Firebird provenientes do trace: hora, ID da conexão, texto do erro e banco de dados. O mesmo erro que se repete é mostrado como uma linha com uma contagem.

The Errors page
The Errors page

O que você vê

  1. A linha de filtros: Incluir:, Excluir: e Aplicar. Você também pode pressionar Enter em um campo de filtro.
  2. A barra de tempo: o selo do fuso horário, o botão de data, a hora inicial e final, e a lista de predefinições.
  3. O título Erros com o número de linhas, e Exportar CSV à direita dele (não no modo de demonstração, por isso não aparece na imagem).
  4. A barra de páginas: Anterior, os números das páginas, Próxima, o campo Página e a linha de total. A mesma barra também aparece abaixo da tabela.
  5. A tabela de erros.

Intervalo de tempo. O padrão é Última 1h: a hora que termina no último erro do dia. Últimas 6h é 18:00–23:59, Últimas 12h é 12:00–23:59, e Dia inteiro é 00:00–23:59. O link Todos os erros → no relatório de integridade abre o dia como Dia inteiro.

Filtros. Os filtros verificam o texto do erro, o ID da conexão, a hora, o banco de dados, as aplicações, os endereços e a função do Firebird.

A tabela

Coluna O que mostra
# O número da linha.
tstmp A hora do erro (HH:MM), com a data abaixo em fonte menor.
attID O ID da conexão.
count Para uma linha com contagem: ×N, quantos erros a linha contém. A coluna aparece apenas quando algumas linhas têm contagem.
db O banco de dados. A coluna aparece apenas quando um erro nomeia um.
errTxt O texto do erro, com a linha do cliente abaixo.
  • Uma linha com contagem contém um tipo de erro, em um minuto, em um banco de dados. Aponte para ×N para ver a primeira e a última hora e o número de conexões, por exemplo First and last error: 13:05:01-13:05:58; Attachments: 3.
  • A linha do cliente mostra o cliente que recebeu o erro: a aplicação, o endereço do cliente e a função do Firebird. Uma linha com contagem lista as diferentes aplicações e endereços de todos os seus erros (cinco, depois “…” se houver mais). Clique em uma aplicação ou em um endereço para mostrar apenas os erros dela (não no modo de demonstração). A linha fica vazia para dados mais antigos e para clientes que não enviam nome de aplicação (muitos drivers JDBC e .NET).
  • A tabela tem 50 linhas por página. Ela abre na última página, com os erros mais recentes.
  • A linha de total é Total records for 00:00 — 23:59: 394. Quando as linhas têm contagens, ela soma o número de erros: …: 394, errors: 898.

Exportar CSV baixa todas as linhas da tabela, em todas as páginas, com os mesmos filtros e intervalo de tempo.

  • O nome do arquivo tem o dia e o intervalo, por exemplo errors_2026-11-03_1300-1400.csv.
  • O arquivo é UTF-8 com BOM, para que o Excel mostre todas as letras corretamente.
  • O separador é vírgula em inglês e ponto e vírgula nos outros idiomas, para que o Excel abra o arquivo em colunas.
  • Uma linha com contagem permanece uma linha. As colunas são #, date, time, last (a hora do último erro), attID, count, atts (o número de conexões), db, app, host, fn e errTxt. last, count e atts existem apenas quando algumas linhas têm contagem; db apenas quando um erro nomeia um banco de dados. Várias aplicações ou endereços são unidos com ; .
  • Uma célula de texto que começa com =, +, - ou @ recebe um ' na frente, para que o Excel não a execute como fórmula.
  • O botão fica oculto no modo de demonstração, porque o arquivo tem os valores reais. Ele também fica oculto quando a tabela está vazia.

Mensagens que você pode ver

Mensagem O que significa
Nenhum registro para a data e o intervalo de tempo selecionados. Nenhum erro corresponde ao dia, ao intervalo e aos filtros. Escolha Dia inteiro ou limpe os filtros.
Nenhum arquivo de erro encontrado O calendário não tem dias: o agente não enviou erros de trace.
Falha ao carregar as datas: … / Falha ao carregar os erros: … O console não conseguiu ler os dados. O texto após os dois-pontos indica o motivo.

Conflitos

Conflitos de bloqueio e deadlocks provenientes do trace, um minuto por vez. Cada grupo é uma transação que causou conflitos.

The Conflicts page
The Conflicts page

O que você vê

  1. A linha de filtros: Incluir:, Excluir: e Aplicar (ou Enter).
  2. O selo do fuso horário e o botão de data.
  3. À esquerda: a lista de minutos com conflitos, do mais recente para o mais antigo. Um minuto em verde também tem comandos bem-sucedidos. O minuto selecionado fica destacado.
  4. À direita: o título Conflitos com o número de grupos mostrados (após o filtro), e os grupos.

Como ler um minuto:

  1. Escolha um minuto na lista à esquerda. O mais recente fica selecionado.
  2. Cada grupo começa com #n, Transaction ID: <id> e o Error Time.
  3. Compare as duas colunas:
    • Erros de conflito: o ID da conexão, o Processo, o Texto do erro (os códigos e mensagens de erro do Firebird, por exemplo deadlock e update conflicts with concurrent update), e o Comando com falha quando o trace o tem.
    • Comandos bem-sucedidos: os comandos da transação concorrente que tiveram sucesso, com seu Timestamp, ID da conexão, ID da transação e Processo.
  4. Cada comando mostra seu SQL, Parâmetros, Estatísticas e Tabelas.
  • Os filtros funcionam sobre o texto de cada grupo, no navegador. A contagem no título mostra quantos grupos restam.
  • Copiar SQL e Copiar SQL com parâmetros (quando o comando tem parâmetros) ficam ao lado do SQL. Eles levam o SQL para suas próprias ferramentas. Eles ficam ocultos no modo de demonstração.
  • O endereço da página mantém a data e o minuto, para que você possa enviar o link.

Mensagens que você pode ver

Mensagem O que significa
Nenhum arquivo de relatório de conflitos encontrado. O agente não enviou dados de conflitos.
Nenhum dado de conflito para o minuto selecionado. O minuto não tem grupos.
Nenhum erro de conflito / Nenhum comando bem-sucedido Uma coluna de um grupo está vazia.
Falha ao carregar os conflitos: …, Falha ao carregar as datas: …, Falha ao carregar os minutos: … O console não conseguiu ler os dados. O texto indica o motivo.

Relatório de Desempenho

O relatório de desempenho do agente para uma janela de tempo: os comandos SQL mais pesados, planos, procedures, triggers, bancos de dados, processos e endereços de clientes. O agente cria um relatório para cada janela agendada. Ele também pode criar um relatório para qualquer intervalo sob demanda (veja Relatórios sob demanda).

The Perf Report page
The Perf Report page

O que você vê

  1. O selo do fuso horário, o botão de data, a lista Relatórios sob demanda (apenas quando o agente tem tais relatórios) e o botão Criar relatório….
  2. À esquerda: a lista de horários de relatórios do dia, do mais recente para o mais antigo.
  3. À direita: o título Relatório de Desempenho e o resumo da janela.
  4. A linha de ferramentas: a caixa de pesquisa Pesquisar em SQL, plano, processo, endereço, Comparar com, Banco de dados e Baixar JSON.
  5. Os botões de ranking, por exemplo Execução mais longa, Tempo total, Frequência, Fetches, Leituras, Gravações, Planos: tempo e Planos: frequência. O selecionado fica azul.
  6. A tabela do ranking selecionado, por exemplo TOP SQL BY DURATION.
  7. As tabelas DATABASES, PROCESSES e ADDRESSES.

O resumo: Window start, Window end, Statements, Unique statements, Attach e Detach (conexões abertas e fechadas na janela), Total duration (ms), Total fetches, Total reads, Total writes, Total marks, Plans, Failed statements, Databases, Grouped by (por exemplo plan), Source files e Minutes with data (por exemplo 330 / 330). Um valor zero não é mostrado.

Um relatório que o agente criou antes de todos os arquivos de trace da janela serem processados começa com a linha “Incomplete report: some trace files of this window were not processed in time. The numbers cover a part of the window.”

Os rankings. Cada botão abre um ranking. A página mostra apenas os rankings que têm linhas.

Botão Tabela Ordenado por
Execução mais longa Top SQL by duration O tempo de execução de uma execução.
Tempo total Top SQL by total time A soma dos tempos de execução.
Frequência Top SQL by number of runs Quantas vezes o comando foi executado.
Fetches, Leituras, Gravações Top SQL by fetches, by reads, by writes A soma da métrica.
Planos: tempo, Planos: frequência Top plans by total time, by number of runs O mesmo, para um plano.
Tags: tempo, Tags: frequência Top tags by total time, by number of runs O mesmo, para uma tag.
Procedures: tempo, Procedures: frequência Top procedures by … O mesmo, para uma stored procedure.
Triggers: tempo, Triggers: frequência Top triggers by … O mesmo, para um trigger.

Cada tabela mostra 5 linhas. Mais mostra todas as linhas, Menos mostra 5 novamente. Clique no cabeçalho de uma coluna para ordenar. Um comando com execuções com falha tem uma marca failed ou failed: N antes de seu SQL.

  • Top SQL by duration tem as colunas Rank, Duration (ms), Records fetched e SQL.
  • Os outros rankings têm Rank, Count, as somas Duration (ms), Fetches, Reads, Writes e Marks, a participação no total da janela (<metric> %), a média e o maior valor para uma execução (<metric> avg/run, <metric> max/run) e SQL. Um ranking de tag, procedure ou trigger tem o nome na primeira coluna. Um ranking de procedure ou trigger não tem coluna SQL.

DATABASES, PROCESSES e ADDRESSES: uma linha por banco de dados, programa cliente ou endereço de cliente, ordenada por duração.

Coluna O que mostra
Database / Process / Address O banco de dados, o programa cliente ou o endereço do cliente.
Count Os comandos.
ATT, DET Conexões abertas e fechadas.
Duration (ms), Fetches, Reads, Writes, Marks Somas para o banco de dados, programa ou endereço.
Unique plans, Unique statements, Uniq. connections Quantos planos, comandos e conexões diferentes.

Uma linha aberta. Clique em uma linha de um ranking para abri-la. Ela mostra:

  • SQL: com os botões de cópia, Plan: e Parameters:. Quando o trace cortou o texto (max_sql_length), uma nota informa isso.

  • Table stats: apenas os contadores que o trace do Firebird fornece para cada tabela: natural, index, update, insert, delete, backout, purge e expunge. Fetches, reads, writes e marks existem apenas para o comando como um todo.

  • Distribuído pelas execuções: Min, Média, Mediana, Máx, Soma e % da janela de cada métrica.

  • Execuções por hora: as execuções e a % de duração em cada hora.

  • Detalhes: a execução de amostra da instrução: Tempo de execução, se terminou com erro, Execuções com falha, Banco de dados, Processo, Endereço do cliente, ID de anexo, ID da instrução, Linha de trace, Hash da instrução, Hash do plano e os principais bancos de dados e endereços. Um campo que o relatório não possui é omitido.

  • Traces deste minuto (em Detalhes): abre a página do banco de dados no minuto da execução de amostra, para que você possa ver o trace e as conexões daquele minuto. Só aparece quando o console conhece o banco de dados.

  • Histórico, 30 dias: uma tabela da instrução em cada janela dos últimos 30 dias: Janela, Contagem, Total, ms (com uma barra) e Média, ms. Clique em uma janela para abri-la. Um relatório contém apenas o topo de cada ranking. Assim, uma janela em que a instrução não estava no topo mostra não está no topo. Isso não significa que a instrução não foi executada. outro agrupamento significa que aquela janela agrupa as instruções de outra forma (por plano ou por SQL).

As linhas de DATABASES, PROCESSES e ADDRESSES não abrem.

Pesquisa. Digite em Pesquisar em SQL, plano, processo, endereço. Todas as tabelas mostram apenas as linhas que contêm o texto. “Nenhuma linha corresponde à pesquisa.” significa que nenhuma linha de uma tabela contém o texto.

Comparar com. Escolha Janela anterior, Um dia antes, Uma semana antes ou Outra janela… (depois escolha a data e a hora). A tabela Alterações em relação a <janela> mostra cada instrução em ambas as janelas: Instrução, Execuções A, Execuções B, Total A, ms, Total B, ms, Alteração, ms, Média A, ms e Média B, ms. A é a janela aberta, B a outra. Escolha Nada para ocultar a tabela.

Mensagem O que significa
As janelas agrupam as instruções de formas diferentes (por plano e por SQL). Elas não podem ser comparadas. Escolha outra janela.
As janelas diferem em duração em mais de 10 %. Compare os números com cuidado. Os totais não são para o mesmo período.
A outra janela é um relatório incompleto. Seus números cobrem apenas uma parte da janela.
não está no topo da outra janela A instrução está no topo de apenas uma janela.
Não existe tal janela. O agente não tem relatório para esse horário.

Banco de dados. Escolha um banco de dados para ver apenas suas linhas. Todos os bancos de dados mostra todos. O item Relatório de desempenho das páginas de banco de dados abre esta página com seu banco de dados já escolhido. Os números de uma linha ainda cobrem todos os bancos de dados em que a instrução foi executada (“Os números de uma linha cobrem todos os bancos de dados em que a instrução foi executada.”). A tabela DATABASES marca o banco de dados escolhido.

Enquanto um banco de dados está escolhido, a linha do banco de dados das páginas de banco de dados aparece sob o cabeçalho: o rótulo DB, o nome do banco de dados e as páginas desse banco de dados. Clique em Banco de dados ou Métricas ali para abri-las para o mesmo dia. A linha aparece apenas para um banco de dados que o console conhece (está na tabela Bancos de dados do dashboard). Todos os bancos de dados oculta a linha.

The database row on the Perf Report page
The database row on the Perf Report page

Baixar JSON salva o arquivo de relatório do agente como está.

A partir do relatório de integridade. O botão Relatório de desempenho na seção Consultas do relatório de integridade abre esta página na janela que contém o horário do status. As linhas dessa consulta são marcadas com um fundo azul e uma barra à esquerda. A primeira está aberta e na tela; a tabela mostra todas as linhas se necessário. Quando você escolhe outra data ou hora, a marca desaparece.

Um formato de relatório antigo tem uma tabela e os campos de resumo Linhas processadas e Registros criados.

Uma janela sem relatório. Às vezes o agente fecha uma janela e nunca constrói seu relatório. Ele então grava um pequeno arquivo no lugar do relatório. A lista de horários mostra tal janela com uma nota curta:

Nota Por que não há relatório
construção abortada A construção desta janela foi interrompida vezes demais. O agente não tenta novamente.
falha na construção A construção desta janela falhou vezes demais.
arquivos de trace demais A janela tem mais arquivos de trace do que uma execução pode processar (max_files_per_run).
expirada A janela era mais antiga que o limite de processamento (horizon_days) quando chegou sua vez.
sem dados de trace Não havia dados de trace para a janela.
arquivos de trace inutilizáveis Os arquivos de trace da janela não puderam ser usados.

Clique em tal horário: a página mostra uma frase que explica o motivo, e nenhuma tabela vazia. Quando a página abre, ela mostra o relatório real mais recente, não tal janela.

Relatórios sob demanda

Um relatório sob demanda cobre um intervalo que você escolhe, por exemplo os 40 minutos de um período lento. Ele não altera as janelas agendadas.

The Build report form
The Build report form

Para construir um:

  1. Clique em Construir relatório…. O formulário Construir um relatório sob demanda abre.
  2. Defina Início e Fim. Eles estão no horário do agente, o mesmo relógio das janelas. O intervalo é de no máximo 24 horas por padrão.
  3. Opcional: escolha um Banco de dados (Todos os bancos de dados, um banco de dados do servidor, ou Outro… com um Nome do banco de dados), um Limite, ms (apenas instruções que foram executadas por pelo menos esse tempo) e um Filtro de processo.
  4. Clique em Construir. Fechar fecha o formulário sem uma solicitação.

A solicitação segue o mesmo caminho que Executar agora do editor de configuração (veja Executar agora): diretamente para um agente ao lado do console, através do HQCenter para um agente remoto. A página acompanha a execução: “Solicitação enviada, aguardando o agente aceitá-la”, “O agente está construindo o relatório”, “Relatório construído”. Cancelar execução a interrompe. Quando o arquivo chega, a página abre o relatório: “Relatório construído e aberto.”

A lista Relatórios sob demanda mostra os relatórios que o agente construiu, com o intervalo, os filtros e o estado. Escolha um para abri-lo. Escolha Janelas agendadas para voltar às janelas. Um relatório sob demanda aberto tem a linha Relatório sob demanda com seu intervalo e filtros sobre o resumo. Ele não tem Comparar com nem Histórico, 30 dias. O agente mantém os 20 relatórios mais recentes desse tipo.

O botão precisa do fbagent 3.3.0 ou mais recente e do direito de executar jobs (veja Adicionar ou editar um usuário). O agente constrói um relatório sob demanda por vez. Quando o botão está desativado, aponte para ele para ver o motivo, por exemplo “Você não pode iniciar jobs neste agente.” ou “O agente é antigo demais para aceitar este job.”. A página então também mostra o comando que constrói o mesmo relatório no agente: fbagent --process-perf-report --start YYYYMMDD_HHMM --end YYYYMMDD_HHMM --on-demand.

Mensagens que você pode ver

Mensagem O que significa
Nenhum arquivo de relatório de desempenho encontrado. O agente não gravou nenhum relatório de desempenho.
Nenhum dado para o horário selecionado. O relatório escolhido está vazio.
A consulta do relatório do servidor não está nas listas de topo deste relatório. Você veio do relatório de integridade, mas esta janela não tem a consulta em suas listas de topo.
Nenhum dado para este banco de dados nesta janela. O banco de dados escolhido não tem linhas neste relatório.
Um relatório está sendo construído. O agente está construindo outro relatório sob demanda. Aguarde até que termine.
O intervalo é maior que 24 horas. … Torne o intervalo mais curto.
Expirado: o agente não aceitou a solicitação a tempo O agente não aceitou a solicitação. Verifique se ele está em execução e sincronizando.
Este relatório sob demanda foi removido: … O agente mantém apenas os 20 mais recentes. A página mostra as janelas agendadas.
Falha ao carregar o relatório de desempenho: …, Falha ao carregar as datas: …, Falha ao carregar os horários: … O console não conseguiu ler os dados. O texto informa o motivo.

8. Relatório de integridade do servidor

O Relatório de integridade do servidor (/report) combina os snapshots de status do agente e seu relatório de IA para um dia. Abra-o com:

  • o link Relatório na coluna Status da página Servidores,
  • uma célula da Faixa do servidor, ou
  • os links Status do servidor e Relatório deste minuto no dashboard.
The server health report
The server health report

O que você vê

  1. O cabeçalho: Relatório de integridade do servidor, o selo do fuso horário, a lista IA e a lista Status com ← e →.
  2. Estado do sistema: o estado de cada sistema ao longo do período.
  3. Totais para 24 h (ou o período escolhido): tempo por nível e a lista de problemas.
  4. Relatório para DD.MM HH:MM: o veredito do snapshot exibido e suas alterações.
  5. O relatório do snapshot: os arquivos, os fatos principais, o resumo, as áreas, os indicadores principais e as descobertas.
  6. As seções Erros, Consultas e Backups.
  7. Os painéis Fontes e Agente, e uma linha de contadores extras.
  8. Detalhes do sistema: um painel por sistema.

Todos os horários na página estão no fuso horário do agente. Os dados vêm dos snapshots de status do agente (cerca de um a cada 10 minutos) e seus relatórios de IA.

  • Um link sem data abre o dia do snapshot mais recente.
  • Um link pode terminar com uma seção, por exemplo #area-backups ou #report-backups. A página então abre nessa seção e a marca por um momento.
  • No modo demo, a página mascara nomes de servidores e bancos de dados, e cada pasta e nome de arquivo de um caminho, também dentro das chaves de descobertas. Os separadores e a extensão do arquivo permanecem.

Mensagens que você pode ver

Mensagem O que significa
Escolha um servidor: o parâmetro de consulta do servidor é obrigatório. O link não tem servidor. Abra o relatório na página Servidores ou no dashboard.
Nenhum dado de relatório para a data selecionada. O agente não enviou nenhum snapshot de status nem relatório de IA para esse dia. As listas no cabeçalho estão ocultas.
Nenhum snapshot de server_status neste período A matriz de Estado do sistema não tem dados para o período.
snapshot de status inválido / relatório de IA inválido O console não conseguiu ler o arquivo. Escolha outro horário nas listas do cabeçalho.

Estado do sistema ao longo de um período

O topo da página mostra o servidor ao longo de um período.

  • Período: 24 h, 7 dias ou 14 dias. O período termina no fim do dia do relatório, ou agora para hoje. Ele permanece quando você abre outro snapshot dentro dele. Enquanto dias mais antigos carregam, a página mostra Carregando….
  • Estado do sistema: uma linha para o Servidor e uma linha para cada sistema: CPU, Memória, Limites do SO, Discos, Velocidade do disco, firebird.log, Erros de trace, Transações e GC, Locks, Consultas, Conexões, Índices, Backups, jobs do fbagent, Replicação, agente fbagent, Segurança e licença. Outras descobertas é uma linha apenas quando teve um problema. O ponto antes de um nome mostra o pior nível daquela linha.
    • Uma célula é de 1 hora (24 h), 4 horas (7 dias) ou 6 horas (14 dias). Ela mostra o pior nível naquele período. A legenda explica as cores: vermelho é grave, laranja é aviso, verde é OK, hachurado é sem snapshots. A célula com a moldura azul é o snapshot no relatório. Aponte para uma célula para ver seu horário, sistema e nível.
    • Clique em uma célula para abrir o relatório naquele horário. Clique em um nome de sistema para abrir

seu painel em Detalhes do sistema.

  • Snapshot mostra o nível no snapshot exibido. Para CPU, Memória, Disco e Conexões, mostra o valor (por exemplo 8.9 %, 0.2 ms, 1160).

  • Desde mostra desde quando o sistema está nesse nível: desde 10:40, ou desde 03.11 00:00 quando começou em outro dia.

  • apenas sistemas com problemas no período oculta as linhas que estavam OK o tempo todo e lista seus nomes após OK durante todo o período:.

  • Totais de 24 h: os blocos Grave, Aviso, OK e Sem snapshots mostram quanto tempo o servidor ficou em cada nível. Problemas mostra quantos problemas houve, com os graves abaixo. Um bloco com valor acima de zero é colorido. A tabela abaixo lista cada problema:

    Coluna O que mostra
    Início Quando o problema começou. ≤ significa que começou antes do período.
    Fim Quando terminou. ainda ativo significa que ainda está aberto agora; ativo no fim significa que estava aberto quando um período passado terminou.
    Duração Quanto tempo durou.
    Nível O selo de nível.
    Sistema O sistema do problema.
    Achado A chave do achado.

    Clique em uma linha, ou pressione Enter nela, para abrir o relatório naquele momento. A tabela mostra até 300 linhas, depois … mais não exibidos. Sem problemas, ela diz Nenhum problema neste período.

  • Relatório de DD.MM HH:MM: o nível e a linha principal do snapshot exibido. Para um snapshot mais antigo, uma faixa diz Snapshot do histórico: <time>, e Para o snapshot mais recente do período abre o mais novo. Duas linhas de chips mostram as mudanças:

    • Desde o snapshot anterior: a mudança em relação ao snapshot anterior.
    • Ao longo do período: a mudança em relação ao primeiro snapshot do período.
    • + key é um novo achado, ↑ key é um achado que piorou (aviso para grave), − key é um achado que foi resolvido. sem mudanças significa que nada mudou.

O relatório do snapshot

Abaixo das seções de período, o relatório de um snapshot mostra:

  • As listas IA e Status (no cabeçalho): escolha um relatório de IA ou snapshot de status mais antigo do mesmo dia. IA mais recente e Status mais recente são os mais novos. Os botões ← e → ao lado da lista de Status abrem o snapshot de status anterior e o próximo, também atravessando a meia-noite (aponte para um botão para ver o horário). O botão Voltar do navegador retorna pelos snapshots que você abriu.
  • Arquivos selecionados: os nomes dos dois arquivos, ou Sem snapshot de status para a data / Sem relatório de IA para a data. Um aviso como Os carimbos de data/hora de Status e IA diferem em 190 min significa que os dois arquivos foram gerados com mais de 15 minutos de diferença.
  • O nível (por exemplo WARNING), o selo HQbird e uma linha de fatos principais. O nível é o nível do servidor a partir do veredito do agente; um snapshot sem veredito mostra sua severidade antiga. Um pequeno selo Agente: LEVEL aparece apenas quando o nível do próprio agente é pior. Os fatos principais são: versão do agente e do Firebird, o Modo do Firebird (SuperServer, SuperClassic ou Classic; fbagent 2.94.0 ou mais recente), número de bancos de dados, conexões (com a mudança, por exemplo (Δ+12)), o gargalo principal e o secundário, e o horário do status e do relatório de IA. Quando firebird.conf define outro modo, uma nota após o modo informa isso, por exemplo “firebird.conf define Classic: entra em vigor após uma reinicialização do Firebird”.
  • O texto do resumo do relatório de IA.
  • Áreas: chips como engine_errors, io, queries, backups, clients, agent, cpu. Um chip colorido tem achados e mostra quantos. Clique nele para ir aos achados dessa área. Um chip cinza não tem achados e não é um link.
  • Indicadores principais: blocos do snapshot de status. Um bloco é um link apenas quando sua seção está na página.
    Bloco O que mostra O clique leva a
    ERRORS Os erros de trace do dia, com os erros LWM abaixo (today · LWM 1.92M). Sua cor segue os achados abertos de erros de trace e LWM: vermelho é grave, âmbar é aviso, sem cor significa nenhum achado ou um reconhecido. Seção Erros
    LONG_TX O número de transações longas. Apenas quando há algumas. Não é um link
    LWM_LAST O horário dos dados LWM mais recentes. Âmbar com stale …s quando a fonte lwmmon está atrasada. Painel de fontes
    AGENT_LOGS A pasta de logs do agente em porcentagem do seu limite, e o tamanho (3.00 / 3 GB). Vermelho em 100% ou mais. Painel do agente
    RESOURCE_GUARD O estado do resource guard do agente, por exemplo cooldown. Painel do agente
    CPU_HOST CPU % e, abaixo, carga e ram %. Com avg 10m, os números são as médias de 10 minutos, as mesmas da matriz de Estado do sistema. Um snapshot mais antigo mostra os valores daquele momento, com a RAM usada e total. Esmaecido com — e cpuram missing quando o agente não enviou dados do host. Os achados de cpu; um link apenas quando o snapshot tem um achado de CPU

Abaixo estão os achados, em grupos por área na ordem dos chips. Cada grupo mostra sua contagem. Em cada grupo, o achado mais grave vem primeiro. Achados do relatório de IA que não têm área estão no último grupo, outros. Os grupos queries e backups têm um link para sua tabela: → tabela de consultas e → tabela de backups.

Findings of the health report
Findings of the health report

Um cartão de achado tem estas partes:

  • O cabeçalho: o selo de severidade (SERIOUS, WARNING, …), NEW para um achado novo desde o snapshot anterior, a chave do achado (por exemplo backups/none//data/employee.fdb) e a fonte: status (o snapshot de status), ai (o relatório de IA) ou status + ai (ambos o nomeiam).
  • O título: o que o agente encontrou.
  • Do relatório de IA: Explicação, Impacto e Próximas verificações. Evidência mostra quando difere do título.
  • Do snapshot de status: uma Dica curta, por exemplo “configure nbackup/vbackup ou escaneie caminhos”.
  • Os achados filesystem_warnings e filesystem_errors têm um bloco Encontrado: os caminhos que a verificação de sistema de arquivos do agente encontrou (até 5, com o motivo) e Verificado em <time>. Um agente mais recente que o fbagent 3.1.0 grava as pastas, os problemas e o horário da verificação no título. O bloco Encontrado então lista apenas os problemas que o título não nomeia, para que uma pasta seja nomeada uma vez. Com um agente mais antigo, o título tem apenas a contagem, e o bloco lista todos os caminhos.
  • Botões de ação, quando a configuração do agente pode corrigir o achado. O primeiro botão é o principal.
  • Um achado com um valor o mostra em relação ao seu limite em uma linha, por exemplo 476.5 MiB / 1 GiB ou 25.2 h / 1 h. Cada número tem sua própria unidade.

Todo achado ativo tem um cartão. Um agente mais recente lista todos os seus achados, mas fornece um texto apenas para os 15 piores. Um achado sem texto é um cartão curto apenas com sua chave. A tabela de Backups também tem uma linha para cada achado de backup, além dos 15 também. Um achado das filas de processamento, por exemplo queue/conflict_trace_queue_age_seconds, mostra o texto e a dica do agente como seu título (agente 2.90.0 e mais recente), não apenas sua chave.

Achados repetidos compartilham um cartão. Três ou mais achados com a mesma chave de início e o mesmo nível, por exemplo 13 fontes de replicação que o agente não consegue ler, são um cartão. O cartão lista os objetos: o nome, o texto, desde quando, e NEW. Os primeiros 10 estão abertos; Mostrar mais N mostra o restante. Um botão de correção para um banco de dados permanece ao lado desse banco de dados. Um botão que todos os objetos compartilham aparece uma vez no cartão. Apenas snapshots com veredito (schema 26 ou mais recente) unem achados assim. Os chips de área e as contagens de grupo ainda contam cada achado.

Botões de ação. Um botão abre o Editor de configuração do agente naquele local: ele adiciona o job para o banco de dados, abre o job ou sua linha, ou mostra a configuração. Exemplos: Adicionar um job nbackup, Adicionar um job de backup gbak, Definir as pastas de verificação .nbk, Definir as pastas de verificação .fbk, Abrir as configurações de verificação de backup, Abrir a página Backups, Adicionar um job de estatísticas de índice, Editar os erros de firebird.log ignorados, Abrir o job.

  • O editor não salva nada até você clicar em Salvar. Se um job para esse banco de dados já existir, o editor o abre e não adiciona um segundo.
  • Você vê os botões apenas se puder abrir o editor para este servidor, e apenas se o servidor tiver uma configuração de agente.
  • Uma linha na tabela Backups tem apenas o botão principal.
Backup findings with action buttons
Backup findings with action buttons

Seções Erros, Consultas e Backups

Após os achados vêm as seções Erros, Consultas e Backups. Uma seção aparece apenas quando tem dados.

The Errors section and the Backups table
The Errors section and the Backups table

Erros: os erros de trace do dia. A primeira linha é Trace: 893 today · LWM: 21892 today (0 per connection). A parte entre colchetes requer um agente que a envie. A tabela tem os cinco tipos mais frequentes de erro de trace:

Coluna O que mostra
Classe A classe do erro e seu código Firebird, por exemplo io_open 335544344.
Erro O texto do erro.
Contagem Quantos erros desse tipo o dia tem.
Participação A participação de todos os erros de trace do dia.
Bancos de dados Em quantos bancos de dados o erro ocorreu.

Todos os erros → abre a página Erros para esse dia. Os tipos precisam de um agente que os envie.

Consultas: as principais consultas do snapshot de status e do relatório de IA.

Coluna O que mostra
# A classificação.
Fonte status ou ai.
DB O banco de dados.
Média s O tempo médio de execução em segundos.
Execuções Quantas vezes a consulta foi executada.
SQL O texto da consulta. Clique em Plano para ver o plano de execução. Relatório de desempenho abre a janela Relatório de desempenho que contém o horário do status e marca a consulta ali. Antes de o agente gravar essa janela, a célula diz Ainda sem relatório de desempenho para este horário. Quando o agente fechou a janela sem um relatório, a célula diz Sem relatório de desempenho para este horário: e o motivo. Consultas de um agente mais antigo não têm botão.

Backups: uma linha por achado de backup.

The Backups table, the Sources and Agent panels
The Backups table, the Sources and Agent panels
Coluna O que mostra
DB O caminho completo do banco de dados, também no Linux, por exemplo /data/employee.fdb. Um achado para o servidor inteiro mostra —. Uma linha que apenas o relatório de IA nomeia mostra o nome que a IA usou.
Tipo O tipo do achado: none (sem backup), nbackup_locked (o banco de dados está em um bloqueio nbackup), stale, nbk_missing e assim por diante.
Desde Quando o achado começou: 19:30, ou 11-02 19:30 quando começou em um dia anterior.

| IA | ✓ quando o relatório de IA também nomeia este banco de dados. | | (última coluna) | NOVO para um achado novo, uma nota como OIT gap (AI), e o botão de ação principal. |

Sources e Agent são dois painéis lado a lado.

Coluna Sources O que mostra
Source A fonte de dados do agente, por exemplo cpuram, lwmmon, diskio.
State ok, stale (atrasado) ou missing. Uma linha atrasada ou ausente é marcada.
Age O tempo desde o dado mais recente da fonte, por exemplo 57s, 4m, 1h ou 24h.

O painel Agent mostra o próprio estado do agente: severity, failing (as tarefas com falha), logs disk (percentual do limite e tamanho), self_repair (reparos nas últimas 24 horas e o último) e resource_guard (o estado e o horário do último acionamento). Uma linha aparece somente quando tem um valor.

Abaixo dos painéis, uma linha mostra contadores que só o snapshot de status possui, por exemplo lock_conflicts_today 674 · conflict_reports_today 266.

Detalhes do sistema

Detalhes do sistema, no final da página, tem um painel por sistema (não para a linha Server). Outros achados tem um painel somente quando houve um problema. A linha de cada painel mostra o nome, o selo de nível e o valor atual. Um painel fica aberto quando o sistema teve um problema no período ou tem um agora.

System details: one panel per system
System details: one panel per system
  • CPU, Memória e Velocidade do disco têm um gráfico da média de 10 minutos, com linhas tracejadas de limite: Thresholds: warning X, serious Y (10-minute average). A velocidade do disco é a latência de escrita do pior disco de banco de dados. Sua linha de números é read … ms · write … ms · worst minute … ms · … MB/s.
  • Conexões tem um gráfico de conexões (attachments).
  • Os outros sistemas têm uma faixa colorida do seu nível.
  • A linha azul marca o snapshot exibido. Clique em um gráfico para abrir o relatório naquele momento.
  • Abaixo do gráfico estão os achados do snapshot exibido, com links para o grupo deles no relatório, ou No active findings in this snapshot.
  • Um botão abre a página que ajuda a aprofundar: Dashboard (CPU, Memória, Velocidade do disco, Conexões), firebird.log (a página Logs), Errors (Trace errors) ou Performance report (Queries).

Tabelas nos painéis. Quatro painéis também mostram os números que o agente mediu no snapshot exibido. Uma tabela mostra suas primeiras 10 linhas e Show N more. Um valor que o agente omitiu é uma célula vazia ou nenhuma linha. Um snapshot sem esses números mostra o painel sem tabelas.

  • Discos: Volumes (volume, para que é usado, % usado, livre, total) e Pastas temporárias (pasta, origem, volume, livre, total, nível). O volume que o achado de espaço livre do agente mediu tem seu nível e vem primeiro.

    The Disks panel with its Volumes and Temp folders tables
    The Disks panel with its Volumes and Temp folders tables
  • Transações e GC: Bancos de dados (OIT gap, OAT gap, OAT gap em tempo, transações por minuto, transações longas), o banco de dados com mais transações longas primeiro; e Transações longas (idade, banco de dados, usuário, processo, endereço), a mais antiga primeiro. Uma coluna aparece somente quando uma linha tem um valor para ela. Na imagem o snapshot não tem OAT gap em tempo, então a tabela não tem essa coluna. Quando o snapshot conta mais bancos de dados do que lista, uma nota informa isso.

    The Transactions and GC panel with its databases and long transactions
    The Transactions and GC panel with its databases and long transactions
  • Replicação: Masters (banco de dados, segmentos no arquivo, tamanho do arquivo, segmento mais antigo) e Réplicas (banco de dados, segmentos aguardando, tamanho em espera, lag, última aplicação, erro). Linhas com erro vêm primeiro, depois o maior lag ou o maior arquivo. Uma coluna aparece somente quando uma linha tem um valor para ela.

  • Agente fbagent: a própria saúde do agente. Estado do agente (uptime, reinicializações em 24 h, arquivos aguardando upload e o mais antigo, uploads com falha em sequência, último upload bem-sucedido, erros de log em 1 h e 24 h, última autoatualização, resource guard, CPU e memória do agente) mostra todas as suas linhas. Filas de arquivos (conflitos de lock, trace, relatório de performance: arquivos, tamanho, arquivo mais antigo) e Top tarefas, últimos 15 min (tempo de CPU, execuções, crescimento de memória, pontuação).

    The fbagent agent panel: agent state, file queues and top tasks
    The fbagent agent panel: agent state, file queues and top tasks

No modo demo, os nomes de bancos de dados, usuários, processos, endereços, caminhos e textos de erro nessas tabelas são mascarados.

A densidade de exibição na página Settings deixa o texto do relatório menor ou maior.


9. Editor de configuração do agente

O editor de configuração do agente tem três páginas:

  • Jobs abre o editor. Ele tem as abas Jobs, Settings, Problems e Activity.
  • Backups abre o inventário de backups do servidor.
  • Activity mostra como as tarefas do agendador do agente foram executadas.

Os links Jobs e Backups aparecem no menu superior somente quando o console tem a configuração do agente. O menu superior marca Jobs nas páginas Jobs e Activity, e Backups na página Backups.

O guia do usuário do fbagent descreve cada job e configuração em detalhes. Este capítulo explica as páginas.

The configuration editor: Jobs tab
The configuration editor: Jobs tab

O que você vê

  1. O cabeçalho do console: ← Servers, o nome do servidor, o menu superior e a linha de breadcrumb, por exemplo Servers › SRV › Jobs.
  2. O cabeçalho do editor: o arquivo que o editor abriu, o selo de dados, ↻ Refresh, e os botões de salvar à direita.
  3. Uma linha de nota abaixo do cabeçalho. No modo remoto, ela diz que a página mostra uma cópia da configuração do agente.
  4. As abas Jobs, Settings, Problems (com o número de problemas) e Activity. O selo TZ fica na extremidade direita da linha de abas.
  5. A tabela de jobs, em grupos: Backups, Restore, Maintenance, Performance monitoring, SQL update, Health-check e System jobs.
  6. Na parte inferior: a tabela Scheduler tick tasks.

O cabeçalho do editor

  • ← Servers volta para a página Servers. A linha de breadcrumb mostra onde você está: Servers › SRV › Jobs, Servers › SRV › Jobs › Activity ou Servers › SRV › Backups. Clique em uma parte dela para ir até lá.
  • O arquivo que o editor abriu. No modo remoto, este é o snapshot de configuração mais recente que o agente enviou.
  • O selo de dados, por exemplo DATA: 3 DATABASES · LAST RUNS · AGENT 3.4.0. Ele mostra o que o editor sabe a partir dos dados do agente: a lista de bancos de dados, as últimas execuções dos jobs e a versão do agente. Aponte para ele para ver a pasta de dados, o horário da lista de bancos de dados, quantos bancos de dados foram anexados no último registro e quando o editor leu os dados.
  • ↻ Refresh lê os dados do agente novamente: os resultados dos jobs, as últimas execuções e os comandos registrados.
  • Discard changes descarta suas alterações não salvas. Uma marca unsaved changes com uma contagem aparece depois que você edita algo. Aponte para ela para ver as seções alteradas.
  • Os botões de salvar. Eles dependem do modo (veja Saving: local mode e Saving: remote mode). O salvar funciona imediatamente, também enquanto o cursor ainda está em um campo em que você está digitando.
  • Open aparece no modo remoto quando há rascunhos. Ele lista a configuração do agente e seus rascunhos.
  • O selo TZ: o fuso horário do agente (agent.timezone), seu deslocamento UTC e a hora atual lá. Os agendamentos usam esse fuso. Aponte para o selo para ver a diferença em relação ao horário do seu navegador. Clique nele para definir o fuso. Quando o fuso está vazio, o selo mostra TZ not set: então os agendamentos seguem o fuso do host do agente.

Mensagens que você pode ver

Mensagem O que significa
RUNTIME: OFFLINE (em vez do selo de dados) O editor não encontrou dados do agente. As colunas Last run e Result ficam vazias.
Refresh failed — the editor could not read the agent runtime files ↻ Refresh não funcionou. Tente novamente mais tarde.
This page shows a copy of the agent’s configuration. Edit it, then click Save and Send to agent. The agent applies your change in about a minute. Modo remoto com entrega. A página também mostra esta linha nas páginas Backups e Activity.
Reading a copy of the agent’s configuration. This console cannot deliver an edit to the agent; download the JSON and apply it on the agent host. Modo remoto sem entrega. Você pode ler a configuração, mas não enviar uma alteração.
… the file the agent writes this from did not arrive with the logs. Uma parte dos dados do agente está faltando no console. A linha nomeia a parte, por exemplo The Last run column ou The database picker.
… no agent data tree was found beside this configuration. O console tem a configuração, mas não tem dados do agente.
… the newest records are older than this agent should be producing, so what is shown is not current. Os dados do agente estão antigos. Em um console, o próximo pacote de logs geralmente traz dados novos.
… the file is in a newer format than this editor reads. O agente é mais novo que o editor. Atualize o HQ Monitor.
The Result column is empty because the agent did not send the job-start information. O agente não enviou os resultados dos jobs.

Aba Jobs

Os jobs estão em grupos. O cabeçalho do grupo diz quantos jobs estão ativos, por exemplo 1 of 2 enabled. O grupo Restore é marcado como destructive · designed for forced runs: esses jobs são destinados a Run now, não a um agendamento.

Cada linha é um tipo de job:

Coluna O que mostra
(+) Abre a linha: os jobs deste tipo, suas opções e a última execução.
Job O nome e a tarefa do agendador, por exemplo process_traces. Pequenos selos dão mais informações, por exemplo PER-DB (uma execução por banco de dados) ou ALIAS: DUMP_BACKUP (o antigo nome de tarefa dump_backup executa os mesmos jobs).
Actions + Add job para tipos de job que mantêm uma lista de jobs (por exemplo, um job de backup por banco de dados). Uma lista Enabled / Disabled para as outras linhas. Clear & enable quando o resource guard interrompeu a tarefa.
Status Se o job é executado (veja a tabela abaixo). Um motivo curto pode aparecer sob a palavra de status.
Schedule O cron da tarefa. per job significa que cada job da lista tem seu próprio agendamento. on tick significa que os jobs são executados a cada tick da tarefa. continuous é uma tarefa que é executada o tempo todo. A linha Performance test também mostra sua janela de execução com os dias da semana.

| Última execução | Quando a tarefa ou o job foi executado pela última vez, no horário do agente, no formato de 24 horas. | | Resultado | OK, ERROR, NEVER (nunca executado) e outros (veja abaixo). | | Detalhes | Com o que o job trabalha, por exemplo armazenamentos FBK/NBK do servidor ou host. |

+ Adicionar job adiciona um job e rola até o formulário dele. O primeiro job de um tipo de job comum também ativa sua seção e cria sua tarefa de agendador. Quando você exclui o último job, o editor remove a tarefa. Um tipo de job destrutivo (Restore, SQL update) nunca se ativa sozinho: um novo job desse tipo é criado desativado.

Status. Um job só é executado quando dois interruptores estão ativados: o flag de sua seção e sua tarefa de agendador. A coluna Status mostra ambos. Quando os dois interruptores dizem coisas diferentes, o motivo é escrito em texto pequeno sob a palavra de status.

Status Significado
Enabled Ambos os interruptores estão ativados.
n de m ativados Uma lista de jobs: n dos seus m jobs estão ativados.
0 de m ativados, com todos os jobs desativados sob isso A seção e a tarefa estão ativadas, mas todos os jobs da lista estão desativados. A importação do HQbird deixa um tipo de job assim de propósito: ela importa os jobs desativados, para você verificar.
Disabled Ambos os interruptores estão desativados. nenhuma linha de marcação sob isso: o agendador não tem tarefa para este tipo de job.
gates differ Um interruptor está ativado e o outro desativado. O job não é executado. O motivo sob isso diz qual está desativado: seção desativada, seção desativada (padrão), marcação desativada ou nenhuma linha de marcação.
no jobs A lista de jobs está vazia. + Adicionar job cria o primeiro.
not present O agendador não tem tarefa para este job, e o job está desativado por padrão.
row missing O job está ativado por padrão, mas o agendador não tem tarefa para ele.
Suspended A proteção de recursos do agente interrompeu a tarefa por enquanto. A proteção é nomeada sob isso, por exemplo por resource_guard.

Resultado. Uma lista de jobs mostra o pior resultado dos seus jobs ativados.

Resultado Significado
OK A última execução funcionou.
WARN A última execução terminou com um aviso.
ERROR A última execução falhou. Aponte para ela para ver o erro.
RUNNING O job está sendo executado agora.
DEFERRED O job aguardou outro job, por exemplo por um bloqueio de banco de dados. Isso não é um erro.
STALE O arquivo de status na pasta do job pertence a outro job ou outro banco de dados, então não é o resultado deste job. Dê ao job sua própria pasta.
NEVER O job nunca foi executado.
NOT HERE Os arquivos de status do job ficam no host do agente e não chegaram a este console. O job ainda pode ser executado normalmente.
TICK OK / TICK ERR A página não tem resultado para cada job, então mostra o resultado do último tick do agendador.

overdue (a cada Nm) sob o horário da Última execução significa que a tarefa não foi executada por mais de três vezes o seu intervalo usual de N minutos.

O grupo Restore. Sob o cabeçalho Restore há uma linha: uma caixa de seleção Confirmar para ativar jobs potencialmente destrutivos com a chave restore.enabled. É o flag de seção de todos os três tipos de job de restore, então o editor pergunta apenas uma vez. Cada job de restore mantém seu próprio interruptor Enabled. O grupo SQL update faz a mesma pergunta em sua linha aberta.

Uma linha aberta mostra seus jobs, uma linha por job:

  • a caixa de seleção que ativa ou desativa o job;
  • o id do job, Configurar ▾ (ou Ocultar configurações ▴ enquanto o formulário está aberto), Excluir e Executar agora;
  • N obrigatórios vazios quando campos obrigatórios estão vazios. Clique em Configurar ▾: os campos vazios têm uma moldura vermelha. Ao salvar, o editor desativa esse job;
  • o agendamento do job, com DEFAULT quando o job não tem agendamento próprio, e a próxima execução, por exemplo próxima execução 11-07 02:00, amostrada pelo tick de restore;
  • a última execução e o resultado;
  • Detalhes ▾: o último desfecho do job (veja Logs de jobs). Ocultar detalhes ▴ fecha isso.

Uma linha sem lista de jobs (por exemplo CPU / RAM do host ou IO de disco) tem um botão <seção>.* campos da seção. Ele abre os campos dessa seção, por exemplo os interruptores do agente.

O grupo Health-check tem uma linha IO de disco (collect_disk_io): o agente mede a latência de leitura e escrita e a taxa de transferência dos discos com bancos de dados e arquivos temporários uma vez por minuto. Está ativado por padrão (fbagent 2.87.0 ou mais recente). Seus dados alimentam os gráficos de IO de disco no painel.

Agendamento usa seis campos, com segundos primeiro: second minute hour day month weekday. Por exemplo 0 */2 * * * * é a cada 2 minutos, e 0 0 */2 * * * é a cada 2 horas. O formulário do job mostra os seis campos um a um (SEC, MIN, HOUR, DOM, MON, DOW), e diz em qual fuso horário o agente os lê.

Tarefas de tick do agendador. A tabela na parte inferior da aba lista as linhas de scheduler.tasks. O editor cria e remove essas linhas junto com seus jobs.

Coluna O que mostra
Tarefa O nome da tarefa. Distintivos: retired, unknown, alias, guard, no jobs.
Executa para O tipo de job que a tarefa executa.
Agendamento O cron de tick da tarefa.
Timeout, s O limite de tempo de uma execução, em segundos. 0 significa sem limite.
Ativada Se a tarefa está ativada.
Última execução Quando a tarefa foi executada pela última vez.

Mensagens que você pode ver

Mensagem O que significa
No jobs yet — Add job creates the first one. A linha aberta não tem jobs.
No recorded run for this job yet. O agente não tem nenhuma execução deste job.
No scheduler.tasks rows in this config — adding a job creates the one it needs. A tabela do agendador está vazia.
Warning: an enabled … job re-runs on every tick — prefer forced runs Você ativou um job de um tipo destrutivo. Prefira Executar agora.

Formulários de job

Todo formulário de job (vbackup, nbackup, nbackup dump, sweep, estatísticas de índice, ciclo de backup-restore) mostra seus campos em grupos com título, em duas colunas.

A vbackup job form with its field groups
A vbackup job form with its field groups

O que você vê

  1. A linha do job: o id do job e o banco de dados, Ocultar configurações ▴ (isso fecha o formulário), Excluir, Executar agora, o chip de agendamento, o resultado (aqui ERROR com seu motivo) e Detalhes ▾. A caixa de seleção à esquerda ativa ou desativa o job.
  2. Expandir tudo e Recolher tudo.
  3. Os grupos. Na imagem: Banco de dados e agendamento (o banco de dados, a caixa Enabled e os campos de agendamento), Arquivos de backup, gbak e Fatores de cálculo de espaço livre. Compressão e Após o backup estão mais abaixo no formulário.

Como os grupos funcionam:

  • Clique no título de um grupo para recolhê-lo ou abri-lo. Expandir tudo e Recolher tudo fazem todos os grupos. Um grupo recolhido mostra um resumo curto no título: os valores que importam, não definido, ou definido: N (N campos têm um valor).
  • Grupos raros estão em Mais configurações. O último grupo, Todos os campos — N a mais não no diálogo legado, tem os campos que nenhum outro grupo mostra.
  • Um grupo com um campo obrigatório vazio (vermelho) ou um aviso (amarelo) abre por si só, e seu título mostra quantos campos estão marcados. Um campo obrigatório vazio tem uma moldura vermelha e a palavra obrigatório.
  • Um grupo sobre um recurso tem seu interruptor no título: streaming S3, transferência de arquivos, restore de teste, desconectar antes do sweep. Desativado esmaece os campos e mantém seus valores.

Lista de bancos de dados. O campo de banco de dados oferece os bancos de dados que o agente encontrou e os que databases.conf nomeia, com seus aliases. No Firebird 2.5 os aliases vêm de aliases.conf. Assim você pode escolher um banco de dados que ninguém ainda conectou. A lista deixa de fora os arquivos de trabalho de um ciclo de backup-restore (nomes com 4replace na última extensão, por exemplo employee.fdb.orig4replace_1). Quando nada corresponde, a lista diz nenhum banco de dados corresponde, ou nenhum banco de dados visto ainda quando o agente não enviou nenhuma lista de bancos de dados.

Formulários de backup de grupo (vbackup, nbackup, nbackup dump) têm Auto-excluir backups individuais: um banco de dados que tem seu próprio job de backup (individual) é deixado de fora do job de grupo. Está ativado quando o job não tem valor. Nos formulários nbackup ele é marcado em âmbar quando está desativado. Sob as máscaras de inclusão e exclusão o formulário diz contra o que uma máscara é comparada, e o que uma lista de inclusão vazia significa para esse job.

Os formulários de grupo vbackup e nbackup têm a caixa Repetir a árvore de pastas de origem. Os backups de um banco de dados então vão para uma pasta sob a raiz de backup que repete sua pasta sob a pasta de origem, por exemplo x/y/EMPLOYEE.FDB/. Os formulários nbackup têm uma caixa para naming.noPrefix (Nomenclatura individual sem prefixo, Nomenclatura de grupo sem prefixo): os níveis são nomeados apenas pela sua data e hora, como o FBDataGuard fazia, sem bck_ e o nome do banco de dados. A importação do FBDataGuard ativa ambos.

Os formulários de grupo nbackup e dump têm estas listas:

Campo Valores
Ordem Menor banco de dados primeiro (sizeAsc), Maior banco de dados primeiro (sizeDesc), Por caminho de arquivo (path). Um valor antigo lastBackupAge aparece como lastBackupAge - funciona como sizeAsc.
Verificações de conexão auto - verificar quando o banco de dados se conecta, skip - sem verificações, require - sem backup quando uma verificação falha.

Os formulários de grupo vbackup e nbackup têm Política de órfãos: keepDays - manter pelos dias abaixo, keepForever - manter e deleteImmediately - mover de lado imediatamente. Retenção de órfãos (dias) fica esmaecido a menos que a política seja keepDays. No formulário de grupo vbackup, Verificações de conexão é um campo de texto marcado a ser implementado: o job de grupo vbackup não o lê. O formulário de grupo vbackup não oferece Ordem, Continuar em caso de erro, Pular banco de dados se bloqueado e Round robin justo, porque o job de grupo vbackup os ignora. Uma configuração que os tenha os mantém.

Nos formulários nbackup, Nível de backup que este cron dispara é uma lista: 0 - completo, 1, 2, 3, 4. As contagens de retenção ficam ao lado do agendamento de cada nível, com Adicionar um job para o nível N. Um job de grupo avançado mostra todos os cinco níveis. Nível de compressão e a extensão do arquivo comprimido aparecem somente quando o formato é Deflate.

Modo de agendamento de um job nbackup: um agendamento simples, um cron avançado por nível, ou Plano (regras para todos os níveis). Um novo job começa no modo de plano. Veja modo de plano do nbackup.

Cada lista começa com (padrão): então o job não tem valor e o agente usa seu padrão.

Compressão. Um job de backup tem a lista Comprimir backups (ou Comprimir backup) com estes valores, nesta ordem: Sem compressão, Zip, gz, zstd, Deflate. Um job sem formato usa Deflate. Zip, gz e zstd precisam do fbagent 2.75.0 ou mais recente; um agente mais antigo ignora a escolha e usa Deflate. zstd é mais rápido e menor que Deflate. Para abrir um arquivo zstd, use zstd -d ou 7-Zip 24 ou mais recente.

Nível de compressão funciona apenas para Deflate. Para os outros formatos ele fica esmaecido. Seus valores: Padrão (1, mais rápido), 1 - mais rápido, 2 a 5, 6 - como antes da 2.6, 7, 8, 9 - menor arquivo. Um 0 armazenado aparece como Padrão. Um nível armazenado acima de 9 aparece com (legado) até você escolher outro.

Nome do backup. Quando o nome do backup está vazio, o campo mostra o nome padrão como dica, e o job recebe o padrão do agente em que é executado.

Restore de teste. Um job de backup com Verificar restore de teste mostra sob o campo onde o banco de dados de teste será criado. Um nome de arquivo simples, por exemplo test.fdb, vai para a pasta de backup. O Último desfecho do job então tem uma linha Restore de teste: o resultado (ok, falhou, ignorado, não executado), o comando de restore gbak com Copiar, o código de saída, a duração, o erro, e os arquivos de origem e destino (fbagent 2.85.0 ou mais recente). Login diz qual login o restore de teste usou: owner (o proprietário do banco de dados em Acesso ao banco de dados),

banco de dados de segurança … ou login do job.

Um novo job vbackup (individual ou de grupo) criado com + Add job recebe -rep nas suas opções de restore. Então o gbak sobrescreve o banco de dados de teste que a execução anterior deixou. Jobs existentes mantêm suas opções.

Faixas Commands e Test restore. A faixa Commands de um job mostra os dois comandos mais recentes que o agente iniciou. Show more mostra até 50. A faixa Test restore mostra os dois test restores mais recentes, cada um com seu comando de backup e de restore. Will be created mostra a pasta real de test restore do agente.

Opções que o agente recusa. O agente recusa um job vbackup com a opção -Y do gbak, e um job com -SE e um stream para S3. Ele também recusa as opções de login -user, -password, -fetch_password e -trusted: o agente define o login por conta própria (defina o owner em Database access). Um agente com config schema 34 também recusa -ST: ele adiciona -ST TDRW a cada execução do gbak por conta própria e lê os tempos de backup e restore a partir disso. O formulário marca tal opção. Para um agente 2.99.0 ou mais novo:

  • Um novo job vbackup ou nbackup com tal configuração é salvo com Enabled desligado. A mensagem após o salvamento nomeia o job e o motivo. Um agente mais antigo recusava o arquivo inteiro.
  • Um job que está habilitado no arquivo ativo não é desligado: o salvamento é bloqueado. Corrija a configuração primeiro.
  • A aba Problems mostra tal job em âmbar, e Run now fica desligado para ele, com o motivo no tooltip.

Um id de job vazio ou repetido também bloqueia Save.

Criptografia de backup. Os formulários individual e de grupo do vbackup têm Encrypt (AES-256) com uma lista de chaves. Funciona apenas com o formato Zip. Você cria as chaves na aba Settings (veja Settings tab). Um agente mais antigo que 2.94.2 não tem backup_encryption: o switch fica desligado, e seu tooltip explica o motivo.

Arquivos de serviço. Sob o id do job, um job de backup mostra Service files: <folder>: onde o agente mantém o status, os relatórios, os logs e o journal do job (fbagent 2.88.0 ou mais novo). O id de um job salvo é somente leitura, porque a pasta recebe o nome dele: um novo id seria um novo job sem histórico.

Jobs excluídos. Quando você exclui um job e adiciona um novo no mesmo lugar, o novo job não mostra o último resultado nem os comandos do job excluído. O editor também nunca dá a um novo job o id de um job excluído cujo histórico o agente ainda mantém (30 dias).

Formulário de ciclo backup-restore

Um ciclo backup-restore faz um backup de um banco de dados, o restaura ao lado do banco de dados e então substitui o banco de dados ativo pela cópia restaurada. Ele funciona na pasta do banco de dados e sempre desliga o banco de dados com full antes da troca.

A new backup-restore cycle job, just added with + Add job
A new backup-restore cycle job, just added with + Add job

A imagem mostra um novo job logo após + Add job. Nada foi salvo ainda: o cabeçalho mostra o chip UNSAVED CHANGES · 2.

O que você vê

  1. A linha do job: o id do job (aqui restore-replace_cycle-1), Hide settings ▴, Delete, Run now, 2 required empty, e o chip de agendamento 0 0 2 * * 6 com a próxima execução (“next run 11-21 02:00, sampled by the restore tick”).
  2. A caixa Schedule (cron) com os seis campos cron e a nota do fuso horário.
  3. A nota do tick. Ela mostra quando o tick da tarefa não é a cada minuto. Aqui o tick de restore roda 0 */5 * * * *, então o cron do job só pode disparar quando o tick roda. Set tick to every minute altera o tick da tarefa restore para 0 */1 * * * * no editor. Salve a alteração para enviá-la ao agente.
  4. Expand all e Collapse all.
  5. Os campos superiores: Database to rebuild (obrigatório), Enabled (runs on its schedule; empty = Saturday 02:00) e Allow replace — refuses when the target exists unless set, com uma nota sobre o agendamento.
  6. Os grupos Working folders, Execute before backup, Backup and restore legs e Execute after restore. Um grupo com campos obrigatórios vazios tem uma moldura vermelha e uma contagem vermelha ao lado do título.

Os grupos:

Grupo Campos
Working folders Backup folder: onde o arquivo de backup vai. Obrigatório a menos que o modo de backup seja pipe. Originals kept beside the database (each about the database’s size): uma lista de 1 a 10. (default) é o padrão do agente, 1.
Execute before backup Um comando que roda antes do backup, seus parâmetros (um por linha), um timeout e se o ciclo continua quando ele falha.
Backup and restore legs Backup mode — pipe restores without an intermediate file: (default), arquivo ou pipe. Additional backup options e Additional restore options: as opções do gbak em uma linha, como na linha de comando, por exemplo -p 16384 -bu 2048. Job timeout (seconds).
Execute after restore Um comando que roda após o restore.
Shutdown (em More settings) Shutdown grace (gfix -force seconds, default 120).
Disk space preflight (em More settings) Minimum free space (bytes) e Require free space as a factor of DB size.
Shared with the other restore kinds (em More settings) Campos dos jobs de restore que um ciclo não precisa: Source path (a cycle backs the target up itself), o id do job de origem e Restore mode (the cycle always swaps).
Identity (em More settings) Kind (must match its array): somente leitura. O id do job.

Os campos Additional backup options e Additional restore options são uma linha de texto para um agente com configuration schema 30 ou mais novo. Para um agente mais antigo, o editor os armazena como uma lista, porque esse agente lê apenas uma lista.

Agendamento de um ciclo. Um job de ciclo roda no seu próprio agendamento, não a cada tick da tarefa restore:

  • + Add job grava 0 0 2 * * 6 (sábado 02:00) no novo job, e o job começa desabilitado.
  • Um agendamento vazio também significa sábado 02:00 para fbagent 2.86.0 ou mais novo. A linha do job então mostra DEFAULT com esse cron.
  • Um agente mais antigo que 2.86.0 roda um ciclo com agendamento vazio a cada tick de restore (a cada 5 minutos), e cada execução substitui o banco de dados ativo. Para tal agente, sempre escreva um agendamento no job.
  • A forma mais segura é manter o job desabilitado e iniciá-lo com Run now. Uma execução forçada funciona também quando o job ou sua seção está desligado.

Modo plano do nbackup

No modo plano, um job nbackup contém as regras de todos os seus níveis. Os formulários de backup incremental individual e de grupo o têm. Um job de plano precisa do fbagent 2.98.0 ou mais novo: o editor não o salva para um agente mais antigo.

A new nbackup job in plan mode: presets and rules
A new nbackup job in plan mode: presets and rules

O que você vê

  1. Uma nota: os horários de início estão em agent.timezone, com seu offset como número, por exemplo “Europe/Moscow — UTC+03:00”, e o horário no seu navegador.
  2. Start from a preset: Weekly full, Monthly full, Full every 2 weeks, Small database. Um preset preenche as regras.
  3. Uma caixa por regra:
    • Level: Level 0 (full), Level 1 a Level 4.
    • When: every day, days of the week, Nth weekday of the month ou days of the month, com os dias e How often (a cada semana até a cada 4 semanas).
    • At: o horário de início no formato de 24 horas (HH:MM), em todos os navegadores. + adiciona um segundo horário. Repeat fornece from, to e every N min em vez disso.
    • Skip if not started within N min: a janela de início. Uma execução que não pode começar nela é ignorada.
    • × remove a regra.
    • A linha sob a caixa diz a regra em palavras, por exemplo “Level 1: every Monday … at 23:00. If it cannot start by 00:00, it is skipped.”
  4. Add level N e Add another time rule.
  5. Options: Run a full backup when the last one is older than N days (vazio ou 0 é desligado) e If an increment grows to N % of the full backup, run the lower level instead (10 a 100; vazio é desligado).

Retention pode manter ciclos inteiros: um backup de nível 0 com seus incrementos.

Preview. Sob as opções, o preview mostra quando o plano roda.

The plan preview: calendar, one day and the next runs
The plan preview: calendar, one day and the next runs
  • Assume a full backup takes … and each increment …: quanto tempo as execuções duram. O preview assume que nenhum outro job de backup bloqueia este.
  • Show 4 a 12 semanas, com Earlier e Later. O calendário mostra 6 semanas por padrão. Cada dia mostra suas execuções, por exemplo L1 ou L2 x13. new cycle marca o dia de um backup de nível 0.
  • Clique em um dia para ver suas execuções em uma linha de 24 horas e em uma lista, com o motivo de cada execução, por exemplo “runs on time” ou “skipped - level 0 was running”.
  • Next runs: as próximas execuções com seu nível e motivo.
  • Na parte de retention, quando você mantém um número de ciclos, uma linha mostra Expected disk use (é desconhecido até os primeiros backups rodarem). A caixa Now on disk mostra os backups que estão no disco agora.

Contas somente leitura também podem usar o preview do calendário.

Switches do agente

Alguns switches decidem o que o agente mede. Eles estão nos campos de seção da sua linha na aba Jobs: abra a linha e clique no botão da seção. Todos os três estão ligados por padrão.

Switch Linha e chave O que faz
CPU and memory by program Host CPU / RAM, system_metrics.programs Adiciona a CPU e a memória do Firebird, do agente e dos outros programas mais ocupados a cada registro de CPU e memória do host. Apenas nomes saem do host, sem linhas de comando ou usuários.
Memory by service Host CPU / RAM, system_metrics.memory_by_service Adiciona quem detém a RAM: no Linux os serviços (memória do cgroup v2), no Windows os programas, e o cache, kernel, swap e commit do host. No Linux também informa quanto de cada arquivo de banco de dados anexado o cache do SO mantém.
Disk IO by service Disk IO, disk_io.by_service Divide os bytes de cada disco medido por serviço: Firebird, o agente e os outros mais ocupados. O Linux precisa de IO accounting ligado (cgroup v2 io.stat). O Windows usa uma sessão ETW.

O botão da seção aparece apenas quando a configuração tem essa seção. Esses switches alimentam os cards CPU usage details, Who uses memory e Who uses the disk no dashboard.

Aba Settings

The configuration editor: Settings tab
The configuration editor: Settings tab

O que você vê

  1. A lista à esquerda com todas as seções da configuração: Firebird, Security.fdb/Users, FBAgent, Local API, Logging, Log rotation, Resource guard, Task telemetry, Config snapshot, Storage & retention, File transfer, Backup encryption keys, Control Center, Trace pipeline, Server status, HQbird import, Prometheus export, License, Run now, Client versions e Managed products.
  2. Abaixo da lista: catalog · schema, a versão de configuração que o editor conhece (por exemplo catalog v1 · schema 34).
  3. À direita: os campos da seção selecionada, sob seu título e chave (por exemplo Firebird firebird.*).

Como os campos funcionam:

  • Cada campo mostra seu nome e, quando necessário, uma dica abaixo dele.
  • Aponte para um nome para ver sua dica. O ponteiro do mouse muda para o ponteiro de ajuda (uma seta com um ponto de interrogação) onde há uma dica. A dica começa com o que o campo faz. Depois vêm uma observação, o valor padrão e, por último, a chave no arquivo, por exemplo firebird.install_path.
  • Um campo com um conjunto fixo de valores é uma lista. A primeira entrada é (default), seguida do valor padrão quando o editor o conhece. Um valor armazenado que não está na lista permanece como está.
  • Uma linha com { … } é um grupo de campos. Uma linha com [n] … é uma lista com n entradas. Clique na linha para abri-la.
  • Campos cinza são somente leitura. O agente os preenche, por exemplo Version.
  • Campos marcados como base64 contêm uma senha em formato base64, da forma como o agente a lê. Digite a senha em texto simples; o editor a converte (veja Passwords).
  • Em File transfer, cada destino mostra apenas os campos que possui. A lista Add field… sob um destino oferece os campos que ele ainda não possui, por exemplo checksum_mode, sse e sse_kms_key_id. Um campo que você escolhe começa com seu valor padrão, ou vazio quando não tem padrão.

Backup encryption keys contém as chaves para arquivos de backup criptografados (veja Backup encryption em Job forms).

  • Você pode gerar uma nova chave ali. Sua senha aparece uma única vez: copie-a e guarde-a em um local seguro. Sem ela, os backups não podem ser abertos.
  • escrow_public_key: uma chave pública para uma cópia das chaves (escrow). Um snapshot com escrow oferece Download escrow.

Resource guard: o limite de CPU padrão é 30 (esquema de configuração 33).

Managed products também mostra com que frequência um agente saudável verifica uma nova versão do fbagent, HQ Monitor, fbmcp e Firebird, e com que frequência ele verifica um nó preparado ou RCM que ainda não está instalado.

A seção Server status tem os limites das descobertas de status do servidor. Dois deles são para Firebird memory pressure: server_status.thresholds.firebird_memory_pressure_pct.warning (10) e .serious (25). O valor é a parcela de tempo que o Firebird esperou por memória nos últimos 10 minutos, em porcentagem (PSI do Linux do serviço Firebird). No valor ou acima dele, o status é warning ou serious. Sem PSI, o agente não o avalia.

HQbird import tem mais dois campos para a importação do FBDataGuard: Register databases adiciona os bancos de dados registrados no FBDataGuard a databases.conf, e Clean old monitoring logs remove os logs de monitoramento antigos do FBDataGuard. Ambos estão ativados por padrão. Um agente mais antigo que o fbagent 3.4.0 os ignora.

Security.fdb/Users

Os bancos de dados de segurança do servidor e seus usuários têm sua própria entrada na lista à esquerda: Security.fdb/Users. A seção Firebird tem um link para ela: “Security databases and their users are edited on their own page: Security.fdb/Users”. No modo de demonstração, a palavra “Security” também é mascarada, então as imagens mostram uma palavra inventada em seu lugar.

Settings: Security.fdb/Users with a security database and its users
Settings: Security.fdb/Users with a security database and its users

O que você vê

  1. À esquerda, ao lado da lista de seções: a lista de bancos de dados de segurança. Cada entrada mostra seu id, seu tipo (default, private ou self), o arquivo e o número de usuários, por exemplo users: 3. Tags marcam um problema: no login, refresh failed ou stale.
  2. À direita: os campos da entrada escolhida: o plugin de autenticação, Credentials { … }, o ID, kind, path e o banco de dados de sondagem.
  3. A lista de usuários com Filter by name, Refresh from server, Create user e a linha de contagem, por exemplo 3 of 3 users · refreshed ….
  4. Abaixo da lista: o horário e o erro da última atualização.

A entrada default é o próprio banco de dados de segurança do servidor. Suas Credentials são o login que o agente usa para o servidor. Quando estão vazias, o agente usa os padrões do Firebird (SYSDBA e masterkey). Um banco de dados de segurança privado, ou um banco de dados que verifica seus próprios logins, recebe uma entrada própria.

  • ID, kind e path são preenchidos pelo agente a partir de databases.conf.
  • Users lista os usuários desse banco de dados de segurança, 50 por página. Filter by name encontra um usuário. A linha acima da lista diz quantos usuários são mostrados e quando a lista foi lida, por exemplo 3 of 3 users · refreshed …. Os campos users refreshed at e users refresh error mostram o horário e o erro da última atualização. Um usuário pode ter as marcas admin, inactive, missing on the server e password stored.
  • Refresh from server lê a lista novamente. No modo local, o agente a lê imediatamente, e a página mostra a nova lista. No modo remoto, o botão envia uma solicitação Run now do job do agente refresh_security_users, e a nova lista chega com o próximo snapshot de configuração do agente. Isso requer fbagent 2.79.0 ou mais recente e a permissão May run jobs on agents. Em um agente mais antigo, o botão fica cinza, e sua dica explica o motivo.
  • Create user cria um usuário neste banco de dados de segurança com CREATE USER. O agente executa a instrução com o login desta entrada. O formulário Create user in … tem User name, Password e Repeat the password, User manager plugin (de UserManager em firebird.conf; o primeiro é o padrão do servidor), First name, Middle name, Last name, Active (the user can log in) e Grant the admin role (GRANT ADMIN ROLE). A função de admin pede uma segunda confirmação. O formulário mostra a instrução que o agente executará. Create a executa, Cancel fecha o formulário. O agente salva a nova senha em sua configuração, para que possa fazer login como este usuário depois.
  • Create user funciona apenas quando o HQ Monitor é executado ao lado do agente (modo local), com um agente mais recente que o fbagent 2.99.0. Para um agente remoto, o botão fica cinza: “Create user needs local access to the agent. It is not available for a remote agent.” Também fica desativado enquanto a página tem edições não salvas, ou quando a entrada ainda não tem login. Aponte para ele para ver o motivo.

Mensagens que você pode ver

Mensagem O que significa
No users yet: enter the credentials of this security database and refresh from the server. A lista está vazia. Defina as credenciais e clique em Refresh from server.
No user matches the filter. Nenhum nome de usuário contém o texto do filtro.
Refreshing reloads the configuration from the agent and discards the unsaved edits on this page. Continue? Você tem alterações não salvas. Salve-as primeiro, ou elas serão perdidas.
User list refreshed from the server. Modo local: a nova lista está na página.
Refresh requested on the remote agent; the list updates when the agent sends its next configuration snapshot. Modo remoto: aguarde o próximo snapshot.
Users refresh failed: … O agente não conseguiu ler os usuários. O texto informa o motivo.
Refresh from server is not available for this remote agent: … A atualização remota não funciona para este agente, por exemplo porque ele é muito antigo.
User … created. Create user funcionou. A lista mostra o novo usuário.
User … already exists in this security database. Escolha outro nome.
The login of this entry may not create users. As Credentials da entrada não têm permissão para criar usuários.
Creating users needs Firebird 3.0 or later. O Firebird 2.5 não tem CREATE USER aqui.
Create user failed: … O agente não conseguiu criar o usuário. O texto informa o motivo.

Problems tab

The configuration editor: Problems tab
The configuration editor: Problems tab

O editor verifica a configuração e lista o que parece errado.

O que você vê

  1. Um cartão por problema: o nível (RED, AMBER ou INFO), um título e uma explicação.
  2. Um botão que corrige o problema, por exemplo Enable both, Disable both, Remove pattern ou Set tick to ….

O número na aba Problems conta problemas vermelhos e âmbar; info não é contado. A correção altera apenas o editor. Salve a alteração como de costume.

Alguns problemas que exigem cuidado:

Problema O que significa
Backup jobs share one folder and name: … Dois jobs de backup habilitados gravam backups com o mesmo nome na mesma pasta, então seus arquivos não podem ser distinguidos. Quando os dois jobs fazem backup do mesmo banco de dados, a retenção de cada job exclui os backups do outro job. Os cartões do job marcam os campos de pasta e nome. Dê a cada job sua própria pasta ou nome.
nbackup level without level 0: … Um job nbackup de nível 1 ou superior precisa de um job de nível 0 ou simples do mesmo banco de dados e pasta. O agente não executa este job até que haja um.
… section flag and task disagree Um interruptor do job está ligado e o outro está desligado. Enable both ou Disable both corrige isso.
Restore config job “…” runs on every tick Um job de restauração sem seu próprio agendamento é executado a cada tick de sua tarefa. Dê a ele um agendamento, ou mantenha-o desabilitado e use Run now.
Ignore pattern looks too broad: “…” Um padrão em server_status.firebird_log.ignore_patterns é tão curto (por exemplo, apenas dígitos) que também corresponde a outras linhas de firebird.log. Remove pattern o remove.
… is incomplete Campos obrigatórios estão vazios. Ao salvar, o editor desativa o job.

Quando a configuração não tem problemas, a aba diz No problems detected in this configuration.

Saving: local mode (console beside the agent)

O console abre o agent_config.json ativo do agente.

  • Save grava a alteração em um arquivo que o agente lê em sua próxima verificação.
  • Save and apply now salva e informa ao agente em execução para recarregar agora. O botão aparece apenas quando o agente responde; então ele é o botão principal (azul) na extremidade direita. A mensagem Applied live permanece na página após o salvamento.

Saving: remote mode (collection center)

O console abre o snapshot de configuração mais recente que o agente enviou.

  • Save as draft mantém a alteração no console. Nada é enviado ao agente. O botão fica cinza enquanto não houver nada para salvar.
  • Open lista a configuração do agente e seus rascunhos com seu estado: not sent, sent, applied ou superseded. Uma linha acima do editor informa o estado do rascunho aberto.
  • Save and Send to agent envia a alteração ao agente através do goafts. O botão aparece apenas quando o administrador ativou a entrega e sua conta tem a permissão May push configuration to agents. O agente aplica a alteração em cerca de um minuto.

Rascunhos com mais de 30 dias são excluídos quando não se baseiam mais no snapshot atual.

Delivery status

Depois que você envia uma alteração, seu status aparece no editor e na coluna Server/Agent version/Remote control na página Servers.

Delivery status
Status Significado
SENT A alteração está armazenada no goafts.
TAKEN O agente baixou a alteração.
APPLIED O agente aplicou a alteração.
ALREADY SET O agente já tinha esses valores.
RESTART NEEDED Aplicada, mas algumas seções só funcionam após reiniciar o agente. A dica lista quais.
REJECTED O agente recusou a alteração. A dica mostra o motivo informado pelo agente.
SUPERSEDED Uma alteração mais nova substituiu esta.
DRIFT nn′ Sem resposta do agente por nn minutos (10 por padrão). Verifique se o agente está em execução.
NOT READ O console não conseguiu ler o status.
HQCenter link is not set A entrega está desativada neste console.

Senhas

Digite uma senha em texto simples. Como o editor a armazena depende do modo:

  • Modo local: o editor grava a senha codificada em base64 no agent_config.json, porque o agente a lê nesse formato.
  • Modo remoto: o snapshot mostra as senhas armazenadas ocultas. Uma senha que você digita vai para o agente junto com a alteração, e o agente a armazena em seu próprio formato protegido.

Quando você digita uma senha por http simples, o editor mostra um aviso de que a conexão não é criptografada. O administrador pode proibir isso; nesse caso, os campos de senha funcionam apenas por https.

Toda gravação, envio, alteração de senha e execução de job é registrada no log de auditoria com o seu nome de login.

Executar agora

Cada linha de job na aba Jobs tem um botão Executar agora. Ele inicia esse job uma vez, assim que o agente puder. O agendamento não muda. Backups, restaurações, sweeps, recálculo de índices e verificações com gfix têm o botão.

  1. Clique em Executar agora na linha do job.
  2. Marque a caixa Banco de dados no topo da caixa de diálogo. Ela mostra o que será executado: o caminho do banco de dados de um job individual, o destino e o backup de uma restauração, ou, para um job de grupo, sua pasta e Bancos de dados marcados: N de M.
  3. Verifique os avisos. Se o job, sua seção ou sua tarefa de agendador estiver desligado, o job ainda será executado uma vez e permanecerá desligado depois.
  4. Defina as opções se o job tiver alguma: um sweep pode respeitar sua janela de execução, e um backup incremental tem um nível. Um job de grupo lista seus bancos de dados com caixas de seleção, todas marcadas inicialmente, com Marcar todos e Desmarcar todos. Sem nenhum banco de dados marcado, o botão de iniciar fica desativado. Adicione um motivo se quiser.
  5. Clique em Executar agora. Fechar fecha a caixa de diálogo e não inicia nada.
The Run now dialog of a vbackup job
A caixa de diálogo Executar agora de um job vbackup

Logo após você salvar um novo job, Executar agora aguarda até que o agente tenha recebido a nova configuração e então inicia o job.

A linha do job então mostra o estado da execução:

Run now
  • waiting mostra o motivo, por exemplo que o banco de dados está bloqueado por outro job, que o job aguarda sua janela de execução ou que não há espaço livre em disco suficiente.
  • Clique em Cancelar execução enquanto a execução estiver na fila ou aguardando. Uma execução que já começou não pode ser cancelada.
  • Um job que substitui um banco de dados em uso (uma restauração em modo de substituição, ou um ciclo de backup-restauração) pede que você digite o nome do arquivo do banco de dados antes que o botão funcione. Quando o job não nomeia nenhum banco de dados, digite o id do job.

No modo local, o console inicia o job por meio do agente na mesma máquina. No modo remoto, a solicitação passa pelo goafts, e o agente a recebe na sua próxima sincronização, em cerca de um minuto. O botão fica esmaecido quando não pode funcionar, e a dica explica o motivo:

  • Sua conta não tem o direito May run jobs on agents. Um job que substitui um banco de dados também precisa de May run jobs that replace a database.
  • O modo remoto precisa das configurações de entrega e de users_mode=multiple.
  • O agente desativou os comandos remotos. Esta é uma configuração no host do agente (goafts.remote_commands.enabled; allow_destructive para jobs que substituem um banco de dados). Ela não pode ser alterada pelo console.
  • O agente é muito antigo. Ele precisa do fbagent 2.61.0 ou mais recente.

Logs de jobs

Jobs de backup e restauração mantêm o log do gbak de cada execução. Quando uma execução falha, a linha do job mostra as últimas linhas do log da etapa que falhou. Detalhes na linha do job lista os logs da última execução, um por etapa, com Baixar log. Em um centro de coleta, um log chega junto com os dados do agente, normalmente em até 5 minutos após a execução.

Backups

Backups mostra o inventário de backups do servidor: todo arquivo de backup que o agente conhece, e as restaurações de teste e os jobs de restauração.

The Backups page
A página Backups

O que você vê

  1. O cabeçalho do console com Backups marcado, e a trilha de navegação Servers › SRV › Backups.
  2. A linha de cabeçalho: backups atualizados …, restaurações atualizadas … (somente quando o agente enviou dados de restauração) e a versão do agente. Em uma tela estreita, a linha quebra.
  3. A linha de nota (no modo remoto). Na imagem ela também informa que o arquivo da tabela Restaurações não chegou junto com os logs.
  4. A tabela Backups com os filtros Família:, Banco de dados: e Status:, e a contagem de linhas, por exemplo 2 de 2.
  5. A tabela Restaurações com os filtros Tipo: e Resultado:, e sua contagem, por exemplo 15 de 15. Uma tabela vazia mostra apenas uma mensagem, como na imagem.

Clique em um cabeçalho de coluna para ordenar. Um segundo clique inverte a direção. A tabela Backups começa ordenada por Criado, a tabela Restaurações por Concluído, mais recentes primeiro.

Tabela Backups

Coluna O que mostra
Status OK, MISSING, ORPHANED ou UNATTRIBUTED (veja abaixo).
Família O tipo de job de backup, por exemplo vbackup, e individual ou grupo. — para um arquivo que nenhum job registrou. ⚠ nbackup copyType marca um job de dump que gerou um arquivo nbackup.
Banco de dados O banco de dados do backup, por exemplo /data/employee.fdb. — quando o arquivo não pertence a nenhum banco de dados deste servidor.
Arquivo O nome do arquivo, com Copiar (copia o caminho completo) e Mais (mostra o Caminho completo). « Menos fecha. Aponte para o nome para ver o caminho completo.
Tipo O tipo do arquivo: fbk, nbk, nbackupcopy e outros.
Tamanho O tamanho do arquivo.
Criado Quando o backup foi feito, e há quanto tempo.
Verificado ✔ PASS ou ✖ FAIL e o horário da última restauração de teste do arquivo. A linha abaixo mostra o tamanho do banco de dados que essa restauração gerou e quanto tempo o gbak levou, por exemplo 48.0 MB · 35 s. — NEVER quando nenhuma restauração de teste verificou o arquivo.
Status Significado
OK Um job de backup registrou o arquivo, e ele está no disco ou no armazenamento remoto.
MISSING Um job de backup registrou o arquivo, mas ele não está no disco.
ORPHANED A varredura encontrou o arquivo para um banco de dados deste servidor, mas nenhum job de backup o registrou.
UNATTRIBUTED A varredura encontrou um arquivo que não pertence a nenhum banco de dados deste servidor, por exemplo um arquivo de outro servidor em uma pasta compartilhada.

⚠ nbackup copyType: um job de dump com tipo de cópia nbackup redefine a base incremental de todo job nbackup real do mesmo banco de dados. Use lock_nbackup ou lock_sql.

Tabela Restaurações

Coluna O que mostra
Resultado OK, FAILED ou SKIPPED.
Tipo test (uma restauração de teste) ou replace (uma restauração que substitui um banco de dados).
Família O tipo de job que fez a restauração, por exemplo vbackup.
Job O id do job.
Origem O arquivo de backup, com Copiar e Mais. Mais mostra o comando com Copiar, o código de saída, a duração (Levou), o banco de dados, o destino, o motivo da omissão e os arquivos Log de saída e Log de erros.
Destino O arquivo que a restauração criou.
Tamanho do BD O tamanho do banco de dados que a restauração gerou. — para uma restauração com falha ou omitida, e para um agente mais antigo que não envia o tamanho.
Duração Quanto tempo o gbak levou, a partir das estatísticas -ST TDRW em seu log. ≈ marca um tempo do relógio do agente, do início ao fim da execução, quando o log não tem estatísticas.
Gatilho on schedule ou forced run.
Concluído Quando a restauração terminou, e há quanto tempo.
Erro O erro ou o motivo da omissão, por exemplo the restore target is a live database ou not enough free space at the restore path.

A página mostra as primeiras 500 linhas de uma tabela. Mostrar todas as N linhas mostra o restante. Os eventos de restauração são mantidos por 14 dias.

Mensagens que você pode ver

Mensagem O que significa
No backups recorded yet. The inventory fills in as backups run, and fully on the next backup-status reconcile (every 2 hours). O agente ainda não tem nenhum backup em seu inventário.
No restore events recorded yet. Test restores (vbackup verify) and restore jobs appear here as they run; events are kept for 14 days. Nenhuma restauração foi executada nos últimos 14 dias.
This inventory is capped and older entries have been dropped, so what is listed is not everything the agent knows about. A lista tem um limite de tamanho, e as linhas mais antigas foram descartadas.
Not available in this log tree — see the note above. Os dados do agente para esta tabela não chegaram ao console. A linha de nota explica o motivo.
Could not load … A página não conseguiu ler os dados. Recarregue a página.

Dicas:

  • Filtre Status: por orphaned para encontrar arquivos de backup que nenhum job de backup registrou, por exemplo arquivos que alguém copiou manualmente.
  • Um FAIL em Verificado significa que uma restauração de teste deste arquivo falhou. Abra Mais na tabela Restaurações para ver o comando e os arquivos de log.

Atividade

A aba Atividade mostra como as tarefas do agendador do agente foram executadas.

The Activity page
A página Atividade

O que você vê

  1. O cabeçalho do console com Jobs marcado, e a trilha de navegação Servers › SRV › Jobs › Activity.
  2. A pasta de dados do agente, e a linha de nota (no modo remoto).
  3. As abas Jobs, Configurações, Problemas e Atividade.
  4. Tarefas do agendador: uma nota sobre a janela de tempo, depois o número de tarefas, por exemplo 28 tarefas.
  5. A tabela das tarefas.

Os contadores abrangem a janela de telemetria do agente, não o dia civil. A janela continua após a meia-noite e recomeça quando o agente é reiniciado.

Coluna O que mostra
Tarefa A tarefa do agendador. + abre a lista de suas execuções.
Última invocação Quando a tarefa foi executada pela última vez, no horário do agente, e há quanto tempo.
Invocações Quantas vezes ela foi executada na janela.
p95 wall 95% das execuções levaram esse tempo ou menos.
CPU O tempo de CPU de todas as execuções, com seus processos filhos.
Max RSS Δ O maior crescimento de memória durante uma execução.
Sobreposição Quantas outras tarefas foram executadas ao mesmo tempo, em média.
Falhas Quantas execuções da tarefa falharam. Aponte para o número para ver o último erro. — significa nenhuma.

Clique em um cabeçalho de coluna para ordenar. A tabela começa ordenada por Última invocação, mais recentes primeiro.

+ abre até as 100 execuções mais recentes de uma tarefa:

Coluna O que mostra
Iniciado (horário do agente) Quando a execução começou.
Wall Quanto tempo a execução levou.
CPU (+filho) O tempo de CPU da execução e de seus processos filhos.

| RSS Δ | O crescimento de memória durante a execução. | | Sobreposição | Quantas outras tarefas foram executadas ao mesmo tempo. | | Detalhe | execução manual para uma execução iniciada manualmente, o erro de uma execução com falha ou outros fatos. Uma execução com falha aparece em vermelho. |

Com falha conta as execuções com falha da tarefa do agendador, não os resultados dos jobs. A tarefa de uma lista de jobs termina sem erro mesmo quando todos os jobs abaixo dela falharam. Os resultados dos jobs estão na aba Jobs.

Mensagens que você pode ver

Mensagem O que significa
Nenhuma árvore de dados do agente foi encontrada ao lado desta configuração, portanto não há atividade para ler. O console não tem dados do agente para este servidor.
Esta árvore de logs não contém telemetria de tarefas. O agente a grava a partir da versão 2.0.15; um agente mais antigo, ou a rotação de logs, não deixa nada aqui. O agente não enviou telemetria.
Os registros mais recentes são mais antigos do que a própria cadência deste agente produziria. Em um console, isso geralmente significa que o pacote de logs ainda não chegou, e não que o agendador parou. Os dados estão antigos. Aguarde o próximo pacote de logs.
Os arquivos de telemetria estão presentes, mas não puderam ser lidos. Os arquivos estão danificados ou em um formato desconhecido.
Nenhuma invocação registrada para esta tarefa na janela que foi lida. A tarefa não foi executada na janela.
Lendo as invocações desta tarefa… A lista de execuções está carregando.
Mostrando as N invocações mais recentes; as mais antigas nesta janela não foram lidas. Apenas as execuções mais recentes estão listadas.
N linha(s) ilegível(is) foram ignoradas. Algumas linhas da telemetria não puderam ser lidas.
Não foi possível ler … A página não conseguiu ler os dados. Recarregue a página.

Uma tarefa com um valor alto de p95, CPU ou memória é a primeira a verificar quando o agente usa demais o servidor.


10. Licenças

O botão Licenças na página Servidores abre a página de Licenças (/license). Todo usuário autenticado pode lê-la, para os servidores que esse usuário pode ver. O console apenas mostra licenças e entrega um arquivo de licença. Ele nunca bloqueia nada: o agente verifica a licença, e o goafts a armazena e a distribui.

A lista de servidores

The License page
The License page

O que você vê

  1. O cabeçalho com ← Servidores e a linha de navegação Servers › Licenses.
  2. O banner de licença, apenas quando um servidor precisa de atenção (veja O banner de licença).
  3. Uma linha de erro. Ela fica vazia quando a página carrega sem problemas.
  4. O título Licenças do HQbird com o número de servidores, o campo de busca Buscar servidores… e o botão Atualizar.
  5. A tabela: uma linha para cada servidor que você pode ver, ordenada por nome.
  6. Abaixo da tabela: o servidor em que você clicou (veja Um servidor).
Coluna O que mostra
Servidor O nome do servidor (agente).
Estado Um selo: LICENSED (verde), GRACE ou UNLICENSED (âmbar), INVALID (vermelho), TRIAL ou NO DATA. Um sinal ⚠ após o selo significa que o último relatório tem mais de 3 dias.
Válida até A data que importa para este estado: a data de expiração de uma licença, o fim do período de carência, o fim do estágio 1 ou do trial, ou o fim mais tardio do trial. Quando faltam 60 dias ou menos, o número de dias aparece em seguida, por exemplo (12 d). Aponte para a data para ver o que ela é.
Tipo floating, bound to hosts ou none.
Cliente O cliente da licença.
Aplicar yes ou no: se o agente aplica a licença.
Em risco Quantos jobs configurados precisam de uma licença que este servidor não possui.
Reportado Quando o agente reportou o licenciamento pela última vez, no horário local do seu navegador.

Um servidor sem relatório mostra “—” nas colunas de data. Aponte para uma linha para ver um resumo curto: o motivo do estado, o cliente e o id da licença e, quando aplicável, “A aplicação está desativada: nada é bloqueado.” e “Jobs que precisam de uma licença: 19”.

Mensagens que você pode ver

Mensagem O que significa
Nenhum servidor. Nenhum servidor corresponde à busca, ou você pode não ver nenhum servidor.
⚠ “O último relatório do agente está antigo: o estado mostrado pode estar desatualizado.” O agente não reporta o licenciamento há mais de 3 dias. Verifique se o agente está em execução.

Dicas:

  • Buscar servidores… filtra a tabela pelo nome do servidor. Atualizar lê a lista e o servidor aberto novamente.
  • /license?server=SRV abre um servidor diretamente. O banner de licença e a célula Licença na página Clusters usam este link.

Um servidor

Clique em uma linha. Os detalhes desse servidor são abertos abaixo da tabela.

One server on the License page
One server on the License page

O que você vê

  1. O nome do servidor e seu selo de estado.
  2. Notas, apenas quando aplicáveis: nenhum relatório do agente, um relatório antigo ou “A aplicação está desativada: nada é bloqueado. Os jobs listados abaixo parariam quando ela fosse ativada.”
  3. A lista de campos da licença (tabela abaixo).
  4. Recursos: os recursos que a licença concede, como pequenos rótulos.
  5. Assentos: os assentos que a licença concede.
  6. Jobs que precisam de uma licença: jobs que estão configurados, mas não são permitidos pelo estado atual. Com a aplicação desativada, eles ainda são executados. A lista mostra o que pararia.
  7. Abaixo destes, para um trial: a seção Estender o trial para 30 dias (veja O trial).
  8. A seção para instalar ou enviar uma licença (veja Instalar uma licença) e a lista de Licenças no goafts quando você pode usá-la.
Campo O que mostra
Estado O selo de estado.
Motivo Por que o servidor tem este estado, em palavras (veja as mensagens abaixo).
Id da licença, Cliente A licença e o cliente para quem ela foi emitida.
Expira, Carência termina A data de expiração e o fim do período de carência.
Tipo floating, bound to hosts ou none.
Trial yes ou no. Para um trial: quando ele começou e quando termina.
Estágio do trial stage 1 (no email needed), stage 2 (email and code) ou over. Apenas durante um trial.
Estágio 1 termina, Trial termina no máximo As datas do trial, com os dias restantes. Apenas durante um trial.
Primeira licença aceita Quando o agente aceitou sua primeira licença. Apenas quando o agente o reporta.
Solicitação por e-mail O estado do e-mail do trial: not sent, being checked, code sent by email, code accepted, waiting for the trial license, trial license installed ou closed com o motivo.
Aplicação yes ou no.
Modo O modo do agente: full ou license only.
Id de instalação A identidade do host. Uma licença vinculada ao host é emitida para ele.
Última verificação online Quando o agente acessou o servidor de licenças pela última vez.
Agente O id do agente e sua versão.
Reportado em Quando o agente gravou este relatório.
Coluna O que mostra
Assento Tabela Assentos: o tipo de assento.
Licenciados Tabela Assentos: quantos assentos deste tipo a licença concede.
Job Tabela Jobs que precisam de uma licença: o id do job.
Recurso Tabela Jobs que precisam de uma licença: o recurso que o job precisa.

Mensagens que você pode ver

Mensagem O que significa
O agente deste servidor não reportou o licenciamento (um agente mais antigo ou nenhum relatório ainda). O estado é NO DATA. Atualize o agente ou aguarde o primeiro relatório.
no license installed Motivo: não há licença nem trial.
the license is bound to another host Motivo: a licença foi emitida para um id de instalação diferente.
the host identity changed: a new activation request is needed Motivo: envie uma nova solicitação de ativação ao fornecedor.
the agent has not reached the license server in time Motivo: a verificação online está atrasada. Verifique se o host consegue acessar o servidor de licenças.
stage 1 of the trial is over: enter a work email to extend the trial to 30 days Motivo: veja O trial.
the trial is over Motivo: instale uma licença adquirida.
Nenhum recurso concedido. / Nenhum assento. A licença não concede nada deste tipo, ou não há licença.
Todos os jobs configurados são permitidos. Nenhum job pararia.
Não foi possível ler o estado da licença O console não conseguiu ler o relatório deste servidor.

Outros motivos são possíveis, por exemplo “the license file was removed; there is no new trial after a license” ou “the license is signed with a trial key but is not a valid trial license”.

Instalar uma licença

A seção abaixo dos detalhes do servidor instala ou envia um arquivo de licença. Escolha o arquivo em Arquivo de licença e clique no botão. O que acontece depende de onde o agente é executado:

Agente O que o botão faz Quem pode usá-lo
Na máquina deste console (modo local). Título da seção: Instalar uma licença no agente desta máquina. Instalar envia o arquivo ao agente. O agente verifica a assinatura antes de gravar qualquer coisa. Um administrador. No modo de usuário único, este é o único usuário.
Em outro local, e o console está configurado para o goafts. Título da seção: Enviar uma licença para o goafts. Enviar armazena o arquivo no goafts. Em seguida, clique em Atribuir a SRV na lista de Licenças no goafts, ou em Definir como padrão. Um usuário com Pode enviar configuração para agentes (modo de usuários multiple). Administradores também precisam deste direito. Apenas um administrador define a licença padrão.

Se o agente ou o goafts recusar o arquivo, a página mostra a mensagem deles. Toda instalação, envio e atribuição é gravada no arquivo de auditoria, com um hash do arquivo e não o arquivo em si. Uma alteração no goafts que não puder ser gravada no arquivo de auditoria não é feita.

Solicitação de ativação. No modo local, um administrador também vê Solicitação de ativação. Ela baixa license_request_<server>.json. Envie-a ao fornecedor. O fornecedor vincula uma licença ao id de instalação contido nela. Instale a licença recebida de volta com a mesma página. Use isso para um servidor que não consegue acessar o servidor de licenças.

Mensagens que você pode ver

Mensagem O que significa
Licença aceita O agente ou o goafts aceitou o arquivo.
Escolha um arquivo de licença primeiro. Você clicou no botão sem escolher um arquivo.
O arquivo tem mais de 1 MB: isto não é uma licença. Você escolheu um arquivo errado.
Esta conta não pode alterar licenças aqui: instalar uma licença exige uma conta de administrador Modo local, e sua conta não é de administrador. O campo de arquivo e o botão estão ocultos.
Esta conta não pode alterar licenças aqui: este console não consegue entregar uma licença a este servidor: … O agente não está nesta máquina (agent_config_path), e a entrega pelo goafts não está configurada. Instale a licença nesse servidor.
A licença foi enviada para o goafts e não está vinculada a SRV: atribua-a aos servidores na lista abaixo. Modo remoto. Após o envio, atribua a licença na lista de licenças no goafts.
this agent has no license support: update the agent first (…) O agente é antigo demais para licenças.

Licenças no goafts

Esta lista mostra as licenças que o goafts armazena. Ela é exibida apenas quando o console está configurado para entrega de configuração (goafts_push_enabled e as chaves goafts_admin_*, modo de usuários multiple), e sua conta é de administrador ou tem Pode enviar configuração para agentes.

A linha de título tem Atualizar e, para um administrador quando o goafts tem uma licença padrão, Limpar licença padrão.

Coluna O que mostra
Licença O id da licença. O rótulo default marca a licença padrão. O rótulo assigned here marca a licença do servidor aberto. Um número entre colchetes, por exemplo (3), mostra a quantos agentes a licença está atribuída.

| Cliente | O cliente da licença. | | Válida até | A data de expiração. | | Assentos usados / total | Para cada tipo de assento: quantos estão em uso e quantos a licença possui. | | Estado | O selo de estado da licença. | | Ações | Atribuir ao SRV ou Desatribuir do SRV para o servidor aberto (um servidor cujo agente está em outro lugar), e Definir como padrão (somente administradores). |

A licença padrão se aplica a todo agente deste goafts que não tenha licença própria.

Mensagens que você pode ver

Mensagem O que significa
Nenhuma licença está armazenada no goafts. Envie uma licença primeiro.
Atribuições salvas O goafts salvou a alteração.
Tornar … a licença padrão? Ela se aplica a todo agente deste goafts que não tenha licença própria. Confirme Definir como padrão.
Limpar a licença padrão? Agentes sem licença própria não terão nenhuma. Confirme Limpar licença padrão.
a licença padrão se aplica a todo agente do goafts; somente um administrador pode alterá-la Sua conta não é de administrador.
esta alteração não pode ser registrada na trilha de auditoria, portanto não foi feita: … O console não consegue gravar seu arquivo de auditoria. Verifique audit_file.

O período de teste

Um novo agente executa um período de teste em duas etapas:

The trial
  • Etapa 1: os primeiros 7 dias a partir da primeira inicialização. Nenhum e-mail é necessário.
  • Etapa 2: você informa um e-mail de trabalho, o servidor de teste do fornecedor envia um código para você, e você insere o código. O período de teste então dura 30 dias a partir da primeira inicialização.
  • Após o período de teste, sem licença e com a aplicação das restrições ativada, o agente interrompe backups, restore, sweep, tracing, estatísticas e replicação. Os bancos de dados continuam funcionando.

Os detalhes do servidor mostram a etapa do período de teste, o fim da etapa 1, o último fim do período de teste (com os dias restantes) e o estado da solicitação de e-mail.

Estender o período de teste (modo local, administrador). A seção Estender o período de teste para 30 dias é exibida para um servidor sem licença adquirida que tenha dados de teste.

  1. Informe o endereço em E-mail de trabalho.
  2. Marque a caixa de consentimento. Ela informa para onde o endereço vai e por quanto tempo ele é mantido.
  3. Clique em Enviar. A página mostra a resposta do servidor de teste, ou “A solicitação foi enviada.”
  4. Quando o e-mail chegar, insira o código de 6 dígitos em Código do e-mail e clique em Confirmar.

O agente instala a licença de teste por conta própria quando o fornecedor a assinou. Uma linha “Solicitação: …” mostra o estado da solicitação.

Para um servidor cujo agente está em outro lugar, a página mostra apenas o período de teste. Informe o e-mail nesse servidor, em seu próprio console ou com fbagent --trial-email.

Ambas as etapas são gravadas no arquivo de auditoria. A linha de auditoria do e-mail carrega um hash do endereço, não o endereço. O código nunca é gravado.

Mensagens que você pode ver

Mensagem O que significa
Somente um administrador pode enviar o e-mail e o código. Modo local, e sua conta não é de administrador.
Esta página mostra apenas o período de teste deste servidor. Para estendê-lo, informe o e-mail nesse servidor: no HQbird Monitor naquela máquina, ou com fbagent –trial-email. O agente não está nesta máquina.
O agente não tem servidor de teste definido (license.trial_server em agent_config.json), portanto nenhum e-mail pode ser enviado daqui. Defina license.trial_server na configuração do agente.
Este não é um endereço de e-mail válido. / Marque a caixa de consentimento primeiro. Corrija o formulário e clique em Enviar novamente.
Insira o código de 6 dígitos do e-mail. O campo de código está vazio.
Código incorreto. Tentativas restantes: 2. O código não corresponde. Verifique o e-mail.
A solicitação está encerrada: … A solicitação terminou, por exemplo “códigos incorretos demais” ou “este servidor já teve um período de teste”.
Nenhum período de teste é possível para este servidor: ele já tem uma licença, ou já se passaram 30 dias desde a primeira inicialização. O período de teste não pode ser estendido.
O agente não consegue alcançar o servidor de teste. Verifique se este host consegue abrir conexões HTTPS para ele. Um problema de rede no host do agente.
O código foi aceito. O agente instala a licença de teste por conta própria quando o fornecedor a assinou. Aguarde. O estado muda para licença de teste instalada.
O período de teste acabou. Somente uma licença adquirida restaura o trabalho interrompido. Instale uma licença adquirida.

O banner de licença

Toda página mostra um banner sob o cabeçalho, para os servidores que você pode ver:

  • vermelho: “Sem licença. Backups, restore, sweep, tracing, estatísticas e replicação estão interrompidos. Os bancos de dados funcionam.” Um servidor não tem licença e a aplicação das restrições está ativada. O link é Página de licença.
  • amarelo: “Teste: 5 dias restantes. Para estendê-lo para 30 dias, informe um e-mail de trabalho.” Um servidor está na etapa 1 do período de teste e tem 7 dias ou menos restantes. O link é Informar um e-mail.

Cada linha termina com “Servidores: …” e até 3 nomes de servidores, depois “e mais 4” quando houver mais. Com um servidor, o link abre esse servidor na Página de licença. Com vários servidores, ele abre a lista. Informar um e-mail vai para a seção de teste da Página de licença e coloca o cursor no campo de e-mail.

Um servidor cujo último relatório tem mais de três dias é deixado de fora do banner.


11. Administração: usuários, clusters, notificações e atualizações

As páginas Usuários e Clusters são somente para administradores. A página Servidores mostra o botão Gerenciamento de usuários apenas para um administrador no modo multiple, e o botão Clusters para um administrador (veja modo goafts, modo RCM e modo agente para o modo de usuário único). Outra conta que abrir essas páginas recebe “Proibido”.

As páginas Notificações e Atualizações funcionam com o agente nesta máquina. Todo usuário pode abri-las; somente um administrador pode alterar algo nelas.

Usuários

O console tem dois modos de usuário. O administrador define o modo em config.properties (users_mode).

  • single (padrão): uma conta compartilhada. A senha dela está no agent_config.json do agente local (fbagent 2.80.0 ou mais recente) ou em access.properties. Este usuário pode fazer tudo. Não há gerenciamento de usuários. A senha é alterada na página Configurações (veja Configurações).
  • multiple: várias contas, cada uma com sua própria senha e lista de servidores. As contas são mantidas em users.enc.

No modo multiple, abra Gerenciamento de usuários na página Servidores.

User management
User management

O que você vê

  1. O cabeçalho com ← Servidores, e a linha de navegação Servidores › Usuários.
  2. O título Usuários com o número de usuários, o campo de busca Buscar usuários…, e o botão Adicionar à direita.
  3. A tabela de usuários.
  4. A linha de paginação: Anterior, “Página 1 de 1”, Próxima, e “Total: 3”.
Coluna O que mostra
Login O login. Clique nele para editar o usuário.
Servidores Todos os servidores para um administrador. Para um usuário: os nomes dos servidores atribuídos, ou “—” quando não houver nenhum.
Ações Excluir remove o usuário após você confirmar.

Mensagens que você pode ver

Mensagem O que significa
Excluir usuário …? Confirme a exclusão.
Falha ao excluir usuário: não é possível remover o último administrador O console deve manter pelo menos um administrador.
Falha ao carregar usuários: … O console não consegue ler users.enc.

Dicas:

  • A busca encontra logins que contêm o texto. A lista é atualizada após uma breve pausa e volta para a página 1.
  • A tabela mostra 50 usuários por página.

Adicionar ou editar um usuário

Adicionar abre o formulário para um novo usuário:

Add a user
Add a user

O que você vê

  1. O cabeçalho com ← Servidores e um link Usuários, e a linha de navegação Servidores › Usuários › Adicionar usuário.
  2. O título Adicionar usuário.
  3. À esquerda: Login, Senha, Tipo, os três direitos com seus textos de ajuda, e Salvar.
  4. No meio: Servidores disponíveis, com o campo de busca Buscar servidores…, o botão Adicionar, a caixa Selecionar todos os filtrados (somente enquanto você busca), e os servidores como “nome (id)”.
  5. À direita: Servidores atribuídos, com a caixa Selecionar todos e o botão Remover selecionados. Sem servidores, mostra “Nenhum servidor atribuído”.
Campo O que faz
Login O nome para entrar.
Senha A senha. Na página de edição, deixe-a vazia para manter a senha atual (“Deixe em branco para manter a senha atual”).
Tipo Usuário (padrão) vê apenas seus Servidores atribuídos. Administrador vê todos os servidores e gerencia usuários e clusters. Para um administrador, os painéis de servidores ficam ocultos, e o formulário mostra “Todos os servidores”.
Pode enviar configuração para os agentes “Permite que esta conta envie um agent_config.json editado para o agente através do goafts, e salve e aplique a configuração do agente nesta máquina (administradores podem fazer isso sem esse direito).”
Pode executar tarefas nos agentes “Permite que esta conta inicie e cancele um backup, restore, sweep ou recálculo de índices em um agente a partir da página de configuração. Para um servidor remoto, também é necessário que o envio de configuração esteja configurado.”
Pode executar tarefas que substituem um banco de dados “Também permite que esta conta execute um restore que substitui um banco de dados em uso. Funciona somente junto com o direito de executar tarefas, e o agente também deve permitir.”

Todo direito fica desativado para uma conta existente.

Para adicionar um usuário:

  1. Preencha Login e Senha.
  2. Escolha o Tipo.
  3. Marque os direitos de que o usuário precisa.
  4. Para um Usuário: encontre servidores em Servidores disponíveis (digite em Buscar servidores…), marque-os e clique em Adicionar. Adicionar fica ativo somente quando uma caixa está marcada. Selecionar todos os filtrados aparece somente enquanto o campo de busca tem texto. Ele marca todos os servidores que correspondem à busca. Os servidores se movem para Servidores atribuídos. Marque servidores lá e clique em Remover selecionados para devolvê-los.
  5. Clique em Salvar. O console abre a página de edição do novo usuário.

Para editar um usuário, clique no login na lista. A página de edição tem o título Editar usuário e a navegação Servidores › Usuários › <login>.

Mensagens que você pode ver

Mensagem O que significa
Usuário salvo A alteração foi salva.
Falha ao adicionar usuário: login duplicado Já existe um usuário com este login.
Falha ao adicionar usuário: login inválido / senha inválida O login ou a senha não é permitido. Use outro.
Falha ao adicionar usuário: contagem máxima de usuários excedida O console comporta até 2000 usuários.
Falha ao salvar usuário: usuário não encontrado Alguém excluiu este usuário.
Falha ao salvar usuário: não é possível remover o último administrador Você tentou tornar o último administrador um Usuário.
Nenhum servidor disponível Todos os servidores estão atribuídos, ou nenhum servidor corresponde à busca.

Quando as alterações se aplicam:

  • O console lê users.enc em cada requisição. Uma nova lista de servidores, um novo tipo ou um novo direito se aplica no próximo carregamento de página do usuário.
  • Uma nova senha desconecta esse usuário em todos os navegadores.
  • No modo single, o único usuário compartilhado pode executar tarefas no agente ao lado do console, mas não em um agente remoto.

Na primeira inicialização no modo multiple, o console cria o administrador admin7 com uma senha aleatória. A senha é gravada uma vez no log do console, ou, quando o administrador definiu initial_admin_password_file, nesse arquivo e não no log. Entre e altere-a.

Clusters

Clusters gerencia os grupos de replicação do HQCluster: os membros, o

Os links de replicação e os certificados dos membros. O console não armazena os clusters em si. Ele os edita por meio da API de administração do goafts ou do RCM, ou por meio do agente neste servidor (consulte modo goafts, modo RCM e modo agente). No modo local, a página também tem a seção Cluster neste servidor.

The Clusters page with one cluster open
A página Clusters com um cluster aberto

O que você vê

  1. O cabeçalho com ← Servers, e a linha de navegação Servers › Clusters.
  2. Uma linha de erro. Ela fica vazia quando está tudo bem.
  3. O título HQCluster clusters com o número de clusters, o campo New cluster id e o botão Create.
  4. A lista de clusters. Clique em uma linha para abrir o cluster.
  5. O cluster aberto: seu id e sua revisão (rev 6), depois as configurações do cluster em uma linha.
  6. Members com o botão Add member, e a tabela de membros.
  7. Replication links com o botão Add link, e a tabela de links.
  8. Os botões Validate, Save e Delete cluster (não no modo RCM ou no modo agente), e abaixo deles a lista de erros e avisos.
  9. Status, Certificate requests e Cluster CA (consulte Status do cluster e certificados).
Coluna O que mostra
Cluster O id do cluster.
Name O nome do cluster.
PKI managed ou external.
Revision A revisão do documento de cluster armazenado. Ela cresce a cada salvamento.
Members O número de membros.

As configurações do cluster:

Campo O que define
Name Um nome para as pessoas.
PKI managed: a CA própria do cluster assina os certificados dos membros, e os agentes os renovam. external: você mesmo gerencia os certificados, e os agentes apenas os reportam.
Certificate validity, days Por quanto tempo um certificado de membro é válido: 2 a 825 dias. Padrão 90.
Renew before, days Quantos dias antes da data de expiração o certificado é renovado. Padrão 30.
Check peer names (managed certificates only) Os membros verificam os nomes nos certificados uns dos outros.

A tabela de membros:

Coluna O que mostra
Member O id do membro.
Agent O agente do host. O campo oferece os agentes conhecidos conforme você digita.
Role master, replica ou rcm.
Addresses Os endereços do membro, separados por vírgulas ou espaços, por exemplo 192.168.0.10.
Port A porta de replicação. Um novo membro recebe 7051.
Install dir A pasta de instalação do membro.
Actions Re-key (somente membros salvos) solicita uma nova chave e um novo certificado. Remove remove o membro e seus links de replicação.

Após um salvamento, Member, Agent e Role de um membro não podem ser alterados. Para alterá-los, remova o membro e adicione-o novamente. As alterações nas tabelas de membros e de links são armazenadas somente quando você clica em Save.

A tabela de links:

Coluna O que mostra
Master Um membro com a função master.
Replica Um membro com a função replica.
Actions Remove remove o link.

Para criar ou alterar um cluster:

  1. Digite um New cluster id e clique em Create. Ou clique em um cluster existente para abri-lo.
  2. Clique em Add member para cada membro. Preencha o agente, a função, os endereços e a porta.
  3. Clique em Add link para cada link de um master para uma replica.
  4. Clique em Validate. A página mostra “The document is valid.” ou uma lista de erros (vermelho) e avisos (âmbar).
  5. Clique em Save.

Mensagens que você pode ver

Mensagem O que significa
A cluster id is lower-case letters, digits and “-”, up to 63 characters. Altere o id. Ele não pode começar nem terminar com “-”.
No clusters yet. Crie o primeiro cluster.
The document is valid. Validate não encontrou problemas.
Uma lista de linhas vermelhas e âmbar Erros impedem o salvamento. Avisos não. Um Save recusado mostra seus erros na mesma lista.
Cluster saved A nova revisão é armazenada.
Someone else changed this cluster. Reload it and make your change again. Outro administrador salvou o cluster depois que você o abriu.
Delete cluster …? It must have no members. Confirme Delete cluster. Remova todos os membros e salve primeiro.
clusters are edited through … admin API, which this console is not set up for: … As configurações do console para clusters estão incompletas. Consulte Solução de problemas.
this change cannot be recorded in the audit trail, so it was not made: … Toda alteração é gravada primeiro no arquivo de auditoria. Verifique audit_file.

Status do cluster e certificados

Estas partes são mostradas para um cluster salvo.

Status mostra o que cada membro reporta. Refresh lê novamente. Rotate CA é mostrado somente para um cluster com PKI managed.

Coluna O que mostra
Member O id do membro e sua função.
Agent O agente do membro.
Reported ✓ quando o membro reportou, — quando não.
Revision A revisão do cluster que o membro aplicou.
Certificate until A data de expiração do certificado do membro. renew due marca um certificado que está no prazo de renovação.
Service O estado do serviço de replicação, por exemplo running.
License O selo do estado da licença do agente, e a data relevante abaixo dele, por exemplo a data de expiração. Clique nele para abrir o servidor na página License.
Last error O último erro do membro.

Certificate requests mostra as 20 solicitações mais recentes, as mais recentes primeiro.

Coluna O que mostra
Request O id da solicitação.
Member O membro que solicitou um certificado.
Reason Por que o certificado foi solicitado.
State O estado da solicitação.
Last error Por que a solicitação foi recusada, se foi.

Cluster CA lista os certificados de CA em que os membros confiam.

Coluna O que mostra
Fingerprint A impressão digital SHA-256 do certificado da CA.
Subject O assunto do certificado da CA. (retired) marca uma CA que não é mais usada.
Valid until A data de expiração do certificado da CA.
Actions Retire remove a CA do pacote em que os membros confiam.

Mensagens que você pode ver

Mensagem O que significa
Rotate the CA of cluster …? Every member gets a new CA bundle and restarts once in its window. Confirme Rotate CA.
Make a new key and certificate for …? Confirme Re-key.
Remove this CA from the bundle the members trust? Confirme Retire.
Order queued A ordem é armazenada. Os membros a executam.

Cluster neste servidor

Esta seção fica no topo da página Clusters. Ela é mostrada somente no modo local (agent_config_path está definido), e somente para um administrador. O console trabalha com o agente nesta máquina por meio de sua Local API. O agente precisa das rotas de cluster (GET /v1/cluster); com um agente mais antigo a seção diz “The agent on this server is too old for this section. Update fbagent.”

O que você vê

  1. O estado do agente: Free: not in a cluster, In a cluster ou Runs the RCM of its own cluster. Depois, o id do cluster, a origem do cluster (rcm, goafts ou none), por que o agente está neste estado, e os avisos do agente.
  2. Prepare for a cluster, somente para um agente livre: a janela de emparelhamento, a porta de emparelhamento, a impressão digital do certificado, o tempo restante, o RCM que pode convidar este servidor, e o que o agente fez no firewall.
  3. Cluster console (RCM): se o RCM está instalado e em execução, o agente que o executa, seu cluster e sua pasta. Enable the cluster console (RCM) é mostrado para um agente livre. Open the RCM console é mostrado quando o RCM está em execução.

Para preparar este servidor para um cluster que outro RCM gerencia:

  1. Opcional: em Which RCM may invite this server, digite endereços, faixas ou nomes de host, separados por vírgulas. Deixe o campo vazio para manter a lista que o agente tem. Digite any para permitir que qualquer RCM convide este servidor.
  2. Clique em Open the pairing window for 24 hours. Enquanto a janela estiver aberta, o agente abre a porta de emparelhamento no firewall do host.
  3. No console do RCM, adicione este servidor na página Link hosts. Verifique lá que a porta e a impressão digital são as mesmas desta seção.
  4. Clique em Close the pairing window se você não precisar mais dela.

O agente que executa o RCM não recebe janela de emparelhamento: outro RCM poderia tirá-lo de seu próprio cluster.

Para tornar este servidor o console (RCM) de um novo cluster:

  1. Opcional: digite um New cluster id. Vazio: o id é criado a partir do nome do host.
  2. Clique em Enable the cluster console (RCM) e confirme. O botão fica desativado até que o programa RCM esteja no cache de produtos do agente.
  3. O agente cria o RCM do host. A seção acompanha o trabalho. O agente pode reiniciar durante esse tempo; a página espera por ele até 3 minutos.
  4. No final, a seção mostra o id do cluster, a URL do console (https://<host>:7444/), o login e o arquivo no servidor que contém a senha. A senha nunca é mostrada. Quando o RCM já tem seus logins, a seção mostra a observação do agente em vez disso.

Toda alteração é gravada primeiro no registro de auditoria: cluster.pairing.open, cluster.pairing.close, cluster.rcm.enable.

Mensagens que você pode ver

Mensagem O que significa
This server runs the RCM of its cluster, so it cannot open a pairing window: … O agente executa o RCM. Vincule os outros servidores a este RCM.
This server is already in a cluster. O RCM não pode ser habilitado em um servidor que está em um cluster.
Another agent on this host already runs the RCM. Um RCM por host. Use o console desse RCM.
The RCM program is not in the agent’s product cache yet. Atualize os produtos do agente e tente novamente.
Another operation of the agent is in progress. … Aguarde até que ela termine e tente novamente.
The agent does not answer. It may be restarting; still waiting… Normal enquanto o RCM está sendo habilitado.
The agent restarted, so it has forgotten the operation. … A seção lê o estado novamente. Verifique se o RCM está em execução.
The agent on this server does not answer. Verifique se o serviço do agente está em execução.
Another agent answers on the address of this server’s agent. Nothing was sent. agent_config_path indica a configuração de outro agente.

modo goafts, modo RCM e modo agente

A página trabalha com um de três clientes. Ela usa o primeiro que se aplica, nesta ordem:

  1. rcm_admin_url está definido (uma configuração manual): modo RCM.
  2. O agente nesta máquina (agent_config_path) tem cluster.source em seu agent_config.json: rcm dá o modo agente, goafts dá o modo goafts.
  3. A entrega de configuração por meio do goafts está configurada: modo goafts.
  4. agent_config_path está definido: modo agente.
modo goafts modo RCM modo agente
Quando rcm_admin_url está vazio (padrão). rcm_admin_url está definido. Consulte a ordem acima.
Configurações goafts_push_enabled=true, as cinco chaves goafts_admin_*, e users_mode=multiple. rcm_admin_url, rcm_admin_user e rcm_admin_password_file, e rcm_admin_ca para um RCM que usa TLS. Modo de usuários single ou multiple. As chaves do goafts não são necessárias. Somente agent_config_path. Sem chaves rcm_admin_* ou do goafts. Modo de usuários single ou multiple.
Onde o console é executado Em qualquer lugar que alcance o goafts. No host do RCM: o console chama a porta de operador do RCM, geralmente https://127.0.0.1:7444. No host do RCM, ao lado do agente que executa o RCM. O agente repassa cada chamada às rotas /v1/cluster/admin do RCM na porta 7443 e faz login com seu próprio certificado.
Clusters Muitos. No máximo um. Create funciona somente enquanto o RCM não tem cluster. Como no modo RCM.

| Excluir cluster | Exclui um cluster que não tem membros. | Não exibido: o RCM recusa a exclusão, porque o cluster existe enquanto o RCM existir. | Como no modo RCM. | | Sugestões de agentes | Os servidores que este console vê. | Os agentes que se juntaram ao RCM. Agentes revogados não são oferecidos. | Como no modo RCM. |

Todo o resto funciona da mesma forma em todos os modos: o editor, Validate, Save com a verificação de revisão, o status, as solicitações de certificado, a CA do cluster, Re-key, Rotate CA e Retire.

No modo RCM, o console faz login no RCM como rcm_admin_user (HTTP Digest) e envia o login do usuário do console com cada alteração. Um RCM criado pelo instalador serve sua porta de operador via TLS com um certificado da própria CA do cluster. Defina rcm_admin_ca para essa CA (certs/ca.crt na pasta do RCM, por exemplo /opt/hqbirdrcm/certs/ca.crt), ou o console não conseguirá conectar. As chaves rcm_admin_* são apenas para esta configuração manual.

No modo agente, o console não precisa de usuário, senha ou CA do RCM. O RCM grava cada alteração em sua auditoria como agent:<agent id> (<console user>). Em um host onde o agente não executa o RCM, a página informa qual host executa o RCM do seu cluster e vincula ao console desse RCM (https://<rcm host>:7444/). Quando o agente é mais antigo que as rotas do cluster, a página diz “Update fbagent”. Quando o RCM é mais antigo que suas rotas para o agente, a página diz “Update hqbirdrcm”.

Com users_mode=single, a página Servers mostra o botão Clusters quando rcm_admin_url ou agent_config_path está definido. Caso contrário, abra /clusters diretamente.

Notificações

O botão Notifications na página Servers abre a página Notifications (/notifications). Aqui você configura para onde o agente nesta máquina envia suas próprias mensagens sobre problemas do servidor: Telegram, um webhook (Slack, Teams, Discord, Mattermost, Rocket.Chat, ntfy ou JSON bruto) ou e-mail. O agente faz o trabalho; a página apenas lê e altera suas configurações através da Local API do agente. O documento do fbagent NOTIFY.md descreve o lado do agente: as chaves e a Local API.

Quem pode usar a página.

  • Todo usuário conectado que pode ver o servidor pode ler a página.
  • Apenas um administrador pode alterar algo. No modo de usuário único, este é o único usuário. Outra conta vê a linha “This account cannot change notifications: changing notifications needs an administrator account”, e nenhum botão.
  • A página funciona apenas para o agente nesta máquina (agent_config_path). Um console central diz “There is no agent on this machine (agent_config_path), or this account may not see it. Notifications are set up on the server where the agent runs.” e não oferece nada para editar.
  • Um agente que não responde exibe “Cannot ask the agent: …”. Um agente que é muito antigo diz “This agent is too old for notifications. Update the agent.”
The Notifications page on a central console
The Notifications page on a central console

A imagem é de um console central, que não tem agente próprio. Ela mostra apenas o título, o botão Refresh, a nota e a linha “There is no agent on this machine”. Um console com um agente em sua máquina mostra a página completa.

O que você vê em um console com seu próprio agente

  1. O cabeçalho com ← Servers, e a linha de breadcrumb Servers › Notifications.
  2. O título Notifications of the agent, o botão Refresh e uma nota: a primeira mensagem chega cerca de 20 minutos após o início de um problema.
  3. O nome do servidor deste agente.
  4. Who sends: Mode, Sends now e Mode set at, a lista de modos com uma linha cada, e (para um administrador) a lista de modos com Save mode.
  5. HQbird Telegram bot: os alertas através do bot do HQbird.
  6. Channels: o botão Add channel e a tabela de canais.
  7. Delivery journal: as últimas 50 entregas.

Quando o período de teste ou a licença terminou, uma linha vermelha sobre os blocos diz: “The trial or license has ended. Notifications are switched off.”

Quem envia

Modo Quem envia
Auto (padrão) Este agente, quando tem um canal habilitado. Caso contrário, o HQCenter.
This agent Apenas este agente.
HQCenter Apenas o HQCenter.
Both Este agente e o HQCenter.
Off Ninguém.

Sends now é o resultado do modo: this agent, HQCenter ou nobody. Por exemplo, no modo Auto sem nenhum canal habilitado, ele diz HQCenter. No modo HQCenter, os alertas vêm do centro de coleta, e os canais desta página não são usados.

Para alterar o modo: escolha-o na lista e clique em Save mode. A página diz “Mode saved.”

Adicionar um canal Telegram com seu próprio bot

Você precisa de um bot do Telegram e seu token (do @BotFather), e um chat onde o bot seja membro.

  1. Clique em Add channel. O formulário New channel abre sob a tabela.
  2. Informe um Name: letras minúsculas, dígitos, ponto, hífen ou sublinhado. O nome não pode ser alterado depois.
  3. Escolha Type: Telegram.
  4. Informe o Bot token.
  5. Escreva qualquer mensagem para o bot no chat que deve receber os alertas.
  6. Clique em Find chat. A página consulta o Telegram pelos chats que escreveram para o bot (“Click a chat to use it:”). Clique no chat. Seu ID vai para Chat ID. Para um tópico de um grupo, informe também Thread ID (topic).
  7. Defina os campos comuns (veja abaixo), por exemplo Language.
  8. Clique em Save channel. A página diz “Channels saved.”
  9. Clique em Send test na linha do canal. A página diz “Test message sent to …”, ou mostra o erro do agente.

Adicionar um webhook ou um canal de e-mail

  • Webhook: Webhook URL, Format (raw, slack, mattermost, rocketchat, discord, teams ou ntfy) e Auth header (Name: value) quando o receptor precisar. Use o formato do programa que recebe a mensagem, por exemplo slack para um webhook de entrada do Slack.
  • E-mail (SMTP): Server address (host:port), User, Password, TLS (auto é TLS implícito para a porta 465, caso contrário STARTTLS), From e To (addresses separated by commas).

Em seguida, clique em Save channel e Send test, como para o Telegram.

Campos de todos os tipos de canal: Enabled, Minimum severity (info, warning, serious, critical), Message kinds (problems, resolved, silent server, reports, summaries, test; nada marcado significa todos os tipos exceto test), Language, Short text, Quiet hours (22:00-07:00), Proxy URL e Max messages per hour.

Segredos. O token, a URL do webhook, o cabeçalho de autenticação e a senha nunca mostram seu valor armazenado. Quando um valor está armazenado, o campo vazio diz “stored; leave empty to keep”. Digite um novo valor apenas para substituí-lo.

Edit abre o formulário de um canal salvo. Delete pergunta “Delete channel …?” primeiro. Cancel fecha o formulário. Cada salvamento envia a lista completa de canais ao agente.

A tabela de canais:

Coluna O que mostra
Name, Type O nome e o tipo do canal.
On on ou off.
Min. severity O nível mais baixo que o canal envia.
Language O idioma das mensagens.
Pending Mensagens na fila do canal.
Last success, Last error O horário da última entrega, e o último erro.

HQbird Telegram bot

Com este bloco, os alertas vão para o Telegram a partir do bot do HQbird. Você não precisa de um bot próprio. Os alertas passam pelo servidor do fornecedor do HQbird, e o texto da mensagem também passa por esse servidor.

  1. Clique em Connect Telegram. O agente cria um link de uso único. A página mostra o link (ele abre em uma nova aba) com Copy link, um segundo link para adicionar o bot a um grupo, e o horário de expiração do link. O link funciona uma vez e dura 15 minutos.
  2. Abra o link no Telegram e pressione Start. Se o chat com o bot já estiver aberto, Start não passa o código: envie ao bot a mensagem /start <code> que a página mostra sob o link. Ela tem seu próprio botão Copy.
  3. Enquanto o link estiver aberto, a página verifica a cada 5 segundos. Quando o chat aparecer, a página diz “Telegram is connected: …” e recarrega o bloco e a lista de canais. No primeiro link, o agente adiciona o canal hqbird-bot.

A página para de verificar quando o link expira ou quando a aba do navegador está oculta. Então clique em Connect Telegram novamente para obter um novo link.

  • A tabela de chats conectados mostra Chat, Type (private, group, supergroup, channel) e Connected at. Disconnect pergunta primeiro, depois remove o chat.
  • O bloco também mostra o bot, a zona, “sent today N of M”, o estado da licença quando a licença não é totalmente válida, e o último erro do bot.
  • Quando o bot não está disponível (por exemplo, sem licença), o bloco mostra o motivo informado pelo agente. Um agente muito antigo diz “This agent version does not support the HQbird bot. Update the agent.”

O link usa o idioma atual da página. A trilha de auditoria registra cada link e desconexão, sem o link e sem o código.

Diário de entregas

As últimas 50 entregas: Time, Channel, Result (sent, failed ou expired) e Error. O erro é o texto do agente ou do receptor, como está. Verifique o campo que o erro indica, depois clique em Send test novamente.

Nota: a primeira mensagem chega cerca de 20 minutos após o início de um problema. O agente verifica o status do servidor a cada 10 minutos e envia após uma segunda verificação confirmar o problema. O agente não pode relatar que sua própria máquina está inativa.

Toda alteração (modo, lista de canais, mensagem de teste) vai para a trilha de auditoria com os nomes e tipos dos canais apenas, nunca um token, URL ou senha.

Mensagens que você pode ver

Mensagem O que significa
No channels yet. Clique em Add channel.
No chats found. Write a message to the bot and try again. Find chat não encontrou nenhum chat. Escreva para o bot primeiro.
Enter the bot token first. Find chat precisa do token.
A channel with this name already exists. Escolha outro nome.
Test to … failed: … O agente não conseguiu entregar o teste. O texto informa o motivo.
The agent cannot read its channel file: … O arquivo notify_channels.json do agente está danificado.
The link has expired. Click “Connect Telegram” to get a new one. Os 15 minutos acabaram.

Atualizações

O botão Updates na página Servers abre a página Updates (/updates). Ela mostra de onde o agente nesta máquina obtém suas versões e o que o Firebird, o HQ Monitor e o fbmcp têm e recebem como oferta. A página é para um agente que não está vinculado a um HQCenter: um agente remoto obtém suas versões do seu HQCenter.

Os direitos são os mesmos da página Notifications: todo usuário que pode ver o servidor pode ler a página; apenas um administrador (ou o único usuário no modo de usuário único) pode alterar o modo ou aplicar um pacote do Firebird. Toda alteração vai para a trilha de auditoria. Um console sem agente nesta máquina diz “There is no agent on this machine (agent_config_path), or this account may not see it. A remote agent gets its releases from its HQCenter.”

The Updates page
The Updates page

A imagem é de um console central, que não tem agente próprio. Ela mostra apenas o título, o botão Refresh e a linha “There is no agent on this machine”. Um console com um agente em sua máquina mostra a página completa.

O que você vê em um console com seu próprio agente

  1. O cabeçalho com ← Servers, e a linha de breadcrumb

Servidores › Atualizações. 2. O título Atualizações do HQbird e o botão Atualizar. 3. O nome do servidor e os dados do seu agente: Origem da versão (zona de atualização do fornecedor, HQCenter ou desativada), Zona e Servidor de atualização (com a forma como o agente os encontrou), Modo, Versão do agente, Última resposta e Última falha. 4. O que se atualiza sozinho: os três modos, apenas para uma zona de atualização do fornecedor. 5. Firebird: Instalado, Pacote aguardando, Próxima janela de aplicação, Por que aguarda e Última aplicação. 6. HQ Monitor e fbmcp: uma tabela com Produto, Instalado, Oferecido, Última verificação e Observação.

O que se atualiza sozinho:

Modo O que faz
Agente O agente, o HQ Monitor e o fbmcp se atualizam sozinhos. Um pacote do Firebird é baixado e aguarda você.
Tudo O Firebird também se atualiza sozinho, na sua janela de aplicação (o Firebird reinicia).
Desativado Nenhuma verificação de atualização. Atualize com o instalador.

Para alterar: escolha um modo e clique em Salvar modo. A página exibe “Modo salvo.”

Aplicar um pacote do Firebird. Quando um pacote aguarda, um administrador vê Aplicar agora. A aplicação para o Firebird, instala o pacote e inicia o Firebird novamente. Todas as conexões são fechadas. A página pergunta primeiro: “Aplicar Firebird … em … agora? O Firebird reinicia e todas as conexões são fechadas.” Em seguida, exibe “O agente iniciou a atualização. O Firebird reinicia; atualize em alguns minutos.” Escolha um horário tranquilo para isso, ou deixe o modo Tudo aplicar o pacote na sua janela.

Mensagens que você pode ver

Mensagem O que significa
Este agente é mais antigo que as zonas de atualização: suas atualizações são gerenciadas pelo instalador ou pelo seu HQCenter. Atualize o agente com o instalador.
O agente ainda não tem estado de atualização do Firebird. O agente ainda não verificou o Firebird.
sem estado de atualização neste agente O agente não tem dados sobre este produto.
Não é possível consultar o agente: … O agente não responde. Verifique se o serviço dele está em execução.
Esta conta não pode alterar atualizações: … Sua conta não é de administrador.

12. Instalação e configurações para administradores

Instalação

  • Ao lado de um agente no Windows ou Linux: use o script de instalação. Consulte LOCAL_INSTALL.md.
  • Atrás de HTTPS com nginx: consulte HTTPS_DEPLOYMENT.md.
  • O console não precisa de acesso à internet. Ele serve seus próprios scripts, gráficos e fontes, portanto também funciona em uma rede fechada.

Arquivo de configurações

O console lê um único arquivo de configurações. Ele o procura nesta ordem e usa o primeiro arquivo que encontrar:

  1. O arquivo indicado na variável de ambiente FBMONITOR_CONFIG_PATH. Quando esta variável está definida, o console não procura em nenhum outro lugar.
  2. fbmonitor.properties, depois config.properties, na pasta do arquivo do programa.
  3. fbmonitor.properties, depois config.properties, na pasta de trabalho.

O arquivo config.example.properties lista todas as chaves com um comentário. As linhas que começam com # são comentários. A maioria das chaves também tem uma variável de ambiente FBMONITOR_<KEY>, por exemplo FBMONITOR_PORT. A variável substitui o arquivo. users_mode e draft_keep_days não têm variável. Um caminho relativo em uma chave do arquivo (por exemplo audit_file ou rcm_admin_password_file) é considerado a partir da pasta do arquivo de configurações.

As chaves mais importantes:

Chave Padrão O que define
data_path nenhum A pasta com os dados dos agentes. Obrigatória.
port 8080 A porta HTTP.
data_timezone nenhum O fuso horário dos arquivos de dados quando o agente não informa um.
users_mode single single ou multiple.
initial_admin_password_file nenhum Onde a senha do primeiro administrador é gravada quando o modo multiple cria users.enc. Sem isso, a senha é impressa uma vez no log.
access_properties_path nenhum O caminho para access.properties no modo single. Usado quando o agent_config.json do agente não tem login.
agent_config_path nenhum O agent_config.json ativo do agente local. Ativa o modo local e contém o login do modo single (fbagent 2.80.0 ou mais recente). Também fornece a seção Cluster neste servidor e a página Clusters por meio do agente.
bind_address, behind_proxy todas as interfaces, false Use 127.0.0.1 e true quando o nginx estiver na frente do console.
require_https_for_secrets false false: você pode inserir uma senha do Firebird no editor de configuração via HTTP simples, e um aviso informa que a conexão não é criptografada. true: o campo de senha permanece somente leitura até que a requisição chegue via HTTPS.
goafts_push_enabled, goafts_admin_* false, nenhum Entrega de configuração para agentes remotos. As cinco chaves goafts_admin_* são a URL, o certificado do cliente, sua chave, a CA e o arquivo de token.
goafts_server_list true Quando as cinco chaves goafts_admin_* estão definidas, a página Servidores obtém suas linhas da lista de servidores do goafts e não lê cada pasta de servidor. Ela lê as pastas quando a lista não é utilizável. false: sempre lê as pastas.
config_drift_minutes 10 Após quantos minutos sem resposta do agente o status de entrega mostra DRIFT (consulte Status de entrega). 0 ou um valor inválido significa 10.
draft_keep_days 30 Por quantos dias o console mantém rascunhos antigos da configuração do agente (aplicados ou desatualizados). 0 mantém todos.
rcm_admin_url, rcm_admin_user, rcm_admin_password_file, rcm_admin_ca nenhum Uma configuração manual da página Clusters por meio da API de administração do RCM, sem goafts (consulte modo goafts, modo RCM e modo agente). Ao lado do agente que executa o RCM, eles não são necessários: a página funciona por meio do agente. rcm_admin_ca é o arquivo de CA com o qual o certificado do RCM é verificado; vazio significa o repositório do sistema.
chatwoot_enabled, chatwoot_*, support_email false O chat de suporte na tela do servidor: um balão no canto inferior direito que abre uma janela de chat.
audit_file hqmonitor_audit.log ao lado do arquivo de configurações O log de auditoria.

A chave refresh_interval_sec não é mais usada. O console a ignora e grava um aviso no seu log.

Reinicie o console após alterar o arquivo. Uma reinicialização desconecta todos os usuários.

Alguns arquivos são lidos novamente a cada uso, portanto uma alteração não exige reinicialização:

  • goafts_admin_token_file: lido a cada chamada ao goafts. Você pode rotacionar o token enquanto o console está em execução.
  • rcm_admin_password_file: lido a cada requisição da página Clusters. A quebra de linha no final é ignorada.
  • users.enc no modo multiple: lido a cada requisição.

O console mantém o login no cookie fbmonitor_auth_<port>, por exemplo fbmonitor_auth_8080. O nome vem da chave port. Um navegador mantém cookies por host e não por porta, portanto a porta no nome permite que dois consoles em um mesmo host mantenham logins separados.

  • O login dura 7 dias.
  • O console cria uma nova chave de assinatura a cada inicialização. Uma reinicialização desconecta todos os usuários.
  • No modo multiple, uma nova senha para uma conta desconecta essa conta em todos os navegadores.

A pasta de dados

O console lê a pasta em data_path. Há uma pasta por servidor, nomeada com o nome do agente. Dentro dela:

Pasta Usada para
server_level/cpuram Gráficos de CPU, carga e memória
server_level/GetActiveDatabases Conexões e bancos de dados
server_level/diskspace, firebird_files Espaço em disco e arquivos temporários
server_level/diskio Latência e throughput de disco (tarefa do agente collect_disk_io)
server_level/log_files Página Logs
server_level/statuses, aireport Coluna de status e relatório de integridade
server_level/perfreport Perf Report e a aba Consultas
server_level/tracesummary, traceperminute, lwmmon Principais consultas, página Erros, tabelas de Conexões
server_level/conflict_reports, conf_changes Páginas Conflitos e Configurações
server_level/agent_config Editor de configuração no modo remoto
<database>/DatabaseMetrics Gráficos do banco de dados
<database>/AdvancedDbStats, ClientVersions Páginas Métricas e Versões de Clientes
<database>/*_gstat_full.log Página Estatísticas

13. Solução de problemas

Não consigo fazer login. Verifique a mensagem na página de login. Se ela mencionar access.properties ou users.enc, o administrador deve corrigir as configurações do console. No modo single com fbagent 2.80.0 ou mais recente, o administrador pode definir uma nova senha no host do agente com fbagent --reset-hqmonitor-password. Todas as sessões abertas são encerradas.

Fui desconectado. O console foi reiniciado, ou um administrador definiu uma nova senha para sua conta. Faça login novamente.

Um servidor não está na lista. No modo multiple, peça ao administrador para atribuir o servidor a você. Se você for administrador, verifique se o agente grava dados em data_path.

Os gráficos estão vazios. Escolha outra data com Escolher data. Só é possível selecionar dias com dados. Se nenhum dia puder ser selecionado, o agente ainda não enviou dados.

Os dados estão antigos. Pressione F5. As páginas não são atualizadas automaticamente. Se o horário abaixo do status na página Servidores permanecer antigo, verifique o agente nesse servidor.

Os horários parecem errados. O console mostra o fuso horário do servidor. Verifique o selo de fuso próximo aos controles de horário.

Os links Tarefas e Backups estão ausentes. O agente ainda não enviou sua configuração. Agentes mais antigos não a enviam.

A página Backups está vazia. O agente ainda não registrou um backup. O inventário é preenchido à medida que os backups são executados, e completamente na próxima verificação de status de backup (a cada 2 horas).

A aba Consultas está ausente em um relatório de estatísticas. Nenhum relatório de desempenho utilizável termina dentro de 23 horas do snapshot. Verifique Perf Report para esse dia.

Uma tarefa mostra “gates differ”. O sinalizador da seção e a tarefa do agendador da tarefa não concordam, portanto a tarefa não é executada. Leia o motivo abaixo da palavra de status. Ele indica o interruptor que está desligado, por exemplo “section off” ou “tick off”. Ou use a correção na aba Problemas.

Salvar e enviar ao agente está ausente. A entrega está desativada neste console, ou sua conta não tem Pode enviar configuração para agentes.

Executar agora está esmaecido. Aponte para o botão. A dica de ferramenta indica o motivo: sua conta não tem Pode executar tarefas em agentes, as configurações de entrega estão incompletas, o agente tem comandos remotos desativados, ou o agente é mais antigo que 2.61.0.

O status mostra DRIFT. O agente não respondeu por 10 minutos ou mais após o envio da alteração (a chave config_drift_minutes define esse tempo). Verifique se o agente está em execução e consegue acessar o goafts.

A página Clusters mostra “clusters are edited through RCM’s admin API, which this console is not set up for: …”. rcm_admin_url está definido, mas outra configuração do RCM está ausente. O final da mensagem a indica:

  • “rcm_admin_user is not set”: adicione rcm_admin_user e reinicie o console.
  • “rcm_admin_password_file is not set”: adicione a chave e reinicie o console.
  • “rcm_admin_password_file cannot be read: …” ou “rcm_admin_password_file … holds no password”: corrija o arquivo. O console o lê a cada requisição, portanto não é necessário reiniciar.
  • “rcm_admin_ca cannot be read: …”: corrija o caminho em rcm_admin_ca e reinicie o console.

A página Clusters mostra “clusters are edited through goafts’ admin API, which this console is not set up for: …”. rcm_admin_url está vazio, portanto a página usa o goafts, e a entrega de configuração não está configurada. O final da mensagem indica a configuração ausente, por exemplo “goafts_push_enabled is false, …” ou “users_mode is not multiple, …”. Configure a entrega. Em um host RCM sem goafts, defina agent_config_path: a página então funciona por meio do agente que executa o RCM. As chaves rcm_admin_* são para uma configuração manual (consulte modo goafts, modo RCM e modo agente).

A página Clusters diz “The agent on this server is too old for this page. Update fbagent.”

O agente neste servidor não tem rotas de cluster (/v1/cluster/admin). Atualize o fbagent.

A página Clusters exibe “The RCM on this server is too old for this page. Update hqbirdrcm.” O agente repassou a solicitação, mas o RCM deste host não tem rotas de administração para o seu agente (porta 7443). Atualize o hqbirdrcm.

A página License mostra NO DATA para um servidor. O agente desse servidor é mais antigo que o suporte de licença, ou ainda não gravou seu primeiro relatório. Atualize o agente ou aguarde.