Pular para o conteúdo principal

Registro

O módulo "Registro" na Platform OneEntry permite que os administradores monitorem tanto as ações de outros administradores no sistema quanto a atividade da API de Conteúdo pública. O módulo é composto por quatro abas:

AbaO que mostra
Registro de ações do adminTodas as ações dos administradores no sistema: criação, modificação, exclusão de entidades.
Tráfego dos administradoresSessões de login dos administradores: quando entraram, quando saíram, de qual dispositivo.
Estatísticas da API de ConteúdoContadores de chamadas de todos os endpoints públicos do site em diferentes períodos.
Erros da API de ConteúdoTodas as respostas 4xx/5xx da API pública com detalhes da solicitação e stack trace.

Na interface do módulo, as abas são rotuladas como: Registro de Admin, Registro de Acesso ao Aplicativo Admin, Estatísticas da API de Conteúdo, Erros da API de Conteúdo.

As abas de estatísticas e erros da API de Conteúdo estão disponíveis sob permissões separadas — veja Permissões para o registro.

Registro de ações do admin​

A aba principal, que mostra todas as ações dos administradores no sistema.

Elementos da interface​

A aba consiste em dois blocos:

  • Filtros
  • Lista de ações

Filtros​

Para filtrar ações, os seguintes campos estão disponíveis:

  1. De — campo de texto para a data a partir da qual as ações devem ser filtradas.
  2. Até — campo de texto para a data até a qual as ações devem ser filtradas.
Campos de entrada de datas

As datas podem ser inseridas como uma string no formato de data da sua região, além de poder selecionar a data necessária usando o calendário que aparece ao clicar no campo de entrada de data.

  1. ID do Administrador — campo numérico para o identificador único do administrador.
  2. Ações do usuário — lista suspensa de ações do usuário:
    • Criação
    • Modificação
    • Exclusão
  3. Status — lista suspensa de status das ações:
    • Sucesso
    • Erro
  4. Nome do módulo — lista suspensa de nomes de módulos:
    • Administradores
    • Conjuntos de atributos
    • Backup
    • Gerenciamento de blocos
    • Gerenciamento de eventos
    • Configurações gerais
    • Upload de arquivos
    • Editor de arquivos
    • Gerenciamento de formulários
    • Localização
    • Marcadores
    • Menu
    • Módulos
    • Gerenciamento de conteúdo
    • Produtos
    • Gerenciamento de pedidos
    • Configurações básicas
    • Gerenciamento de pagamentos
    • Gerenciamento de status de produtos
    • USUÁRIO
    • Gerenciamento de provedores de autenticação e usuários
    • Gerenciamento de templates
    • Gerenciamento de templates de visualização
  5. ID do Registro — campo numérico para o identificador único do registro.

Abaixo do bloco de filtros, há dois botões:

  • Excluir dados — exclui registros do registro de ações do admin para o período definido pelos campos De / Até (veja Limpeza de registros manualmente).
  • Redefinir — redefine os filtros aplicados.

Lista de ações​

A lista de ações é apresentada em forma de tabela com seis colunas:

  1. Ações do usuário
  2. Status
  3. Login do usuário
  4. Nome do módulo
  5. ID do registro
  6. Data e hora
Ordenação

Para cada coluna, é possível ordenar os dados clicando no cabeçalho da coluna. O primeiro clique ordena em ordem decrescente, o segundo em ordem crescente, e o terceiro redefine a ordenação.

Auditoria de visibilidade do bloco​

Cada alternância de visibilidade do bloco (toggle "mostrar/não mostrar" na administração de blocos) é automaticamente registrada no Registro de ações do admin. É possível ver qual admin e quando alterou o estado de um bloco específico.

Na lista de ações, esse registro se refere ao módulo Gerenciamento de blocos.

Tráfego dos administradores (Registro de Acesso Admin)​

A aba "Tráfego dos administradores" mostra cada entrada e saída de um administrador no sistema como um registro separado. É possível ver quem e quando acessou a administração, o que é útil para auditoria.

Campos da tabela​

A tabela consiste em seis colunas:

ColunaO que significa
Loginlogin do administrador
IPendereço IP de onde o admin acessou
Hora de Logindata e hora do login
Hora de Logoutdata e hora do logout (para sessões ainda abertas — Ativo)
Duraçãoduração da sessão (para ativa — do login até o momento atual)
Razãorazão para o fechamento da sessão: Logout (o próprio clicou em "Sair") ou Admin Revoked (outro admin forçou o fechamento da sessão); para sessão aberta — Ativo
Ordenação

Assim como no Registro de ações do admin, qualquer coluna pode ser ordenada clicando em seu cabeçalho.

Expiração da autorização

A expiração da autorização e sua renovação automática não são registradas como um registro separado. A sessão com a autorização expirada é marcada como fechada não imediatamente, mas quando deixa de ser utilizada.

Filtros​

  • De / até — período (campos de entrada de data com calendário).
  • ID do Administrador — campo numérico para filtrar por um administrador específico.
  • Status da Sessão — lista suspensa de status da sessão: Todos / Ativo / Fechado.

Botão "Excluir dados"​

Exclui registros de sessões para o período definido pelos campos De / Até. Ao clicar, uma caixa de diálogo de confirmação é aberta:

Confirmar ação — Excluir todas as sessões fechadas para o período especificado? Esta ação é irreversível. Sessões ativas permanecerão.

Somente sessões fechadas são excluídas. Sessões ativas (com autorização aberta) não são excluídas.

Estatísticas da API de Conteúdo​

A aba "Estatísticas da API de Conteúdo" mostra contadores de chamadas de todos os endpoints públicos do site em diferentes períodos — 1 hora, 24 horas, 7 dias.

