Histórico da Página
...
Nota | ||
---|---|---|
| ||
Para acessar o Monitor as APIs de Monitoramento de Serviços do fluig, deve-se obrigatoriamente realizar autenticação com o usuário "wcmadmin". Caso o acesso ao monitor seja feito 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/monitor/report |
...
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ção são úteis para monitorar desenvolvimentos sobre a plataforma para evoluí-los. O acesso aos relatórios pode ser feito através de uma API REST (que retorna um JSON) e via JMX. Primeiramente vamos resumir cada um dos serviços monitorados.
Serviços Monitorados
Abaixo a relação do nome 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. Alguns serviços podem receber parâmetros, falaremos mais sobre seu uso nos próximos itens.
...
API Monitor
Para acompanhar os serviços listados abaixo, altere a URL do fluig no navegador pela apresentada a seguir:
...
Bloco de código | ||
---|---|---|
|
[protocolo]://[host fluig]/monitoring/api/v1/monitor/report/<parâmetro> |
apresenta o status atual do serviço.
GRUPO | PARÂMETRO | DESCRIÇÃO | <parametro>|
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 navegador pela apresentada a seguir:
Bloco de código | ||
---|---|---|
| ||
[protocolo]://[host fluig]/monitoring/api/v1/statistics/report/<parâmetro> |
a checagem é feita a cada 5 min e não em tempo real.
GRUPO | PARÂMETRO | DESCRIÇÃO | <parametro>|
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 fluig. | ||
DATABASE_TRAFFIC | Indica o tráfego de envio e de recebimento da base de dados utilizada pelo fluig. 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/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. | |
LICENSE_SERVER_TOTAL_USER | |||
LICENSE_SERVER_USER_AVAILABLE | |||
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 no diretório de instalação do fluig, pasta em [Instalação fluig]/appserver/domain/servers/<fluig server>/log, para obter informações detalhadas do erro ocorrido. |
...
Método | URL | Explicação |
---|---|---|
GET | http://<host>/monitoring/api/v1/monitor/report | Retorna o relatório consolidado de todos os monitores citado acima, sem uso de parâmetros. |
http://<host>/monitoring/api/v1/ statistics/report | ||
GET | http://<host>/monitoring/api/v1/monitor/report/[PARÂMETRO] | Retorna o relatório para um serviço recurso em específico. O parâmetro deve ser escrito em maiúsculo. |
http://<host>/monitoring/api/v1/ statistics/report/[PARÂMETRO] |
...