配置 Humio REST API 连接器源

使用 REST API 连接器可在 Humio 云端连接到符合 REST 标准的 Humio 服务。 仅支持 Search REST API。

准备工作

要点: 仅检查 REST API 连接器是否连接到 Search REST API。 使用有限的 Humio 数据访问权测试该连接器。 本主题中提供的变换脚本仅适用于 Search API,并且不会对其他 Humio API 进行验证。 要启用对任何其他 Humio API 的支持,请联系 IBM 专业服务代表。
  • 确保您具有 Humio 帐户、有权访问贵组织的 Humio 存储库,并可生成 API 令牌。

    有关更多信息,请参阅 https://docs.humio.com/cloud-organizations/

  • 确保要连接的 Web Service 在正常运行。
  • 只能检索 Search REST API 的数据。

    有关 URI 格式的更多信息,请参阅 https://docs.humio.com/reference/api/

  • 确保创建变换脚本文件。 此脚本文件包含将 JSON 响应变换为可在仪表板上显示的兼容格式的逻辑。
    请使用以下样本文件来创建新的响应变换脚本文件:
    • 样本文件名:restapi_sample_response_t12n.txt
    • 样本文件位置:$install_dir/wlp/usr/servers/prdapp/restapi_t12n

    其中,install_dir 是安装该应用程序所在的目录。 但是,如果在安装过程中未指定其他安装位置,那么在缺省情况下,该应用程序会安装在 /opt/icabi 文件夹中。

    创建的响应变换文件必须具有 .js 扩展名,而且您必须将该文件放在样本文件所在的位置。 文件名长度不得超过 100 个字符。 您必须在响应变换脚本名称字段中输入此响应变换文件名,如本主题随后的过程步骤所述。
  • 对于样本请求,如果需要提供定制头,请确保您已了解该信息。 定制头是从 Web Service 检索 REST API 信息所需的请求头。 例如,Authorization 请求头或 Accept-Charset 请求头。 Authorization 请求头包含 Web Service 所需的授权信息。 Accept-Charset 指示响应必须包含的可接受数据字符。

程序

创建变换脚本文件。

  • 完成以下步骤以创建变换脚本文件:
    1. 转至放置样本变换脚本文件 restapi_sample_response_t12n.txt的以下位置:

      $install_dir/wlp/usr/servers/prdapp/restapi_t12n

    2. 创建此文件的副本,重命名文件,并在任意文本编辑器中打开此文件。
    3. 删除该文件的现有内容,并将以下脚本复制并粘贴到该文件:
      
      var input;
      var finalJson;
      var output;
      input = JSON.parse(transformationInput);
      var isUnconvertableJSON = false;
      var outArr = []
      count = input['_count']
      var jsonObj = {}
      jsonObj['_count'] = count;
      outArr.push(jsonObj)
      finalJson = outArr;
      output = JSON.stringify(finalJson);
      
      
    4. 将该文件另存为具有 .js 文件扩展名的 JavaScript 文件。
      这将创建变换脚本文件。

使用 REST API 连接器添加符合 REST 标准的 Humio Web Service。

  • 完成以下步骤以使用 REST API 连接器添加符合 REST 标准的 Humio Web Service:
    1. 打开 Dashboard Designer
    2. 在导航窗格中,转至 连接器和源 > 连接器源
    3. 在 "所有连接器源" 页面上,单击 添加源

      添加连接器源”窗口随即显示。

    4. 连接器类型 列表中,选择 REST API 连接器。
    5. 连接器源名称 字段中,输入源的名称。

      源名称可以包含字母数字字符和下划线。

    6. 终端 URL 字段中,输入以下内容 URL :

      https://cloud.humio.com

    7. 认证类型 列表中,选择
    8. 要变换响应,请在 响应变换脚本名称 字段中输入变换脚本文件的名称。
    9. 单击下一步
    10. 方法 列表中,选择方法并根据您选择的方法完成以下任何步骤:
      • 对于 GET 方法,请在 URI 字段中,输入该源的统一资源标识 (URI)。
      • 对于 POST 方法,在 URI 字段中,输入源的 URI ,在 请求主体 字段中,输入发布请求。

      适用于 GET 方法的 URI 示例:

      https://cloud.humio.com/api/v1/repositories/sandbox/queryjobs/<id>

      其中, <id> 是要检索的作业的标识。

      适用于 POST 方法的 URI 和请求主体示例:

      URI:

      /api/v1/repositories/sandbox/query

      请求主体:

      {"queryString":"count)","start":"12h","end":"now","isLive":false}
    11. 定制头下,输入以下头和值:
      表 1. 定制头名称和值
      定制头名称
      Authorization 输入使用 Humio 帐户生成的 API 令牌。
      Content-Type application/json
      Accept application/x-ndjson
    12. 要确保与数据源的连接成功,请单击 测试连接
      如果源详细信息和样本请求有效且完整,那么会显示一条消息,指出连接成功。 对于连接失败消息,必须更正该消息中提到的错误,然后再次测试连接。
      注: 即使源详细信息有效,也可能由于针对样本请求接收到无效响应而显示连接失败消息。
    13. 单击保存

结果

所有连接器源页面显示每个连接器源的以下详细信息:
  • 连接器源名称
  • 连接器类型
  • 首次创建连接器源的日期和时间,以及首次创建源的用户的用户名。
  • 上次修改连接器源的日期和时间,以及上次修改连接器源的用户的用户名。 仅显示最新记录。
REST API 服务添加完毕,它可用于创建定制数据定义。