Instana 数据源

这是一个 Grafana 数据源，用于显示来自 Instana AI 驱动的动态应用程序 APM 的指标。

要求

注意：建议使用 Grafana 10.0.0+。

对于本地客户，需要 Instana 版本 260+。

功能

• 动态焦点查询
• 应用程序和网站
• 可用的类型和指标的自动补全
• 利用 Instana REST API
• 通过访问令牌进行安全保护

重大变更

• 安全信息存储

  • 为了与 Grafana 团队的最新更新保持一致，所有安全信息（包括 API 密钥）现在应存储在 secureJsonData 中，而不是 jsonData 中。

• API 令牌迁移

  • 从 4.0.0 版开始，当前存储在 jsonData 中的 API 令牌已迁移到 secureJsonData。这是一个重大更改，现有用户必须重新验证其数据源。

• 配置页面更新

  • 为了防止数据源中断，现有用户必须通过在配置页面上输入 URL 和 API 令牌来重新验证。

• 迁移说明

  1. 重新验证步骤

     • 访问配置页面并重新输入每个数据源的 URL 和 API 令牌。

  2. 代理身份验证

     • 身份验证现在仅通过数据源代理方法进行。通过身份验证使用代理是我们的数据源插件中唯一的选择。

  3. Grafana 版本要求

     • 此版本 (4.0.0) 现在是 instana-grafana-datasource 的基础版本，需要 Grafana 10.0.0 或更高版本。

  4. API 令牌重置

     • 保存凭据后，API 令牌会存储在服务器上。用户可以选择使用提供的重置密钥按钮重置 API 令牌。

• 其他说明

  • 确保所有现有数据源都已重新验证，以防止中断。
  • 有关身份验证更改的任何其他信息或故障排除步骤，请参阅更新后的文档。

感谢您在过渡期间的理解和合作。如果您遇到任何问题或有任何疑问，请联系我们的支持团队。

感谢您使用 instana-grafana-datasource！

故障排除

进行故障排除时，请在 https://www.ibm.com/mysupport 上提交工单，以便以最快的方式解决您的问题/疑问。

正在寻找答案和最佳实践？查看我们的 IBM Instana 社区。

配置

此数据源使用 Instana REST API 来查询指标值。首先，您需要生成一个 API 令牌。使用此令牌以及您 Instana 帐户的 URL，例如 https://prod-acme.instana.io

要使用 Grafana 服务器作为查询 Instana REST API 的代理，请选中 使用代理。

要为离线快照启用指标，请选中 启用离线快照。对于本地客户，需要 Instana 版本 260。

配置允许设置此插件提供的不同类别的限制。可以输入数值以确保查询不超过其查询的特定窗口大小。当遇到 Grafana 性能问题时，这很有用。

用法

查询编辑器

首先，输入 动态聚焦 查询。这与 Instana 仪表盘中使用的查询完全相同；您可以在 Instana 中测试您的查询，然后将其复制粘贴到 Grafana 中。注意 Grafana 数据源插件目前不支持保存的过滤器。

基础设施内置指标

完成查询后，可用的类型下拉菜单将自动填充，选择您想要的类型。

选择类型后，可用的指标下拉菜单将自动填充，选择您想要的指标。

如果您的动态聚焦查询匹配多个实例，则返回的数据集将包含来自所有匹配实例的指标，从而提供具有多个图表的图形，如下面的示例所示。

基础设施自定义指标

要选择与您的查询匹配的自定义指标，您需要从类别下拉菜单中选择“基础设施自定义指标”，这将自动填充可用的类型下拉菜单。

选择类型后，可用的指标下拉菜单将自动填充，选择您想要的指标。由于可能存在大量自定义指标，您可以指定一个可选过滤器来减少到相应的子集。

如果您的动态聚焦查询匹配，则返回的数据集将包含指标，从而提供如下面的示例所示的图表。

基础设施分析

对于自托管安装，此端点组需要 BeeInstana。请参阅本 启用 BeeInstana 的文档。

要选择基础设施分析指标，您需要从类别下拉菜单中选择“基础设施分析”。这将填充其他下拉列表。

“实体类型”下拉菜单将包含所有实体类型的列表，按实体名称排序。选择实体类型后，可用的指标下拉菜单将自动填充。

您应该在“分组依据”文本框中提供适当的分组依据标签。您可以在 Instana 仪表盘中轻松找到“分组依据标签”选项。然后选择您想要的指标。

