Instana 数据源

这是一个 Grafana 数据源，用于显示来自 Instana AI 驱动的 APM for dynamic applications 的指标。

要求

注意：建议使用 Grafana 10.0.0+。

对于本地部署客户，需要 Instana Release 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 的代理，请选中 Use proxy（使用代理）。

要为离线快照启用指标，请选中 Enable offline snapshots（启用离线快照）。对于本地部署的客户，需要 Instana Release 260 或更高版本。

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

用法

查询编辑器

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

基础设施内置指标

填写查询后，可用类型下拉列表将自动填充，选择您想要的类型。

当您选择类型时，可用指标下拉列表将自动填充，选择您想要的指标。

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

基础设施自定义指标

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

当您选择类型时，可用指标下拉列表将自动填充，选择您想要的指标。由于自定义指标可能很多，您可以指定一个可选的过滤器来缩小到相应的子集。

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

基础设施分析

对于自托管安装，此端点组需要 BeeInstana。请参阅此 文档以了解如何启用 BeeInstana。

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

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

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

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

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

更改图例格式

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

• $label - 实体标签
• $host - 相应的主机
• $pid - 相应的 PID
• $timeShift - 相应的时间偏移
• $metric - 显示的指标
• $type - 实体类型
• $service - 服务标签（仅适用于端点）
• $name - 标签替代项
• $index - 列表中的索引

应用程序指标

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

更改图例格式

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

• $label - 实体标签
• $application - 应用程序标签
• $timeShift - 相应的时间偏移
• $metric - 显示的指标
• $key - 包含聚合和汇总的指标键
• $index - 列表中的索引

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

服务指标

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

更改图例格式

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

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

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

端点指标

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

更改图例格式

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

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

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

分析应用程序调用

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

“Application”（应用程序）下拉列表将包含按名称排序的所有应用程序的列表。

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

也可以通过“add Filter”（添加过滤器）添加其他过滤器。多个过滤器使用“AND”连接。

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

如果提取了超过 20 个指标，则会显示警告，提示并非显示所有结果。添加过滤器以缩小数据范围。

更改图例格式

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

• $label - 实体标签
• $application - 应用程序标签
• $timeShift - 相应的时间偏移
• $metric - 显示的指标
• $key - 包含聚合和汇总的指标键
• $index - 列表中的索引

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

分析网站

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

“Website”（网站）下拉列表将包含按页面加载量排序的所有网站的列表。

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

也可以通过“add Filter”（添加过滤器）添加其他过滤器。多个过滤器使用“AND”连接。

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

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

分析移动应用

要选择 EUM 移动应用指标，您需要从类别下拉列表中选择“Analyze mobile app”（分析移动应用）。这将填充其他下拉列表。

“Mobile-app”（移动应用）下拉列表将包含按会话启动次数排序的所有移动应用的列表。

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

也可以通过“add Filter”（添加过滤器）添加其他过滤器。多个过滤器使用“AND”连接。

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

更改图例格式

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

• $label - 实体标签
• $website - 网站标签
• $type - 实体类型
• $timeShift - 相应的时间偏移
• $metric - 显示的指标
• $key - 包含聚合和汇总的指标键
• $index - 列表中的索引

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

SLO 信息

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

• 服务级别目标（beta 版），通过配置中预定义的 SLO 目标，包括

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

• 服务级别目标小组件，通过参数给定的 SLO 目标，包括

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

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

它们之间的区别在于，从 Service level objectives widgets（服务级别目标小组件）的 SLI 配置中未定义 SLO 目标。如果选择 Service level objectives widgets（服务级别目标小组件），则 SLO（目标）是必需参数。另一方面，SLO 目标已通过 Service levels objectives (beta)（服务级别目标（beta 版））的 SLO 配置预定义，无需额外步骤来定义 SLO 目标以进行计算。此外，Service levels objectives (beta)（服务级别目标（beta 版））比 Service level objectives widgets（服务级别目标小组件）提供更多的指标和图表。

下图显示了仪表板在使用 Service levels objectives (beta)（服务级别目标（beta 版））类别中的指标时的外观

下图显示了仪表板在选择 Service level objectives widgets（服务级别目标小组件）类别中的指标时的外观

单值统计可视化

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

• 在指标选择上：“SUM”（总和）以调整我们计算的平均值汇总值
• 在 Singlestat 配置上：“Total”（总计）以告知面板聚合所有给定值

表格可视化

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

使用时间偏移选项

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

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

自定义粒度

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

聚合支持

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