Instana 数据源

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

要求

注意：建议使用 Grafana 10.0.0+。

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

功能

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

重大更改

• 安全信息存储

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

• API 令牌迁移

  • 目前存储在 jsonData 中的 API 令牌现在从版本 4.0.0 开始迁移到 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仪表板中轻松找到“分组标签”选项。然后选择您想要的度量。

大多数度量将具有多个聚合类型（总和、平均值等），您可以选择合适的类型。

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

更改图例格式

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

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

应用程序度量

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

更改图例格式

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

• $label - 实体标签
• $application - 应用程序标签
• $timeShift - 对应的时间偏移量
• $metric - 显示的度量
• $key - 具有聚合和汇总的度量键
• $index - 列表中的索引

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

服务度量

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

更改图例格式

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

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

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

端点度量

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

更改图例格式

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

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

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

分析应用程序调用

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

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

大多数指标都将有多种聚合类型（总和、平均值等），您可以选择使用哪一种。

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

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

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

更改图例格式

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

• $label - 实体标签
• $application - 应用程序标签
• $timeShift - 对应的时间偏移量
• $metric - 显示的度量
• $key - 具有聚合和汇总的度量键
• $index - 列表中的索引

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

分析网站

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

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

大多数指标都将有多种聚合类型（总和、平均值等），您可以选择使用哪一种。

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

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

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

分析移动应用程序

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

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

大多数指标都将有多种聚合类型（总和、平均值等），您可以选择使用哪一种。

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

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

更改图例格式

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

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

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

SLO信息

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

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

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

• 服务级别目标小部件，通过参数中给出的SLO目标，包括

  • SLI (单个数值)
  • 剩余错误预算（单个数字）
  • 时间序列（时间序列违规情况）

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

它们之间的区别在于，从服务级别目标小部件中未定义SLO目标为SLI配置。如果选择服务级别目标小部件，则需要作为参数指定SLO(目标)。另一方面，SLO目标已经由服务级别目标（beta版）中的SLO配置预先定义，无需额外步骤来定义计算SLO目标。此外，服务级别目标（beta版）比服务级别目标小部件提供了更多的指标和图表。

以下图片显示了具有服务级别目标（beta版）类别指标的仪表板外观

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

单数值可视化

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

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

表格可视化

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

使用时间偏移选项

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

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

自定义粒度

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

聚合支持

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