BotTelemetryClient Interface

Pacote:

com.microsoft.bot.builder

Artefato Maven:

com.microsoft.bot:bot-builder:4.14.3

public interface BotTelemetryClient

Cliente de registro em log para a Telemetria do Bot.

Resumo do método

Modificador e tipo	Método e descrição
abstract void	flush() Libera o buffer na memória e todas as métricas que estão sendo pré-agregadas.
default void	trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success) Envie informações sobre a disponibilidade de um aplicativo.
abstract void	trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success, String message, Map<String,String> properties, Map<String,Double> metrics) Envie informações sobre a disponibilidade de um aplicativo.
abstract void	trackDependency(String dependencyTypeName, String target, String dependencyName, String data, OffsetDateTime startTime, Duration duration, String resultCode, boolean success) Envie informações sobre uma dependência externa (chamada de saída) no aplicativo.
abstract void	trackDialogView(String dialogName, Map<String,String> properties, Map<String,Double> metrics) Registre um modo de exibição de caixa de diálogousando o método TrackPageView no Cliente de TelemetriaIBotse o Cliente de Telemetriade Exibiçãode PáginaIBottiver sido implementado.
default void	trackEvent(String eventName) Registra eventos personalizados com campos nomeados extensíveis.
default void	trackEvent(String eventName, Map<String,String> properties) Registra eventos personalizados com campos nomeados extensíveis.
abstract void	trackEvent(String eventName, Map<String,String> properties, Map<String,Double> metrics) Registra eventos personalizados com campos nomeados extensíveis.
default void	trackException(Exception exception) Registra em log uma exceção do sistema.
abstract void	trackException(Exception exception, Map<String,String> properties, Map<String,Double> metrics) Registra em log uma exceção do sistema.
abstract void	trackTrace(String message, Severity severityLevel, Map<String,String> properties) Envie uma mensagem de rastreamento.

Detalhes do método

flush

public abstract void flush()

Libera o buffer na memória e todas as métricas que estão sendo pré-agregadas.

trackAvailability

public default void trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success)

Envie informações sobre a disponibilidade de um aplicativo.

Parameters:

name - Nome do teste de disponibilidade.

timeStamp - A hora em que a disponibilidade foi capturada.

duration - O tempo necessário para a execução do teste de disponibilidade.

runLocation - Nome do local do qual o teste de disponibilidade foi executado.

success - True se o teste de disponibilidade tiver sido executado com êxito.

trackAvailability

public abstract void trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success, String message, Map properties, Map metrics)

Envie informações sobre a disponibilidade de um aplicativo.

Parameters:

name - Nome do teste de disponibilidade.

timeStamp - A hora em que a disponibilidade foi capturada.

duration - O tempo necessário para a execução do teste de disponibilidade.

runLocation - Nome do local do qual o teste de disponibilidade foi executado.

success - True se o teste de disponibilidade tiver sido executado com êxito.

message - Mensagem de erro na falha de execução do teste de disponibilidade.

properties - Valores de cadeia de caracteres nomeados que você pode usar para classificar e pesquisar essa telemetria de disponibilidade.

metrics - Valores adicionais associados a essa telemetria de disponibilidade.

trackDependency

public abstract void trackDependency(String dependencyTypeName, String target, String dependencyName, String data, OffsetDateTime startTime, Duration duration, String resultCode, boolean success)

Envie informações sobre uma dependência externa (chamada de saída) no aplicativo.

Parameters:

dependencyTypeName - Nome do comando iniciado com esta chamada de dependência. Valor de baixa cardinalidade. Exemplos são HTTP, tabela do Azure e SQL.

target - Destino de dependência externa.

dependencyName - Nome do comando iniciado com esta chamada de dependência. Valor de baixa cardinalidade. Os exemplos são o nome do procedimento armazenado e o modelo do caminho da URL.

data - Comando iniciado por essa chamada de dependência. Exemplos são instrução SQL e URLs HTTP com todos os parâmetros de consulta.

startTime - A hora em que a dependência foi chamada.

duration - O tempo gasto pela dependência externa para lidar com a chamada.

resultCode - Código de resultado da execução da chamada de dependência.

success - True se a chamada de dependência foi tratada com êxito.

trackDialogView

public abstract void trackDialogView(String dialogName, Map properties, Map metrics)

Registre um DialogView usando o método TrackPageView no IBotTelemetryClient se IBotPageViewTelemetryClient tiver sido implementado. Como alternativa, registre as informações por meio do TrackTrace.

Parameters:

dialogName - O nome da caixa de diálogo para a qual registrar a entrada/iniciar.

properties - Valores de cadeia de caracteres nomeados que você pode usar para pesquisar e classificar eventos.

metrics - Medidas associadas a esse evento.

trackEvent

public default void trackEvent(String eventName)

Registra eventos personalizados com campos nomeados extensíveis.

Parameters:

eventName - Um nome para o evento.

trackEvent

public default void trackEvent(String eventName, Map properties)

Registra eventos personalizados com campos nomeados extensíveis.

Parameters:

eventName - Um nome para o evento.

properties - Valores de cadeia de caracteres nomeados que você pode usar para pesquisar e classificar eventos.

trackEvent

public abstract void trackEvent(String eventName, Map properties, Map metrics)

Registra eventos personalizados com campos nomeados extensíveis.

Parameters:

eventName - Um nome para o evento.

properties - Valores de cadeia de caracteres nomeados que você pode usar para pesquisar e classificar eventos.

metrics - Medidas associadas a esse evento.

trackException

public default void trackException(Exception exception)

Registra em log uma exceção do sistema.

Parameters:

exception - A exceção do log.

trackException

public abstract void trackException(Exception exception, Map properties, Map metrics)

Registra em log uma exceção do sistema.

Parameters:

exception - A exceção do log.

properties - Valores de cadeia de caracteres nomeados que você pode usar para classificar e pesquisar essa exceção.

metrics - Valores adicionais associados a essa exceção.

trackTrace

public abstract void trackTrace(String message, Severity severityLevel, Map properties)

Envie uma mensagem de rastreamento.

Parameters:

message - Mensagem a ser exibida.

severityLevel - Nível de severidade de rastreamento.

properties - Valores de cadeia de caracteres nomeados que você pode usar para pesquisar e classificar eventos.