LICENSE_addMetric

Registra em memória o conteúdo de uma métrica que posteriormente é enviada para o License Server.

Todas as métricas registradas em memória durante o processamento de uma rotina são posteriormente agrupadas e enviadas para o License Server de forma automática no ato em que a thread de execução no AppServer para, a aplicação é finalizada, sem necessidade de nova ação do programa para realizar o envio para o LS (License Server).

Sintaxe

_ADVPL_LICENSE_addMetric( < cSubroutine>, < cMetricId >, < uValueMetric >, [ < nLaptimeSubRoutine > ], [ < cRoutine > ] ) => SMALLINT

Parâmetros

Nome	Tipo	Obrigatório?	Descrição
cSubroutine	`CHAR`	Sim	Nome da subrotina de controle de métrica.
cMetricId	`CHAR`	Sim	Código de identificação da métrica de controle.
uValueMetric	INDEFINIDO	Sim	Valor da métrica. Este valor pode ser CHAR, DECIMAL, DATE, NUMBER de acordo como foi definido o tipo do valor para a respectiva métrica.
nLapTimeSubRoutine	`NUMBER`	Não	Tempo de uso da métrica (em segundos). Este parâmetro é opcional, portanto, veja o código de exemplo abaixo para saber como ele pode ser informado.
cRoutine	`CHAR`	Não	Nome da programa/rotina para controle de métrica. Este parâmetro é opcional, portanto, quando não informado, assumirá o nome do fonte/programa que invocou a funcao LICENSE_addMetric(). Quando informado, obrigatoriamente o parâmetro anterior nLapTimeSubRoutine precisará ser informado, podendo ser o valor NULL, para ser ignorado na adição de métricas.

Retorno

Tipo

Descrição

SMALLINT

Indica se a métrica foi adicionada com sucesso para ser posteriormente enviada para o License Server.

TRUE ou 1 - Métrica adicionada com sucesso

FALSE ou 0 - Falha ao adicionar a métrica.

Exemplo

#---------------------------------#
 FUNCTION license_addmetric_test()
#---------------------------------#
   #Iniciar o cronometro de tempo de uso da metrica "metrica103" para posterior registro do tempo final de uso ao adicionar a métrica.
   CALL LOG_ElapsedTimeStart("metrica103")

   #Registrando a métrica METRICA0101 para a SUBROTINA01, com o valor 100.
   #Neste caso não existe definição do tempo de uso para registro na métrica, visto que se trata de uma informação opcional,
   CALL _ADVPL_LICENSE_addMetric('subrotina01','metrica0101',100)
 
   #Registrando a métrica METRICA0103 para a SUBROTINA01, com o valor 250 e tempo de uso (em segundos) é retornado pela funcao LOG_ElapsedTimeFinish().
   CALL _ADVPL_LICENSE_addMetric('subrotina01','metrica0103',250,LOG_ElapsedTimeFinish("metrica103"))
 END FUNCTION

Informações

Fontes: llicenseserver.prw

Veja também

LOG_ElapsedTimeStart

LOG_ElapsedTimeFinish

Páginas filhas