Connect 连接到 ServiceNow数据源 - Amazon Managed Grafana
功能配置使用量提示注释常见问题解答

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

Connect 连接到 ServiceNow数据源

这是用于连接 ServiceNow实例 ServiceNow 的数据源。

注意

此数据源仅适用于 Grafana 企业版。有关更多信息，请参阅 管理对企业插件的访问权限。

此外，在支持版本 9 或更高版本的工作空间中，此数据源可能需要您安装相应的插件。有关更多信息，请参阅 使用插件扩展您的工作空间。

功能

  • 查询

    • 统计 API 查询

    • 表 API 查询

      • 事件、变更和任何其他表格

  • 提醒

  • 注释（测试版功能）

  • 模板变量

配置

在 Grafana 的左侧面板上选择数据源。

选择添加数据源：

输入servicenow查找数据源插件：

输入 ServiceNow 网址：

选择保存并测试。您应该会看到一条绿色消息，上面写着 “ServiceNow 连接正常”。

仪表板示例

预制仪表板包含在插件中，可通过数据源配置页面的 “仪表板” 选项卡导入。

使用量

在查询编辑器中返回数据的方法有两种。

  • TableAPI

  • 聚合 API

用户目前可以在查询预定义表之间进行选择，如下所示：

  • 更改

  • 事件

或者，从现在开始v1.4.0，使用 “其他（自定义表）” 选项创建由 API 驱动的表和字段列表。此选项将允许您查询用于设置数据源的用户可用的任何表中的 ServiceNow 数据。

“自定义表格” 选项应支持所有与预定义表格列表相同的功能。

TableAPI 查询

TableAPI 返回适合在表格面板中显示的数据。它允许按顺序选择要显示的字段以及筛选选项。查询编辑器还提供了一个用于限制查询返回的行数的字段。

显示上一个查询结果的表格面板示例。

Show

“显示” 行为要显示的字段提供了一个选择器。也可以指定多个字段。字段将按指定的确切顺序返回。

显示值

D is play Values 标志将使查询返回人性化值或显示值，而不是数值。

例如，1如果没有此标志，则只会显示严重性1。如果启用了该标志，则显示的值将为1 - High。

根据 ServiceNow API文档，这可能会对性能产生负面影响。

注意

[...] 指定显示值可能会导致性能问题，因为它不是直接从数据库读取数据，并且可能包括引用其他字段和记录。

过滤器（通用）

筛选器行允许根据多个字段和值标准缩小显示行的范围。

所有筛选条件都与 AND 或 O R 运算相结合。

不使用定制表格时，以下字段可用（此列表将来会扩展）。

Active
Asset
Group
Assigned To
Escalation
Issue Number
Description
Priority
State
Type
Change Risk
Change State
Start Date
End Date
On Hold

选择自定义表格时，将自动从 “立即服务” API 填充字段。

日期筛选条件
时间字段 运算符 值
开业于 今天或之前不是今天之前或之前 At 或之后 at 或之后 时间戳 JavaScript: gs.daysago (30)
活动到期
闭馆时间
截止日期
预计开局
重新开放时间
已解决于
工作结束
工作开始
忽略时间

有关其他日期值，请参阅：https://developer.servicenow.com/app.do #! /api_doc？ v=newyork&id=r_sgsys-dateGenerate_s_s

运算符（通用，基于字符串）

  • Starts With

  • Ends With

  • 喜欢

  • 不喜欢

  • 等于

  • 不等于

  • Is Empty

运算符（基于时间）

  • 今天

  • 今天不行

  • 早于

  • 在或之前

  • 晚于

  • 在或之后

值

值的选择取决于所选过滤器的类型。

  • 布尔过滤器有 “真/假” 选项

  • 文本过滤器将允许键入任何值

  • 升级、优先级有一组固定的数值

排序依据

“排序依据” 行允许根据多个字段和值标准缩小显示行的范围。

所有筛选器均与 AND 运算相结合。将添加对其他运算符的 Support 支持。

限制

可以指定行限制以防止返回太多数据。默认值为 25。

时间字段

Time Field这就是将您查询的数据转换为时间序列的原因。将您的数据作为时间序列进行处理，这意味着所选 “时间字段” 中不在仪表板/面板时间范围内的值将不会显示。

使用的默认时间字段是 “Opened At”，但可以更改为任何包含时间值的可用字段。

提供了一个特殊值 “Ignore Time”，以允许结果 “到目前为止”，并使过滤器能够控制显示哪些数据。

AggregateAPI 查询（统计信息）

AggregateAPI 将始终返回指标，其中包含以下聚合：平均值、最小值、最大值、总和。筛选也可用于缩小查询范围。

Show

显示行为要显示的指标提供了一个选择器。也可以指定多个指标。

过滤器（通用）

聚合筛选器提供了根据字段和值标准缩小显示指标范围的功能，类似于表格选项。

所有筛选器均与 AND 运算相结合。将添加对其他运算符的 Support 支持。

统计过滤器选项与 TableAPI 相同。

聚合

指标聚合有四种类型，外加一个 “计数”：

  • 平均值

  • 最低

  • 最高

  • 总和

  • 计数-这将返回查询返回的指标的 “数量”

分组依据

此选择器可以将指标拆分为较小的聚合。按 “优先级” 分组将返回带有优先级 “标签” 和分隔唯一值的指标。

模板化

您可以使用变量代替查询中的名称，而不必在查询中对名称进行硬编码。变量显示为仪表板顶部的下拉选择框。您可以使用这些下拉框来更改仪表板上显示的数据。

请参阅 “查询变量” 部分中的示例，了解如何添加查询变量并使用模板值引用该变量。

查询变量

如果添加该类型的模板变量Query，则可以编写一个查询，该查询可以返回显示为下拉选择框的类别名称、键名称或键值等项目。

