Mudanças entre as edições de "Página de Saúde"

De Manuais de Sistemas
Ir para: navegação, pesquisa
(Visualizar Status de Sistema)
(Autenticação)
 
(14 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 5: Linha 5:
 
  Exemplo: https://rails-appref:8092/login (Link da Aplicação de Referência em Produção), ficaria da seguinte forma (https://rails-appref:8092'''/saude/''')
 
  Exemplo: https://rails-appref:8092/login (Link da Aplicação de Referência em Produção), ficaria da seguinte forma (https://rails-appref:8092'''/saude/''')
 
   
 
   
A funcionalidade pode ser acessada por qualquer usuário '''(Não necessita Autenticação)'''
+
A funcionalidade pode ser acessada por qualquer usuário '''(Não necessita Autenticação).'''
  
 
== Visualizar Status de Sistema ==
 
== Visualizar Status de Sistema ==
Linha 14: Linha 14:
 
[[Arquivo:Paginasaudeusuarionaologado.png |880px]]
 
[[Arquivo:Paginasaudeusuarionaologado.png |880px]]
  
Já imagem abaixo, é mostrado como é exibido para o usuário logado a página de saúde.
+
 
 +
na imagem abaixo, é mostrado como é exibido para o usuário logado a página de saúde.
  
 
[[Arquivo:Paginasaudeusuariologado.png |880px]]
 
[[Arquivo:Paginasaudeusuariologado.png |880px]]
Linha 22: Linha 23:
 
'''1. Tipo de Serviço:''' Exibe que serviço está sendo checado. A Gem deverá buscar nos arquivos properties.yml e database.yml pelas tags que declaram o serviço.
 
'''1. Tipo de Serviço:''' Exibe que serviço está sendo checado. A Gem deverá buscar nos arquivos properties.yml e database.yml pelas tags que declaram o serviço.
  
'''2. Status:''' Exibe o estado do serviço. Pode ser "Ativo", "Testando..." ou "Inativo".
+
'''2. Nome:''' Exibe o nome do serviço que está sendo monitorado. A Gem deverá buscar nos arquivos properties.yml e database.yml pelas tags referentes aos nomes dos serviços monitorados.
  
'''3. Resposta:''' Exibe o código da resposta do serviço quando a página for exibida, ou quando clicar no botão "Atualizar" da coluna "Ações". O campo poderá retornar um código HTTP ou retornar algum possível erro do sistema de forma tratada.
+
'''3. Endereço:''' Contém a URL do serviço. O conteúdo da coluna somente é exibida se for realizado login na página de saúde.
  
'''4. Última verificação:''' Exibe a data (No formato dd/mm/aaaa - hh:mm:ss) em que houve a última checagem pela Gem referente à página/serviço.
+
'''4. Descrição:''' Contém a descrição do serviço. Esta descrição estará localizada no arquivo properties.yml (ou no database.yml, caso se trate de uma base de dados). O conteúdo da coluna somente é exibida se for realizado login na página de saúde.
  
'''5. Ações:''' Coluna que contém o botão '''Atualizar''' para verificar os serviços novamente.
+
'''5. Status:''' Exibe o estado do serviço. Pode ser "Ativo", "Testando..." ou "Inativo".
 +
 
 +
'''6. Resposta:''' Exibe o código da resposta do serviço quando a página for exibida, ou quando clicar no botão "Atualizar" da coluna "Ações". O campo poderá retornar um código HTTP ou retornar algum possível erro do sistema de forma tratada.
 +
 
 +
'''7. Última verificação:''' Exibe a data (No formato dd/mm/aaaa - hh:mm:ss) em que houve a última checagem pela Gem referente à página/serviço.
 +
 
 +
'''8. Ações:''' Coluna que contém o botão '''Atualizar''' para verificar os serviços novamente.
  
 
=== Autenticação ===
 
=== Autenticação ===
  
Para visualizar o conteúdo das colunas ocultas, é necessário fazer uma autenticação na página, esse login é realizado através do botão [[Arquivo:BotaoAutenticar.png]]
+
Para visualizar o conteúdo das colunas ocultas (Nome, Endereço, Descrição), é necessário fazer uma autenticação na página, esse login é realizado através do botão [[Arquivo:Apphealth_entrar.PNG]]
 
 
Para realizar o login na aplicação, é necessário um cadastro prévio no sistema SAA - Sistema de Autenticação e Autorização. Ao ser efetivado o acesso o sistema deve revelar o conteúdo oculto.
 
  
Após logado, o botão [[Arquivo:BotaoAutenticar.png]] desaparece, dando lugar ao botão [[Arquivo:BotaoSair.png]], para que o usuário consiga deslogar.
+
Para realizar o login na aplicação, é necessário um cadastro prévio no sistema SAA - Sistema de Autenticação e Autorização. Havendo impedimento no login relacionados a usuário/senha, permissão deve-se verificar no sistema SAA. A permissão no SAA deve ser aplicada para o sistema TJCE App Health e permitirá a visualização da página de saúde de todos os sistemas.
  
'''SAA Indisponível'''
 
  
Em raras exceções, o serviço fornecido pelo SAA pode estar indisponível, ainda que o usuário tenha fornecido dados válidos. Nesse caso, será exibido para o usuário a seguinte mensagem: Um ou mais serviços do SAA estão indisponíveis! Os mesmos devem ser normalizados para que o login possa ser efetuado.
+
Após logado, o botão [[Arquivo:Apphealth_entrar.PNG]] desaparece, dando lugar ao botão [[Arquivo:Apphealth_sair.PNG]], para que o usuário consiga deslogar.

Edição atual tal como às 18h27min de 15 de fevereiro de 2021

Como acessar essa funcionalidade?

A Funcionalidade é acessada ao ser digitado /saúde/ no final do link do ambiente do sistema.

Exemplo: https://rails-appref:8092/login (Link da Aplicação de Referência em Produção), ficaria da seguinte forma (https://rails-appref:8092/saude/)

A funcionalidade pode ser acessada por qualquer usuário (Não necessita Autenticação).

Visualizar Status de Sistema

Funcionalidade interna responsável pela exibição dos status dos serviços da aplicação. Na imagem abaixo, é mostrado como é exibido para o usuário não logado a página de saúde.

Paginasaudeusuarionaologado.png


Já na imagem abaixo, é mostrado como é exibido para o usuário logado a página de saúde.

Paginasaudeusuariologado.png

Detalhamento das Colunas

1. Tipo de Serviço: Exibe que serviço está sendo checado. A Gem deverá buscar nos arquivos properties.yml e database.yml pelas tags que declaram o serviço.

2. Nome: Exibe o nome do serviço que está sendo monitorado. A Gem deverá buscar nos arquivos properties.yml e database.yml pelas tags referentes aos nomes dos serviços monitorados.

3. Endereço: Contém a URL do serviço. O conteúdo da coluna somente é exibida se for realizado login na página de saúde.

4. Descrição: Contém a descrição do serviço. Esta descrição estará localizada no arquivo properties.yml (ou no database.yml, caso se trate de uma base de dados). O conteúdo da coluna somente é exibida se for realizado login na página de saúde.

5. Status: Exibe o estado do serviço. Pode ser "Ativo", "Testando..." ou "Inativo".

6. Resposta: Exibe o código da resposta do serviço quando a página for exibida, ou quando clicar no botão "Atualizar" da coluna "Ações". O campo poderá retornar um código HTTP ou retornar algum possível erro do sistema de forma tratada.

7. Última verificação: Exibe a data (No formato dd/mm/aaaa - hh:mm:ss) em que houve a última checagem pela Gem referente à página/serviço.

8. Ações: Coluna que contém o botão Atualizar para verificar os serviços novamente.

Autenticação

Para visualizar o conteúdo das colunas ocultas (Nome, Endereço, Descrição), é necessário fazer uma autenticação na página, esse login é realizado através do botão Apphealth entrar.PNG

Para realizar o login na aplicação, é necessário um cadastro prévio no sistema SAA - Sistema de Autenticação e Autorização. Havendo impedimento no login relacionados a usuário/senha, permissão deve-se verificar no sistema SAA. A permissão no SAA deve ser aplicada para o sistema TJCE App Health e permitirá a visualização da página de saúde de todos os sistemas.


Após logado, o botão Apphealth entrar.PNG desaparece, dando lugar ao botão Apphealth sair.PNG, para que o usuário consiga deslogar.