O que mostra​

  • Lista de todos os endpoints públicos (GET /api/content/...) — é gerada automaticamente, não é necessário preenchê-la manualmente.
  • Contador ao lado de cada endpoint — quantas vezes foi chamado no período selecionado.

Elementos da interface​

  • Período — lista suspensa de períodos: Última Hora / Últimas 24 Horas / Últimos 7 Dias (por padrão — Últimas 24 Horas).
  • Atualizar — botão para forçar a atualização dos dados.

Os dados são apresentados em uma tabela com quatro colunas:

ColunaO que significa
Caminhocaminho do endpoint (/api/content/...)
Métodométodo HTTP (GET, POST, …)
Descriçãobreve descrição do endpoint
Chamadasnúmero de chamadas no período selecionado

No topo da página, é exibido um banner informativo Limpeza automática não aplicável: as estatísticas são lidas em tempo real e não são armazenadas no projeto, portanto, não é necessário limpá-las, e o período de armazenamento dos dados na administração não é configurável.

Métrica temporariamente indisponível

Se os dados das estatísticas estiverem temporariamente indisponíveis, um aviso "Métrica temporariamente indisponível. Todos os endpoints são exibidos com contagem zero." aparecerá acima da tabela. Apesar do texto do aviso, a tabela pode estar vazia — com a mensagem "Nenhum dado disponível".

Período de armazenamento das estatísticas

As estatísticas são armazenadas por um tempo limitado, e o período de armazenamento na administração não é configurável. Para análise por um período mais longo, salve os dados por conta própria. O banner informativo no topo da página alerta sobre isso.

Para que serve​

Através das estatísticas, é possível ver quais endpoints da API de Conteúdo estão sendo utilizados e quais não estão sendo chamados. Uma queda acentuada no número de chamadas de um endpoint geralmente indica um problema no aplicativo cliente.

Frequência de atualização

Os dados são atualizados não mais que uma vez por minuto: pressionar Atualizar novamente dentro de 60 segundos mostrará os mesmos valores.

Erros da API de Conteúdo​

A aba "Erros da API de Conteúdo" mostra todas as respostas 4xx/5xx que a API pública retornou durante um período. Desenvolvedores que integram o aplicativo cliente com a API de Conteúdo podem ver os erros de suas solicitações diretamente na administração.

O que mostra​

Cada registro é um erro HTTP separado. A tabela consiste em cinco colunas:

ColunaO que significa
Horatimestamp do erro
Statusstatus HTTP (4xx / 5xx)
Métodométodo da solicitação (GET, POST, …)
Caminhocaminho (/api/content/...)
Mensagemtexto do erro

Se não houver erros no período selecionado, em vez da tabela, será exibida a mensagem "Nenhum erro registrado para o período selecionado".

Clicar em uma linha da tabela abre uma janela com detalhes do erro:

  • hora, status HTTP, método e caminho da solicitação;
  • código e texto do erro;
  • stack trace — expandido (até 8 KB);
  • identificador da solicitação e número de série do app-token com o qual a solicitação foi feita;
  • endereço IP e User-Agent do cliente;
  • Query — parâmetros da string de consulta;
  • pré-visualização do corpo da solicitação (sem segredos — senhas, tokens, cabeçalhos de autorização estão mascarados).

Filtros​

  • De / até — período (campos de entrada de data com calendário).
  • Status HTTP — lista suspensa de status. É possível escolher um grupo (4xx - Lado do Cliente, 5xx - Lado do Servidor) ou um código específico: 400, 401, 403, 404, 422, 500, 502, 503.
  • Caminho — campo de texto para filtrar pelo caminho (por exemplo, /api/content/blocks/*).

Botão "Excluir dados"​

Exclui registros de erros para o período definido pelos campos De / Até. Se o período não for definido — exclui todos os erros.

Segurança — ocultação de dados sensíveis​

Dados sensíveis nos registros de erros são ocultados automaticamente. Os campos password, token, authorization, api_key, x-app-token, cookie, set-cookie (sem distinção de maiúsculas e minúsculas) são substituídos por ***. Corpos grandes de solicitações são cortados para 2 KB.

Limpeza de registros manualmente​

Os registros são limpos manualmente — em cada aba que armazena registros, há um botão "Excluir dados":

AbaO que exclui
Registro de ações do adminregistros de ações do admin para o período selecionado
Tráfego dos administradoressomente fechadas sessões para o período selecionado
Erros da API de Conteúdoregistros de erros para o período selecionado

O período de exclusão é definido pelos campos De / Até nos filtros da aba. Se o período não for definido — todos os registros do tipo correspondente são excluídos. Antes da exclusão, sempre é exibida uma caixa de diálogo de confirmação "Confirmar ação", a operação é irreversível.

Sessões ativas não são afetadas

O botão "Excluir dados" na aba "Tráfego dos administradores" não exclui sessões ativas dos administradores — mesmo que um período que sobreponha o momento atual seja definido, a sessão aberta de um colega em funcionamento não será excluída. Somente sessões fechadas são excluídas.

A aba 'Estatísticas da API de Conteúdo' não tem limpeza

Os dados das estatísticas são lidos em tempo real e não são armazenados no projeto, portanto, não há botão "Excluir dados" nesta aba — isso é informado pelo banner "Limpeza automática não aplicável".

Permissões para o registro​

As abas Estatísticas da API de Conteúdo e Erros da API de Conteúdo estão disponíveis sob permissões separadas em árvore de permissões (abre em uma nova aba). Sem a permissão, a aba não é exibida.

AbaPermissão
Estatísticas da API de Conteúdojournal.viewContentApiStats
Erros da API de Conteúdojournal.viewContentApiErrors

As abas "Registro de ações do admin" e "Tráfego dos administradores" são visíveis para todos os administradores que têm acesso ao módulo de registro.