BotTelemetryClient 接口

包:

com.microsoft.bot.builder

Maven 项目:

com.microsoft.bot:bot-builder:4.14.3

public interface BotTelemetryClient

机器人遥测的日志记录客户端。

方法摘要

修饰符和类型	方法和描述
abstract void	flush() 刷新内存中缓冲区和预聚合的任何指标。
default void	trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success) 发送有关应用程序可用性的信息。
abstract void	trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success, String message, Map<String,String> properties, Map<String,Double> metrics) 发送有关应用程序可用性的信息。
abstract void	trackDependency(String dependencyTypeName, String target, String dependencyName, String data, OffsetDateTime startTime, Duration duration, String resultCode, boolean success) (应用程序中的传出调用) 发送有关外部依赖项的信息。
abstract void	trackDialogView(String dialogName, Map<String,String> properties, Map<String,Double> metrics) 如果已实现 IBot 页面视图遥测客户端，则使用 IBot遥测客户端上的跟踪页面视图方法记录对话框视图。
default void	trackEvent(String eventName) 使用可扩展的命名字段记录自定义事件。
default void	trackEvent(String eventName, Map<String,String> properties) 使用可扩展的命名字段记录自定义事件。
abstract void	trackEvent(String eventName, Map<String,String> properties, Map<String,Double> metrics) 使用可扩展的命名字段记录自定义事件。
default void	trackException(Exception exception) 记录系统异常。
abstract void	trackException(Exception exception, Map<String,String> properties, Map<String,Double> metrics) 记录系统异常。
abstract void	trackTrace(String message, Severity severityLevel, Map<String,String> properties) 发送跟踪消息。

方法详细信息

flush

public abstract void flush()

刷新内存中缓冲区和预聚合的任何指标。

trackAvailability

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

发送有关应用程序可用性的信息。

Parameters:

name - 可用性测试名称。

timeStamp - 捕获可用性的时间。

duration - 运行可用性测试所花费的时间。

runLocation - 运行可用性测试的位置的名称。

success - 如果可用性测试成功运行，则为 True。

trackAvailability

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

发送有关应用程序可用性的信息。

Parameters:

name - 可用性测试名称。

timeStamp - 捕获可用性的时间。

duration - 运行可用性测试所花费的时间。

runLocation - 运行可用性测试的位置的名称。

success - 如果可用性测试成功运行，则为 True。

message - 有关可用性测试运行失败的错误消息。

properties - 可用于对此可用性遥测数据进行分类和搜索的命名字符串值。

metrics - 与此可用性遥测关联的其他值。

trackDependency

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

(应用程序中的传出调用) 发送有关外部依赖项的信息。

Parameters:

dependencyTypeName - 通过此依赖项调用启动的命令的名称。 低基数值。 示例包括 SQL、Azure 表和 HTTP。

target - 外部依赖项目标。

dependencyName - 通过此依赖项调用启动的命令的名称。 低基数值。 示例包括存储过程名称和 URL 路径模板。

data - 此依赖项调用启动的命令。 示例包括包含所有查询参数的 SQL 语句和 HTTP URL。

startTime - 调用依赖项的时间。

duration - 外部依赖项处理调用所用的时间。

resultCode - 依赖项调用执行的结果代码。

success - 如果成功处理依赖项调用，则为 True。

trackDialogView

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

如果已实现 IBotPageViewTelemetryClient，则使用 IBotTelemetryClient 上的 TrackPageView 方法记录 DialogView。 或者，通过 TrackTrace 记录信息。

Parameters:

dialogName - 要记录其条目/start 的对话框的名称。

properties - 可用于搜索和分类事件的命名字符串值。

metrics - 与此事件关联的度量值。

trackEvent

public default void trackEvent(String eventName)

使用可扩展的命名字段记录自定义事件。

Parameters:

eventName - 事件的名称。

trackEvent

public default void trackEvent(String eventName, Map properties)

使用可扩展的命名字段记录自定义事件。

Parameters:

eventName - 事件的名称。

properties - 可用于搜索和分类事件的命名字符串值。

trackEvent

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

使用可扩展的命名字段记录自定义事件。

Parameters:

eventName - 事件的名称。

properties - 可用于搜索和分类事件的命名字符串值。

metrics - 与此事件关联的度量值。

trackException

public default void trackException(Exception exception)

记录系统异常。

Parameters:

exception - 要记录的异常。

trackException

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

记录系统异常。

Parameters:

exception - 要记录的异常。

properties - 可用于对此异常进行分类和搜索的命名字符串值。

metrics - 与此异常关联的其他值。

trackTrace

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

发送跟踪消息。

Parameters:

message - 要显示的消息。

severityLevel - 跟踪严重性级别。

properties - 可用于搜索和分类事件的命名字符串值。