大多数指标将具有多个聚合类型（SUM、MEAN 等），您可以从中选择合适的类型。

我们目前完全支持基础设施分析中的过滤。要使用此功能，您必须在“TagFilterExpression”文本框中填写一个包含所需过滤器对象的数组的 tagFilterExpression。您可以在 Instana 基础设施分析仪表盘的 API 查询会话下的 JSON 树中轻松获取 tagFilterExpression。如果您的选择匹配，则返回的数据集将包含指标，从而提供如下面的示例所示的图表。

更改图例格式

要调整图例显示，您可以提供自己的“图例格式”。支持的替换值为

• $label - 实体标签
• $host - 对应的主机
• $pid - 对应的 PID
• $timeShift - 对应的 timeShift
• $metric - 显示的指标
• $type - 实体类型
• $service - 服务标签（仅限端点）
• $name - 标签替代
• $index - 列表中的索引

应用程序指标

获取与一个或多个应用程序相关的指标的简单版本。选择应用程序和指标后，将绘制图表（见下面的示例）。应用程序旁边的图标指示显示的信息是基于应用程序的使用者执行的调用（INBOUND）还是基于在该应用程序中执行的所有调用，包括使用者和内部调用（ALL）。这些选项只有在选择应用程序后才会启用。

更改图例格式

要调整图例显示，您可以提供自己的“图例格式”。支持的替换值为

• $label - 实体标签
• $application - 应用程序标签
• $timeShift - 对应的 timeShift
• $metric - 显示的指标
• $key - 带有聚合和汇总的指标键
• $index - 列表中的索引

如果没有提供自定义格式，将显示默认标签“$label ($application) $metric”。

服务指标

允许显示与服务相关的指标。服务可以单独选择，也可以与应用程序透视图结合使用以显示更详细的指标数据。选择应用程序后，可能的服务的下拉菜单会重新加载，只显示所选应用程序实际使用的服务。与应用程序一起，可以指示显示的信息是基于应用程序的使用者执行的调用（INBOUND）还是基于在该应用程序中执行的所有调用，包括使用者和内部调用（ALL）。这些选项只有在选择应用程序后才会启用。如果只选择了一个服务（没有应用程序），则显示的信息将基于在该应用程序中执行的所有调用，包括使用者和内部调用。

更改图例格式

要调整图例显示，您可以提供自己的“图例格式”。支持的替换值为

• $label - 实体标签
• $service - 服务标签
• $application - 应用程序标签（如果已选择）
• $timeShift - 对应的 timeShift
• $metric - 显示的指标
• $key - 带有聚合和汇总的指标键
• $index - 列表中的索引

如果没有提供自定义格式，将显示默认标签“$label ($service) $metric”。

端点指标

允许显示与端点相关的指标。端点可以单独选择，也可以与应用程序透视图和服务结合使用以显示更详细的指标数据。由于多个端点可能具有相同的名称，因此建议选择应用程序，然后选择服务，最后选择端点以确保选择正确的端点。每次更改服务和应用程序时，都会重新加载和缓存可能的可选项目。与应用程序一起，可以指示显示的信息是基于应用程序的使用者执行的调用（INBOUND）还是基于在该应用程序中执行的所有调用，包括使用者和内部调用（ALL）。这些选项只有在选择应用程序后才会启用。如果只选择了一个端点（没有应用程序），则显示的信息将基于在该应用程序中执行的所有调用，包括使用者和内部调用。这与所选服务无关。

更改图例格式

要调整图例显示，您可以提供自己的“图例格式”。支持的替换值为

• $label - 实体标签
• $application - 应用程序标签（如果已选择）
• $service - 服务标签（如果已选择）
• $endpoint - 端点标签
• $timeShift - 对应的 timeShift
• $metric - 显示的指标
• $key - 带有聚合和汇总的指标键
• $index - 列表中的索引

如果没有提供自定义格式，将显示默认标签“$label ($endpoint) $metric”。

分析应用程序调用

要选择应用程序指标，您需要从类别下拉菜单中选择“分析应用程序调用”。这将填充其他下拉列表。

“应用程序”下拉菜单将包含所有应用程序的列表，按其名称排序。

大多数指标将具有多个聚合类型（SUM、MEAN 等），您可以选择使用哪种类型。

还可以通过“添加过滤器”添加其他过滤器。多个过滤器使用“AND”连接。

