@ dynatrace- sdk/ 客户端- davis- 分析器
此API允许您与 Davis 交互预测和因果 AI 用于定制的 AI/ML 分析 .
参见 服务文件 熟悉关键的概念.
安装
npm install @dynatrace-sdk/client-davis-analyzers
获得帮助
- 访问 用于打字的 SDK 指南中 Dynatrace 开发者
- 问个问题 Dynatrace社区
许可证
此 SDK 分布于 Apache 许可证,2.0版本,更多信息见LICENSE.
API 参考
最新版本SDK的API 完整参考文件也可在 Dynatrace 开发者。 。 。 .
分析器
import { analyzersClient } from '@dynatrace-sdk/client-davis-analyzers';
取消分析执行
停止一个开始的分析器执行.
所需范围 : davis: 分析器: 执行
使用启动分析器执行时返回的请求令牌取消它 .
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置.analyzer Name*必须 | 字符串 | 分析者之名. |
| 配置。 请求*必须 | 字符串 | 启动长程分析器执行时返回请求令牌 。 它可用于进行投票和取消选举等后续行动. 示例 RHluYXRyYWNlMjAyMw== |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 分析器终止 | 200个 | 当前分析器执行状态和可选部分结果. |
| 无效 | 202 (韩语) | 取消请求已被接受并正在处理中. |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 分析器错误信封错误 | 无效或错误的请求 。 授权不足。 没有可用的分析器 。 | 使用请求符号的分析器结果已经被消耗,或者已经达到其时间到时间(TTL). 现已无结果。 QQ客户端出错. QQ内部服务器出错. |
代码示例
import { analyzersClient } from "@dynatrace-sdk/client-davis-analyzers";
const data = await analyzersClient.cancelAnalyzerExecution({
analyzerName: "...",
requestToken: "RHluYXRyYWNlMjAyMw==",
});
执行分析器
用给定的输入执行分析器 .
所需范围 : davis: 分析器: 执行
分析器执行是同步启动的. 如果在指定超时后无法获取结果, 则返回请求符号 投票结果。 否则,最终结果可直接取出,不归还请求令牌.
根据所选分析器和分析器输入,可能需要增加范围,例如.
storage:buckets:read 财务报告和审定财务报表 storage:metrics:read ,使分析器能够读取从"圣杯"获得的时间序列数据.
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置.analyzer Name*必须 | 字符串 | 分析者之名. |
| 配置. 身体*必须 | 分析输入 | |
| 可配置的预览 | 布尔 | 表示分析器在分析器仍在运行时是否应该预览已创建的输出 . 如果只需要最后的结果, 就会变错 . 默认 : true |
| 配置. 超时秒 | 编号 | 等待回复的秒数 . 超时控制客户端愿意等多久,而分析器执行则继续运行,直到完成或被取消. 默认 : 2 |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 分析器执行结果 | 200个 | 最终分析结果和执行状态. |
| 分析器执行结果 | 202 (韩语) | 当前分析器执行状态以及请求符和活时间(TTL)继续投票结果. |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 分析器错误信封错误 | 无效或错误的请求 。 授权不足。 没有可用的分析器 。 QQ客户端出错. QQ内部服务器出错. |
代码示例
import { analyzersClient } from "@dynatrace-sdk/client-davis-analyzers";
const data = await analyzersClient.executeAnalyzer({
analyzerName: "...",
body: {
timeSeriesData: {
expression: "timeseries avg(dt.host.cpu.usage)",
},
forecastHorizon: 10,
},
});
获取分析器
获取分析器的定义 .
所需范围 : davis: 分析器: 已读
返回分析器的所有可用元信息 .
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置.analyzer Name*必须 | 字符串 | 分析者之名. |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 分析器定义 | 200个 | 请求分析器的定义 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 分析器错误信封错误 | 无效或错误的请求 。 授权不足。 没有可用的分析器 。 QQ客户端出错. QQ内部服务器出错. |
代码示例
import { analyzersClient } from "@dynatrace-sdk/client-davis-analyzers";
const data = await analyzersClient.getAnalyzer({
analyzerName: "...",
});
获取分析文档
把文件拿来做分析.
所需范围 : davis: 分析器: 已读
文件可为某一分析员提供进一步的信息和背景. 并非所有分析家都提供文档.
文档作为Markdown被退回.
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置.analyzer Name*必须 | 字符串 | 分析者之名. |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 无效 | 200个 | 请求分析员的文件. |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 分析器错误信封错误 | 无效或错误的请求 。 授权不足。 没有可用的分析器 。 QQ客户端出错. QQ内部服务器出错. |
代码示例
import { analyzersClient } from "@dynatrace-sdk/client-davis-analyzers";
const data = await analyzersClient.getAnalyzerDocumentation(
{ analyzerName: "..." },
);
获取 JsonSchema 输入
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置.analyzer Name*必须 | 字符串 | 分析者之名. |
| 配置. 配置 | "保卫""LLM" | JSON schema一代的配置. |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 无效 | 200个 | 这个 JSON 输入方案 被请求的分析器. |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 分析器错误信封错误 | 无效或错误的请求 。 授权不足。 没有可用的分析器 。 QQ客户端出错. QQ内部服务器出错. |
代码示例
import { analyzersClient } from "@dynatrace-sdk/client-davis-analyzers";
const data = await analyzersClient.getJsonSchemaForInput({
analyzerName: "...",
});
获取 JsonSchema ForResult 数据
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置.analyzer Name*必须 | 字符串 | 分析者之名. |
| 配置. 配置 | "保卫""LLM" | JSON schema一代的配置. |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 无效 | 200个 | 这个 JSON 结果计划 被请求的分析器. |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 分析器错误信封错误 | 无效或错误的请求 。 授权不足。 没有可用的分析器 。 QQ客户端出错. QQ内部服务器出错. |
代码示例
import { analyzersClient } from "@dynatrace-sdk/client-davis-analyzers";
const data = await analyzersClient.getJsonSchemaForResult({
analyzerName: "...",
});
投票分析器
对一个开始分析器执行的结果的投票.
所需范围 : davis: 分析器: 执行
在开始分析器执行时使用返回的请求令牌进行民意测验以获取结果.
这个 executionStatus 表示分析器执行是否已经完成.
虽然情况是 RUNNING,在之后的电话中再次等待并投票结果.
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置.analyzer Name*必须 | 字符串 | 分析者之名. |
| 配置。 请求*必须 | 字符串 | 启动长程分析器执行时返回请求令牌 。 它可用于进行投票和取消选举等后续行动. 示例 RHluYXRyYWNlMjAyMw== |
| 配置. 超时秒 | 编号 | 等待回复的秒数 . 超时控制客户端愿意等多久,而分析器执行则继续运行,直到完成或被取消. 默认 : 2 |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 分析结果 | 200个 | 当前分析器执行状态和可选部分结果. |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 分析器错误信封错误 | 无效或错误的请求 。 授权不足。 没有可用的分析器 。 | 使用请求符号的分析器结果已经被消耗,或者已经达到其时间到时间(TTL). 现已无结果。 QQ客户端出错. QQ内部服务器出错. |
代码示例
import { analyzersClient } from "@dynatrace-sdk/client-davis-analyzers";
const data = await analyzersClient.pollAnalyzerExecution({
analyzerName: "...",
requestToken: "RHluYXRyYWNlMjAyMw==",
});
查询分析器
查询所有可用的分析器定义 .
所需范围 : davis: 分析器: 已读
分析器定义包含分析器的元信息,包括其输入和输出结构:
- 这个
input定义指定分析器接受的字段,其中某些字段可能需要. - 这个
output定义指定返回分析器结果的结构.
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置. 添加字段 | 字符串 | 除默认字段外指定要获取的元信息 有效值为:
任何其他领域都会产生HTTP 400响应. 示例 baseAnalyzer, type, input最小值 : 1 |
| 配置. filter | 字符串 | 使用 使用运算符时 支持以下运算符:
父母关系和 下列字段是有效的过滤参数:
任何其他领域都会产生HTTP 400响应. 示例 name contains 'statistic'最小值 : 1 |
| 配置.page 键 | 字符串 | 结果页的光标 。 找到它的时候 如果 如果不提供,则总是返回第一页. |
| 配置.页面大小 | 编号 | 单个反应有效载荷中返回分析器定义的数量。 默认使用50. 最高为200. 示例 50最小值 : 1 |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 分析器查询结果 | 200个 | 所有可用的分析器定义 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 分析器错误信封错误 | 权限不足。 QQ客户端出错. QQ内部服务器出错. |
代码示例
import { analyzersClient } from "@dynatrace-sdk/client-davis-analyzers";
const data = await analyzersClient.queryAnalyzers();
校验分析器Execution
为分析器执行验证所提供的输入 .
所需范围 : davis: 分析器: 执行
提供计划用于分析器执行的相同输入,以便在不使用的情况下进行验证 执行分析器.
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置.analyzer Name*必须 | 字符串 | 分析者之名. |
| 配置. 身体*必须 | 分析输入 |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 分析器校正结果 | 200个 | 请求分析器执行的验证结果 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 分析器错误信封错误 | 没有可用的分析器 。 授权不足。 QQ 找不到QQ 客户端错误 。 QQ 内部服务器出错 . |
代码示例
import { analyzersClient } from "@dynatrace-sdk/client-davis-analyzers";
const data =
await analyzersClient.validateAnalyzerExecution({
analyzerName: "...",
body: {},
});
类型
分析器终止
取消分析器执行的结果 。 只有在结果完成同时取消时返回 .
| 名称 | 类型 | 说明 |
|---|---|---|
| 请求键 | 字符串 | 启动长程分析器执行时返回请求令牌 。 它可用于进行投票和取消选举等后续行动. |
| 结果*必须 | 分析器结果 | |
| ttl 秒数 | 编号 | 持续时间直到结果不再可用. |
分析器类别
一个分析器的类别 用于逻辑组 不同的分析器.
| 名称 | 类型 |
|---|---|
| 显示Name*必须 | 字符串 |
分析数据
与分析器的输入和输出定义相匹配的实际数据的地图.
类型: 记录<字符串, 任何>
分析器定义
分析器的定义. 它描述了分析器接受的输入和输出数据 并在被执行时产生.
| 名称 | 类型 | 说明 |
|---|---|---|
| 基础分析器 | 字符串 | 当前分析器所基于的分析器名称. 所有输入和输出参数都是继承的. 额外的参数可能存在于当前分析器中. |
| 类别 | 分析器类别 | 一个分析器的类别 用于逻辑组 不同的分析器. |
| 说明 | 字符串 | 分析器功能的详细描述. 获取分析器的文档以获取更多信息. |
| 显示Name*必须 | 字符串 | |
| 投入 | 矩阵 <参数定义> 翻译: | |
| 标签 | 矩阵 <字符串> 翻译: | 一组基于字符串的标签列表,并标记不同的分析器. |
| 名称*必须 | 字符串 | 分析器的独特识别名称 . |
| 产出 | 矩阵 <参数定义> 翻译: | |
| 类型 | "所取""内经" | 分析器的类型.
|
分析器定义
分析器的定义. 它描述了分析器接受的输入和输出数据 并在被执行时产生.
| 名称 | 类型 | 说明 |
|---|---|---|
| 基础分析器 | 字符串 | 当前分析器所基于的分析器名称. 所有输入和输出参数都是继承的. 额外的参数可能存在于当前分析器中. |
| 类别 | 分析器类别 | 一个分析器的类别 用于逻辑组 不同的分析器. |
| 说明 | 字符串 | 分析器功能的详细描述. 获取分析器的文档以获取更多信息. |
| 显示Name*必须 | 字符串 | |
| 投入 | 矩阵 <参数定义> 翻译: | |
| 标签 | 矩阵 <字符串> 翻译: | 一组基于字符串的标签列表,并标记不同的分析器. |
| 名称*必须 | 字符串 | 分析器的独特识别名称 . |
| 产出 | 矩阵 <参数定义> 翻译: | |
| 类型 | "所取""内经" | 分析器的类型.
|
分析器DimensionalData
解析度数据列表.
| 名称 | 类型 | 说明 |
|---|---|---|
| 查询*必须 | 尺寸查询 | 查询时间序列、实体或日志等维度数据. |
| 类型*必须 | “实体Id” QQ“ 时序阵列” | 维度查询的类型. |
| 价值*必须 | 分析器DimensionalDataValue | 维度查询的解析值 . 示例 {"$ref":"#/components/examples/TimeseriesArray"} |
分析器错误
回复失败的错误 .
| 名称 | 类型 | 说明 |
|---|---|---|
| 代码*必须 | 编号 | 错误的 HTTP 状态代码 . 示例 400 |
| 细节 | 分析器错误细节 | |
| 消息*必须 | 字符串 |
分析器错误细节
| 名称 | 类型 |
|---|---|
| 约束 | 矩阵 <约束暴力> 翻译: |
分析器错误信封
| 名称 | 类型 | 说明 |
|---|---|---|
| 错误 | 分析器错误 | 回复失败的错误 . |
分析器执行结果
分析器执行的结果.
| 名称 | 类型 | 说明 |
|---|---|---|
| 请求键 | 字符串 | 启动长程分析器执行时返回请求令牌 。 它可用于进行投票和取消选举等后续行动. |
| 结果*必须 | 分析器结果 | |
| ttl 秒数 | 编号 | 持续时间直到结果不再可用. |
分析器执行日志
| 名称 | 类型 | 说明 |
|---|---|---|
| 职等*必须 | "收录""INFO" "WARING""SEVERE" | 确定日志的严重性. |
| 消息*必须 | 字符串 | |
| 路径 | 字符串 | 指向输入出错源的路径 。 路径的格式遵循 JSON 路径规格。 。 。 . |
一般参数
在所有分析器输入参数定义中存在的参数.
| 名称 | 类型 | 默认 |
|---|---|---|
| 对数值 | "收录""INFO" "WARING""SEVERE" | WARNING |
| 解析 Dimensional 查询数据 | 布尔 | false |
| 时限 | 时限 |
分析输入
输入是分析器特有的. 获取分析器的定义以获取所需的输入结构.
| 名称 | 类型 | 说明 |
|---|---|---|
| 一般参数 | 一般参数 | 在所有分析器输入参数定义中存在的参数. |
分析器元数据
关于分析器执行的元数据.
| 名称 | 类型 | 说明 |
|---|---|---|
| 护栏 | 分析器MetadataGrail | 关于分析器执行的圣杯特定元数据. |
分析器MetadataGrail
关于分析器执行的圣杯特定元数据.
| 名称 | 类型 | 说明 |
|---|---|---|
| 执行时间 MILI 秒 | 编号 | 作为分析器执行的一部分而运行的所有圣杯查询的总执行时间以毫秒为单位. 最小值 : 0 |
| 扫描Bytes | 编号 | 在作为分析器执行的一部分运行的所有圣杯查询中扫描的字节总数. 最小值 : 0 |
| 扫描数据点 | 编号 | 在作为分析器执行的一部分运行的所有"圣杯"查询中扫描的数据点总数. 最小值 : 0 |
| 扫描记录 | 编号 | 在作为分析器执行的一部分运行的所有圣杯查询中扫描的记录总数. 最小值 : 0 |
分析输出
输出是分析器特有的. 获得分析器的定义以获取所需的输出结构.
| 名称 | 类型 | 说明 |
|---|---|---|
| 系统 | 分析器输出系统 | 在所有分析器输出参数定义中存在的参数. |
分析器输出日志
| 名称 | 类型 |
|---|---|
| 职等*必须 | "收录""INFO""WARING""相声" |
| 消息*必须 | 字符串 |
分析器输出系统
在所有分析器输出参数定义中存在的参数.
| 名称 | 类型 |
|---|---|
| 日志 | 矩阵 <分析器输出日志> 翻译: |
分析结果
投票结果 分析员处决.
| 名称 | 类型 | 说明 |
|---|---|---|
| 请求键 | 字符串 | 启动长程分析器执行时返回请求令牌 。 它可用于进行投票和取消选举等后续行动. |
| 结果*必须 | 分析器结果 | |
| ttl 秒数 | 编号 | 持续时间直到结果不再可用. |
分析器查询结果
可用分析器列表.
| 名称 | 类型 | 说明 |
|---|---|---|
| 分析器*必须 | 矩阵 <分析器定义> 翻译: | |
| 下一个PageKey | 字符串 | 用于执行后续请求的密钥,取取其余分析器. 如果到达了最后一页,或者所有分析器已经列出,此字段会被省略. 示例 RHluYXRyYWNlMjAyMw== |
| 总计*必须 | 编号 | 与当前页面大小相对的可用分析器总量. 示例 100 |
分析器结果
| 名称 | 类型 | 说明 |
|---|---|---|
| 数据 | 矩阵 <分析器DimensionalData> 翻译: | |
| 现况*必须 | "跑"""已""已""已""已" | |
| 投入*必须 | 分析输入 | 输入是分析器特有的. 获取分析器的定义以获取所需的输入结构. |
| 日志 | 矩阵 <分析器执行日志> 翻译: | |
| 元数据 | 分析器元数据 | 关于分析器执行的元数据. |
| 产出*必须 | 矩阵 <分析输出> 翻译: | |
| 结果*必须 | 字符串 | 结果的独特识别身份 用于伐木. |
| 状态*必须 | "SUCESSUL""SUCESSULUL""WITH WARINGS""FAILED""相接""相接""相接""相接""相接""相接""相接""相接""相接"相接"相接"相接"相接"相接"相接"相接"相接"相接"相接"相接"相接 |
分析器校正结果
分析器干燥执行的结果.
| 名称 | 类型 | 说明 |
|---|---|---|
| 细节 | 分析器错误细节 | |
| 无效*必须 | 布尔 | 分析器是否能够用给定的输入数据成功执行 . |
约束暴力
说明为何发生错误的违反限制行为.
| 名称 | 类型 | 说明 |
|---|---|---|
| 职等*必须 | "收录""INFO" "WARING""SEVERE" | 确定日志的严重性. |
| 消息*必须 | 字符串 | |
| 路径 | 字符串 | 指向输入出错源的路径 。 路径的格式遵循 JSON 路径规格。 。 。 . |
编号
对象具有一组固定的可能值,按 key 属性.
| 名称 | 类型 |
|---|---|
| 说明*必须 | 字符串 |
| 显示Name*必须 | 字符串 |
| 键*必须 | 字符串 |
参数定义
单一参数的定义,描述其名称和其他元信息.
| 名称 | 类型 | 说明 |
|---|---|---|
| 高级 | 布尔 | 如果为真,则此参数视为高级使用. |
| 数组*必须 | 布尔 | 此参数是否可以有一系列值 。 也允许传递一个单一的非阵列值. |
| 默认值 | 任意 | 省略参数时使用的默认值 . |
| 说明 | 字符串 | |
| 显示Name*必须 | 字符串 | |
| 计数 数值 | 矩阵 <编号> 翻译: | |
| 扩展类型 | 字符串 | 为此参数提供扩展类型信息 。 这使得更多的语义可以被分析器消费者所利用. |
| 字段 | 矩阵 <参数定义> 翻译: | 鉴于参数是类型 structure 此属性包含参数的子定义 . |
| 最大大小 | 编号 | 如果参数是数组,则元素的最大数量. |
| 名称*必须 | 字符串 | |
| 选项*必须 | 布尔 | 执行分析器时是否可省略此参数 . |
| 类型*必须 | "字符串""数字""boole""时间序列""Array""analyzer Structure""dimensionQuery""数字""整数""时间帧""时间序列""时间序列查询""时间戳" | 参数的类型,表示要提供的值的格式. |
| 数值约束 | 参数定义参数 | 定义字符串或数字参数的值限制。 不适用于其他参数类型. |
时限
| 名称 | 类型 | 说明 |
|---|---|---|
| 结束时间 | 字符串 | 以绝对或相对格式指定结束时间。 对于绝对格式,使用ISO 8601格式(yyyy-MM-ddTHH:mm:ssZ). 对于相对格式,当前时间使用"现在",或应用与可用单位相抵消:"s"为秒,"m"为分数,"h"为小时,"d"为分数. 例如,使用"now-2h"或"-2h"相对抵消2小时. 如果没有指定,则默认为现在. 示例 2023-04-12T12:10:04.123Z |
| 开始时间*必须 | 字符串 | 指定绝对或相对格式的起始时间。 对于绝对格式,使用ISO 8601格式(yyyy-MM-ddTHH:mm:ssZ). 对于相对格式,当前时间使用"现在",或应用与可用单位相抵消:"s"为秒,"m"为分数,"h"为小时,"d"为分数. 例如,使用"now-2h"或"-2h"相对抵消2小时. 示例 2023-04-10T12:10:04.123Z |
尺寸查询
查询时间序列、实体或日志等维度数据.
类型数字 : 字符串 qq 对象
数字
分析器定义类型
⚠️ 折旧 使用字面值.
分析器的类型.
- 执行者:具有执行能力并可以执行的分析员.
- INTERFACE:只是一个由其他分析器定义执行或扩展的接口.
Enum 键
Implemented | Interface
分析器DimensionalDataType
⚠️ 折旧 使用字面值.
维度查询的类型.
Enum 键
EntityId | TimeseriesArray
分析器执行LogLevel
⚠️ 折旧 使用字面值.
确定日志的严重性.
Enum 键
Info | Severe | Tracing | Warning
分析器输出日志级
⚠️ 折旧 使用字面值.
Enum 键
Info | Tracing | Warning
分析结果状态
⚠️ 折旧 使用字面值.
Enum 键
Aborted | Completed | Running
分析器
⚠️ 折旧 使用字面值.
Enum 键
Failed | Successful | SuccessfulWithWarnings
JsonSchema 图形
⚠️ 折旧 使用字面值.
JSON 计划组的配置 :
DEFAULT- 使用标准的JSON schema生成(推荐给大多数客户).LLM- 为LLM消耗生成一个优化的计划.
Enum 键
Default | Llm
参数定义类型
⚠️ 折旧 使用字面值.
参数的类型,表示要提供的值的格式.
Enum 键
AnalyzerStructure | Boolean | DimensionQuery | Enumeration | Integer | Number | String | Timeframe | TimeseriesArray | TimeseriesQuery | Timestamp