例如，您可以categories通过在模板变量 Query 设置中指定诸如此类的查询，来创建一个包含所有值的变量。

选择 “查询” 设置时，将显示 “筛选器” 部分，允许您选择 “类型” 和 “字段”。目前，类型仅限于事件和更改。选择类型时，系统会为您提供适用于该类型的字段列表。选择类型和字段后，底部将显示值的预览，显示该类型/字段的可用选项。这些值将显示在仪表板的下拉列表中，您可以将其与模板一起使用来筛选仪表板面板上的数据。

例如，如果您添加一个名为 “类别” 的变量，然后选择 “类型 = 事件” 和 “字段 = 类别”，则会看到 “类别” 的选项列表。如果您随后向面板添加筛选器，并选择类别等于 $ {category}，则面板数据将仅显示从仪表板下拉列表中选择的该类别的数据。

导入 “按类别划分的事件” 仪表板以查看示例。

在查询中使用变量

有两种语法：

$<varname>使用名为的模板变量的示例hostname：

[[varname]]使用名为的模板变量的示例hostname：

提示

支持标准 Grafana 警报。图形面板中定义的任何查询都可用于生成警报。

以下是示例查询和警报。此查询将返回所有未解决的严重高优先级事件的图表：

当有超过五起未解决的严重高优先级事件时，将启动此警报：

测试警报规则将显示警报规则的输出，选择状态历史记录将显示警报从正常过渡到待处理再到警报。

当警报处于待定状态时，图表视图将显示一条垂直线，顶部的心形图标将变为橙色。

满足警报标准后，该规则将变为红色。

在图表视图中，将出现红色垂直线，顶部的心形图标将变为红色。

为警报写事件

测试版功能

  • 为您的 ServiceNow 数据源配置通知渠道。

这将配置一个 Grafana 通知渠道，该渠道使用您配置的用户在实例上为此数据 ServiceNow 源创建事件。

此操作要求 ServiceNow 数据源用户具有写入事件的权限。

使用 HTTP 代理

使用 HTTP 代理时，Amazon Managed Grafana 需要将以下环境变量设置为代理的位置：

  • HTTP_PROXY – 、 或 http_proxy

    • 完整路径-http://host:port

    • 或者只是：host:port

  • HTTPS_PROXY（或https_proxy）：

    • 完整路径-https://host:port

    • 或者只是：host:port

注释

截至该数据源，Grafana 注释是一v1.4.0项测试版功能。标注使您能够在图表上叠加事件。

Annotations 查询支持与标准查询编辑器相同的选项，但有一些细微的区别：

  • 只能选择一个 “显示” 列。这很可能会在 future 的改进中得到修复。

  • 时间字段为必填字段。

常见问题解答

如果我们没有 ITSM 角色插件怎么办？

需要管理员访问权限才能执行以下操作

选项 1：授予 Grafana 用户管理员权限以允许访问所有表。

选项 2：创建角色并将 ACL 应用于 Grafana 必须访问的所有表。

需要管理员访问权限才能执行以下操作。

  1. 已登录的管理员需要提升对 security_admin 的访问权限。

    1. 在右上角的导航窗格中，选择配置文件图标。个人资料图标带有下拉插入符号指示器。

    2. 从下拉列表中选择 “提升角色”。

    3. 在显示的模式中，选中 s ecurity_admin 复选框。

    4. 选择 确定。

  2. 使用您想要的任何命名约定创建一个新角色。

    1. 导航到左侧导航栏中的 “角色” 部分 “系统安全” => “用户和群组” => “角色”

    2. 选择顶部的 “新建”。

    3. 输入角色的名称和相关描述。

    4. 选择提交。

  3. 创建新用户或修改具有所需角色的现有用户。

    1. 您在步骤 2 中创建的角色

    2. 个性化字典

    3. 个性化选择

    4. cmdb_read（这将授予对所有 cmdb 表的读取权限）

  4. 为所需的表和字段创建表 ACL。

    1. 为 sys_db_object 表创建 ACL。

      1. 在第二个搜索标题列的 “名称” 中，输入sys_db_object，然后按 Enter。

      2. 筛选结果应显示表。选择 “表” 以导航到记录。

      3. 在选项卡部分，选择控件。

      4. 在页面的下半部分，确保选中了 “访问控制” 选项卡。

      5. 选择 “新建” 以创建新的 ACL。

      6. 将操作选项更改为读取。

      7. 在屏幕下方的 “需要角色” 部分，选择（双击）“插入新行”，然后搜索您创建的角色。

      8. 选择您创建的角色后，选择绿色复选标记。

      9. 选择屏幕下方的 “提交” 以创建 ACL，然后在出现模式时选择 “继续”。

  5. 为特定的 sys_db_object 字段创建 ACL。必须对以下每个字段重复以下步骤：“名称”、“标签”、“显示名称” 和 “扩展” 表。

    1. 在 sys_db_object 的表格记录视图中，在最靠近屏幕顶部的选项卡组中选择 “列” 选项卡。

    2. 找到字段名称并将其选中。

    3. 在下方的选项卡部分，在 “访问控制” 选项卡上选择 “新建”。

    4. 将操作更改为读取

    5. 选择（双击）在底部的 “需要角色” 表格中插入一行文本。

    6. 搜索您创建的角色，然后选择绿色复选标记。

    7. 选择提交。

    8. 请确保对所有必填字段重复这些步骤：“名称”、“标签”、“显示名称” 和 “扩展” 表。

  6. 在 “更改”、“事件” 表以及要从 Grafana 查询的任何其他非 CMDB 表上重复 4.1 中的步骤。不要重复 4.2 中的步骤；只有在 sys_db_object 中才需要执行该步骤。