如果您的选择匹配，则返回的数据集将包含指标，从而提供如下面的示例所示的图表。

如果获取的指标超过 20 个，则会显示一条警告，说明并非所有结果都已显示。添加过滤器以缩小数据范围。

更改图例格式

要调整图例显示，您可以提供自己的“图例格式”。支持的替换值为

• $label - 实体标签
• $application - 应用程序标签
• $timeShift - 对应的 timeShift
• $metric - 显示的指标
• $key - 带有聚合和汇总的指标键
• $index - 列表中的索引

如果没有提供自定义格式，将显示默认标签“$label ($application) $metric”。

分析网站

要选择 EUM 网站指标，您需要从类别下拉菜单中选择“分析网站”。这将填充其他下拉列表。

“网站”下拉菜单将包含所有网站的列表，按其页面加载次数排序。

大多数指标将具有多个聚合类型（SUM、MEAN 等），您可以选择使用哪种类型。

还可以通过“添加过滤器”添加其他过滤器。多个过滤器使用“AND”连接。

如果您的选择匹配，则返回的数据集将包含指标，从而提供如下面的示例所示的图表。

将显示默认标签“$label ($website) $metric”。

分析移动应用程序

要选择 EUM 移动应用程序指标，您需要从类别下拉菜单中选择“分析移动应用程序”。这将填充其他下拉列表。

“移动应用程序”下拉菜单将包含所有移动应用程序的列表，按其会话开始次数排序。

大多数指标将具有多个聚合类型（SUM、MEAN 等），您可以选择使用哪种类型。

还可以通过“添加过滤器”添加其他过滤器。多个过滤器使用“AND”连接。

如果您的选择匹配，则返回的数据集将包含指标，从而提供如下面的示例所示的图表。

更改图例格式

要调整图例显示，您可以提供自己的“图例格式”。支持的替换值为

• $label - 实体标签
• $website - 网站标签
• $type - 实体类型
• $timeShift - 对应的 timeShift
• $metric - 显示的指标
• $key - 带有聚合和汇总的指标键
• $index - 列表中的索引

如果没有提供自定义格式，将显示默认标签“$label ($website) $metric”。

SLO 信息

Instana 将两个集合的服务级别信息引入 Grafana。

• 服务级别目标 (beta)，由配置中预定义的 SLO 目标提供，包括

  • 服务级别状态（单个数字）
  • 预定义的服务级别目标（单个数字）
  • 总错误预算（单个数字）
  • 剩余错误预算（单个数字）
  • 已消耗错误预算（单个数字）
  • 错误图表/错误预算消耗（时间序列）
  • 错误预算累积图表（时间序列）
  • 错误预算剩余图表（时间序列）
  • 违规图表（时间序列）

• 服务级别目标小部件，由参数中给定的 SLO 目标提供，包括

  • SLI（单个数字）
  • 剩余错误预算（单个数字）
  • 时间序列（时间序列中的违规）

两者都可以从指标类别下拉列表中选择。相应地，可以为显示选择 SLO/SLI 配置和值类型。

它们之间的区别在于，服务级别目标小部件中的 SLI 配置没有定义 SLO 目标。如果选择 服务级别目标小部件，则需要 SLO(目标) 作为参数。另一方面，服务级别目标 (beta) 中的 SLO 目标已由 SLO 配置预定义，无需执行其他步骤来定义 SLO 目标以进行计算。此外，服务级别目标 (beta) 提供比 服务级别目标小部件 更多的指标和图表。

下图显示了使用 服务级别目标 (beta) 类别中的指标的仪表盘的外观。

下图显示了选择 服务级别目标小部件 类别中的指标时仪表盘的外观。

单统计量可视化

使用“单统计量”可视化时，可以选择额外的指标聚合。为了显示正确的 SUM 指标，需要在两个不同的位置进行配置

• 在指标选择中：“SUM”以调整我们的平均计算的汇总值
• 在单统计量配置中：“总计”告诉面板聚合所有给定值

表格可视化

使用“表格”可视化时，可以选择额外的指标聚合。

使用时间偏移选项

时间偏移选项允许在每个查询的不同时间点回溯。

此新功能可用于比较两个相同的查询，其中一个显示查询前一天的结果。

自定义粒度

此插件还支持选择不同的粒度值以更深入地了解指标。

聚合支持

在查询级别聚合图表，并选择显示所有内容或仅显示聚合图表。