TOTVSTEC

Árvore de páginas

Retorna um objeto Json com as métricas coletadas pelo sistema.

Sintaxe

MetricsRead( [ Metric_Name ] )

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

Metric_Name

vetor

Quando informado, filtra objeto de saída inserindo apenas as métricas que contem os nomes informados.



Retorno

Nome

Tipo

Descrição

cRet

caractere

Retorna uma string, no formato json, com as métricas coletadas.

Observações

  • Se for informado alguma métrica com nome inválido no filtro. No objeto de saída será inserido a métrica com nome inválido informado com a propriedade error contendo a descrição do erro.

Exemplos

User Function exemplo()
cRet := ""
Local FilterOne := {"memory_swap_total"}
Local FilterEmpty :={}
Local FilterInvalid :={"InvalidMetric"}
Local FilterTwo :={"memory_swap_total", "startdate"}

cRet := MetricsRead(FilterOne)
Conout(cRet)
//Imprime : [{"version":0,"metrics":[{"name":"memory_swap_total","description":"Page File Total","collected_in":"25/05/2020 15:14:14.612","unit":"kb","value":23467676}]}]

cRet := MetricsRead(FilterTwo)
Conout(cRet)
//Imprime: [{"version":0,"metrics":[{"name":"memory_swap_total","description":"Page File Total","collected_in":"27/05/2020 12:27:22.236","unit":"kb","value":23467676},{"name":"startdate","description":"Date when the system was started","collected_in":"27/05/2020 12:26:57.836","value":"27/05/2020 12:26:57"}]}]

cRet := MetricsRead()
Conout(cRet)
//Imprime: [{"version":0,"metrics":[{"name":"memory_resident","description":"Resident Memory Usage","collected_in":"25/05/2020 15:14:38.979","unit":"kb","value":967760},{"name":"memory_virtual","description":"Virtual Memory Usage","collected_in":"25/05/2020 15:14:38.979","unit":"kb","value":5386272},{"name":"memory_ram_total","description":"Memory Ram Total","collected_in":"25/05/2020 15:14:38.979","unit":"kb","value":16554132},{"name":"memory_ram_free","description":"Memory Ram Free (Available to Use)","collected_in":"25/05/2020 15:14:38.979","unit":"kb","value":8270660},{"name":"memory_ram_used","description":"Memory Ram Usage","collected_in":"25/05/2020 15:14:38.979","unit":"kb","value":8283472},{"name":"memory_swap_total","description":"Page File Total","collected_in":"25/05/2020 15:14:38.979","unit":"kb","value":23467676},{"name":"memory_swap_used","description":"Page File Used","collected_in":"25/05/2020 15:14:38.979","unit":"kb","value":15027124},{"name":"memory_swap_free","description":"Page File Free (Available to Use)","collected_in":"25/05/2020 15:14:38.979","unit":"kb","value":8440552},{"name":"startdate","description":"Date when the system was started","collected_in":"25/05/2020 14:23:28.397","value":"25/05/2020 14:23:28"}]}]
 
cRet := MetricsRead(FilterEmpty)
Conout(cRet)
//Imprime: [{"version":0,"metrics":[]}]

cRet := MetricsRead(FilterInvalid)
Conout(cRet)
//Imprime: [{"version":0,"metrics":[{"name":"InvalidMetric","error":"invalid metric","collected_in":"04/06/2020 10:47:57.588"}]}]

Return

Abrangência

Disponível no AppServer a partir da build 19.3.0.5

Veja também

  • Sem rótulos