Serviço de monitoramento - métricas

O serviço de monitoramento do TOTVS | Application Server irá disponibilizar todas as métricas através de api REST.

O monitor do TOTVS | Application Server passa fornecer funcionalidades que poderão ser acessadas de forma remota.

Métricas disponíveis:

• all (retorna informação de todas as métricas)

• à partir da release: 19.3.0.5 do TOTVS | Application Server:
  • memory_resident
  • memory_virtual
  • memory_ram_total
  • memory_ram_free
  • memory_ram_used
  • memory_swap_total
  • memory_swap_used
  • memory_swap_free
  • startdate

Obs. A descrição e o contudo de cada métrica pode ser obtido a partir da relação de métricas em Métricas.

Para verificar as formas de uso e a lista com todas as métricas, pode ser feita uma chamada "GET" para a URN /[api_path]/appserver/metrics

[protocolo]://[servidor]:[porta]/[api_path]/appserver/metrics

Ex:
https://localhost:32033/api/appserver/metrics

{"option1":"/api/appserver/metrics/{metric}"
,"option2":"/api/appserver/metrics?{metric}"
,"option3":"/api/appserver/metrics?{metric1}&{metric2}"
,"option4":"/api/appserver/metrics?{metric1}&{metric2}...&{metricN}"
,"metrics":[
"all",
{"names":["memory_resident", "memory_virtual", "memory_ram_total", "memory_ram_free", "memory_ram_used", "memory_swap_total", "memory_swap_used", "memory_swap_free", "startdate"]}]}

Obs 1. Consulte o api_path, a porta e as configurações de protocolo (http ou https).

Para verificar uma métrica específica pode ser feita uma chamada "GET" para a URN /[api_path]/appserver/metrics/all ou /[api_path]/appserver/metrics?all

[protocolo]://[servidor]:[porta]/[api_path]/appserver/metrics/all

ou

[protocolo]://[servidor]:[porta]/[api_path]/appserver/metrics?all

Ex:

https://localhost:32033/api/appserver/metrics?all

[{"version":0, "metrics":[{"name":"memory_resident", "description":"Resident Memory Usage", "collected_in":"15/06/2020 20:24:09.368", "unit":"kb", "value":712200}, {"name":"memory_virtual", "description":"Virtual Memory Usage", "collected_in":"15/06/2020 20:24:09.368", "unit":"kb", "value":5109612}, {"name":"memory_ram_total", "description":"Memory Ram Total", "collected_in":"15/06/2020 20:24:09.368", "unit":"kb", "value":16733232}, {"name":"memory_ram_free", "description":"Memory Ram Free (Available to Use)", "collected_in":"15/06/2020 20:24:09.368", "unit":"kb", "value":3983900}, {"name":"memory_ram_used", "description":"Memory Ram Usage", "collected_in":"15/06/2020 20:24:09.368", "unit":"kb", "value":12749332}, {"name":"memory_swap_total", "description":"Page File Total", "collected_in":"15/06/2020 20:24:09.368", "unit":"kb", "value":38753328}, {"name":"memory_swap_used", "description":"Page File Used", "collected_in":"15/06/2020 20:24:09.368", "unit":"kb", "value":23091660}, {"name":"memory_swap_free", "description":"Page File Free (Available to Use)", "collected_in":"15/06/2020 20:24:09.368", "unit":"kb", "value":15661668}, {"name":"startdate", "description":"Date when the system was started", "collected_in":"15/06/2020 17:36:53.003", "value":"15/06/2020 17:36:53"}]}]

Obs 1. Consulte o api_path, a porta e as configurações de protocolo (http ou https).

Para verificar uma métrica específica pode ser feita uma chamada "GET" para a URN /[api_path]/appserver/metrics/{métrica} ou /[api_path]/appserver/metrics?{métrica}

[protocolo]://[servidor]:[porta]/[api_path]/appserver/metrics/{métrica}

ou

[protocolo]://[servidor]:[porta]/[api_path]/appserver/metrics?{métrica}

Ex:

https://localhost:32033/api/appserver/metrics?memory_ram_used

[{"version":0, "metrics":[{"name":"memory_ram_used", "description":"Memory Ram Usage", "collected_in":"15/06/2020 18:13:37.599", "unit":"kb", "value":11977484}]}]

Obs 1. Consulte o api_path, a porta e as configurações de protocolo (http ou https).

Para verificar múltiplas métricas pode ser feita uma chamada "GET" para a URN /[api_path]/appserver/metrics?{métrica 1}&{métrica 2}...&{métrica N} 

[protocolo]://[servidor]:[porta]/[api_path]/appserver/metrics?{métrica 1}&{métrica 2}...&{métrica N}

Ex:

https://localhost:32033/api/appserver/metrics?memory_ram_used&memory_ram_free

[{"version":0, "metrics":[{"name":"memory_ram_used", "description":"Memory Ram Usage", "collected_in":"15/06/2020 19:16:22.504", "unit":"kb", "value":12574904}, {"name":"memory_ram_free", "description":"Memory Ram Free (Available to Use)", "collected_in":"15/06/2020 19:16:22.504", "unit":"kb", "value":4158328}]}]

Obs 1. Consulte o api_path, a porta e as configurações de protocolo (http ou https).

Obs 2. Se em alguma das métricas for passada a informação de obtenção de todas (all), todos os pedidos específicos de métricas na URN serão ignorados e será enviada a informação com todas as métricas válidas.

Se for solicitada uma métrica inválida será retornada uma informação de falha ("error").

[protocolo]://[servidor]:[porta]/[api_path]/appserver/metrics?{métrica invalida}

Ex:

https://localhost:32033/api/appserver/metrics?metrica_invalida

[{"version":0, "metrics":[{"name":"metrica_invalida", "error":"invalid metric", "collected_in":"15/06/2020 20:06:02.351"}]}]

Obs 1. Consulte o api_path, a porta e as configurações de protocolo (http ou https).

Deve ser verificado na Seção [APP_MONITOR] em qual a porta está habilitado o servidor de monitoramento, assim como as configurações de protocolo de criptografia (SSL) e o path.

Consulte os valores padrão das chaves Chaves Seção [APP_MONITOR].