Histórico da Página
| Informações | ||
|---|---|---|
| ||
Esta página foi revisada para considerar as configurações da atualização é destinada para atualizações 1.6.2 e superiores . Caso possua uma atualização 1.6.0 à 1.6.1, acesse: Como faço para instalar e utilizar o Monitor de Serviços do fluig 1.6.0 ao 1.6.1? Para atualizações 1.5.13 e inferiores, acesse: Como instalar e utilizar o Monitor de Serviços fluig na atualização 1.5.13 e inferiores? do TOTVS Fluig Plataforma. |
Índice
| Índice | ||||||
|---|---|---|---|---|---|---|
|
Objetivo
...
O objetivo deste guia é explicar como obter informações de monitoramento de serviços do fluigda plataforma. Estas APIs permitem que clientes monitorem e realizem consultas de diversos relatórios referente a serviços consumidos pelo fluigpela plataforma.
Pré-requisitos
...
Para que se tenha uma compreensão completa destas informações, alguns conhecimentos são considerados pré-requisitos, entre eles:
- Visão geral sobre o fluiga plataforma TOTVS Fluig
| Nota | ||
|---|---|---|
| ||
Para acessar as APIs de Monitoramento de Serviços do fluig, deve-se realizar autenticação com um usuário administrador ou com o usuário "wcmadmin". |
Funcionamento
...
O módulo de monitoramento permite a consulta de uma série de relatórios referente a serviços em uso pelo fluig. Estas informações são úteis para monitorar desenvolvimentos sobre a plataforma para evoluí-los. O acesso aos relatórios pode ser feito através de API REST (que retorna um JSON) e via JMX.
Balanceamento de carga e alta disponibilidade - Cluster
...
Em um ambiente de alta disponibilidade com autenticação integrada, a autenticação do wcmadmin deve ser realizada através do endereço: [protocolo]://[endereço_ip]:[porta]/portal/home?dologin. Em seguida acessar a URL: http://[servidor_fluig]:[porta]/monitoring/api/v1/monitors/report.
Em ambientes com balanceamento de carga, o monitoramento deverá ser realizado em cada nó. Isso significa que, não é possível consultar em um nó e obter o resultado dos demais no mesmo retorno.
Serviços monitorados
...
Os monitores podem ser observados através de duas consultas REST diferentes. Você pode consultar diretamente o monitoramento que desejar incluindo o parâmetro na URL. Abaixo são apresentados as APIs com a relação de nomes e parâmetros de todos os monitores e seus serviços monitorados.
API monitors
...
Para acompanhar os serviços listados abaixo, altere a URL do fluig no da plataforma no navegador pela apresentada a seguir. Os resultados apresentam o status atual dos serviços.
| Bloco de código | ||
|---|---|---|
| ||
[protocolo]://[host fluig]/monitoring/api/v1/monitors/report/<parâmetro> |
| GRUPO | PARÂMETRO | DESCRIÇÃO |
Analytics | ANALYTICS_AVAIABILITY | Indica a disponibilidade do fluig Analytics (http://analytics.fluig.com/). |
Cache | CACHE_AVAIABILITY | Indica a disponibilidade do servidor de cache. |
| Misc | LICENSE_SERVER_AVAILABILITY | Indica se o servidor de licenças está disponível. |
| MAIL_SERVER_AVAILABILITY | Envia um e-mail de teste para [email protected], para indicar a disponibilidade do serviço de e-mails. | |
| OPEN_OFFICE_AVAILABILITY | Indica se o servidor do OpenOffice está ativo. | |
| SOLR_SERVER_AVAILABILITY | Indica se o servidor do Solr está ativo. | |
| MS_OFFICE_AVAILABILITY | Indica se o Office está instalado e ativo no servidor. | |
| VIEWER_AVAILABILITY | Indica se o Viewer está configurado. | |
Realtime | REAL_TIME_AVAILABILITY | Retorna se o NodeJS encontra acessível. |
API statistics
...
Para acompanhar os serviços listados abaixo, altere a URL do fluig no da plataforma no navegador pela apresentada a seguir. É importante mencionar que os resultados não são monitorados em tempo real e sim checados a cada 5 minutos.
| Bloco de código | ||
|---|---|---|
| ||
[protocolo]://[host fluig]/monitoring/api/v1/statistics/report/<parâmetro> |
| GRUPO | PARÂMETRO | DESCRIÇÃO | ||||
Database | DATA_SOURCE_FLUIGDS | Retorna o tamanho do pool de conexões para o datasource transacionado. | ||||
| DATA_SOURCE_FLUIGDSRO | Retorna o tamanho do pool de conexões para o datasource somente de leitura sem transação. | |||||
| DATABASE_SIZE | Indica o tamanho total da base de dados utilizada pelo fluigpela plataforma. | |||||
| DATABASE_TRAFFIC | Indica o tráfego de envio e de recebimento da base de dados utilizada pelo fluigpela plataforma. Só para MySQL. | |||||
| DATABASE_INFO | Retorna dados sobre o nome e versão do banco de dados e do driver de conexão e versão do drive. | |||||
Filesystem | ARTIFACTS_APPS_DIR | Retorna a relação de arquivos implantados no [diretório fluig_instalação]/appserver/apps com suas respectivas Hash MD5. | ||||
| LOG_DIR_SIZE_MONITOR | Indica o tamanho do diretório de logs do servidor. | |||||
| ROOT_FILE_SYSTEMS | Retorna as raízes de montagem do filesystem com seus respectivos tamanhos em bytes. | |||||
| TEMPLATE_DIR_SIZE | Indica o tamanho do diretório de templates. | |||||
VOLUME_DIR_SIZE | Indica o tamanho do diretório de volume. | |||||
| TEMPORARY_DIR_SIZE | Indica o tamanho do diretório temporário do servidor. | |||||
| ||||||
JVM | RUNTIME | Retorna a hora de início e o tempo que está em execução. | ||||
| THREADING | Retorna o número de threads em execução, pico e quantidade iniciadas. | |||||
Memory | DETAILED_MEMORY | Retorna a relação de memórias da JVM, com tipo, total alocado, total comprometido e máximo. | ||||
| MEMORY | Retorna o total de memória heap e non-heap alocados. | |||||
| Cache | CACHE_CONFIGURATION | Indica se a configuração do endereço do servidor de cache está definida para algo diferente de "LOCAL_MAP". | ||||
Misc | EXTERNAL_CONVERTER | Indica se conversor interno de documentos está ativo. | ||||
Users | CONNECTED_USERS | Indica o número de sessões de usuários ativas no portal. Este número não corresponde necessariamente ao número de usuários autenticados na plataforma. | ||||
| Nota | ||
|---|---|---|
| ||
Sempre que um monitor retornar FAILURE é possível acessar o arquivo server.log, armazenado em [Instalação fluigdiretório_instalação]/appserver/domain/servers/<fluig server>/log, para obter informações detalhadas do erro ocorrido. |
Acesso REST
...
Para acessar os serviços via interface REST existem duas formas:
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas