Í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 fluig, além de fornecer um acesso via Web aos dados publicados via JMX.pela 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 a plataforma TOTVS Fluig

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

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ção 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. Primeiramente vamos resumir cada um dos 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.

[protocolo]://[host fluig]/monitoring/api/v1/monitormonitors/report/<parâmetro>

apresenta o status atual do serviço.

...

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.

[protocolo]://[host fluig]/monitoring/api/v1/statistics/report/<parâmetro>

...

Acesso REST

...

Para acessar os serviços via interface REST existem duas formas:

Onde:

• [PARÂMETRO] = Nome do monitoramento.
• Os retornos sempre são Strings.
  

Deck of Cards
id Acesso REST
Image Removed Exemplo de consulta parametrizada. Card label Exemplo de consulta consolidada Image Removed Image Added Figura 1 - Exemplo de consulta consolidada. Card label Exemplo de consulta parametrizada

Acesso JMX

@MXBean
public interface FluigServiceMonitor {
    /**
     * 
     * Generates the report for this monitor with given parameters. The parameter syntax is:
     * 
     * paramenterName1=value1 parameterName2=value2
     * 
     * Example: "tenantId=10 forceSearch=true maxResults=15"
     * 
     * @param parameter for the monitor report
     * @return report result
     * @throws UnsupportedOperationException if this monitor doesn't support parameters.
     */
    String report(String parameter) throws UnsupportedOperationException;
    /**
     * Generates the report for this monitor.
     * 
     * @return report result.
     */
    String report();
    /**
     * Returns the name of this monitor, usually the class name without the "Monitor" suffix
     * 
     * @return name of this monitor.
     */
    String getName();
}

com.fluig.monitor.jmx.bean:type=ConnectedUsersMonitor

Acesso Web JMX

Para acessar o JMX Mini Console via web, basta abrir o navegador na seguinte URL: http://<fluig>/monitor/jmxconsole/ (lembrar de incluir uma barra no final).

Image Removed

Exemplo de acesso aos JMX Beans através do mini console Web.

Onde: FAILURE: Falha na resposta do serviço; NONE: Não foi utilizado até o momento; OK: Em funcionamento e/ou ativado. Card label Exemplo de consulta parametrizada Image Added Figura 2 - Exemplo de consulta parametrizada

...