Link Search Menu Expand Document Documentation Menu
文档

搜索监控器工具

2.13 版本引入

该 SearchMonitorsTool 工具检索有关在集群上设置的告警监视器的信息。有关告警监视器的更多信息，请参阅监视器。

步骤 1：注册一个将运行 SearchMonitorsTool 的流代理

流代理按顺序运行一系列工具，并返回最后一个工具的输出。要创建流代理，请发送以下注册代理请求：

POST /_plugins/_ml/agents/_register
{
  "name": "Test_Agent_For_Search_Monitors_Tool",
  "type": "flow",
  "description": "this is a test agent for the SearchMonitorsTool",
  "memory": {
    "type": "demo"
  },
  "tools": [
    {
      "type": "SearchMonitorsTool",
      "name": "DemoSearchMonitorsTool",
      "parameters": {}
    }
  ]
}

有关参数描述，请参阅注册参数。

OpenSearch 返回一个代理 ID

{
  "agent_id": "EuJYYo0B9RaBCvhuy1q8"
}

步骤 2：运行代理

通过发送以下请求来运行代理

POST /_plugins/_ml/agents/EuJYYo0B9RaBCvhuy1q8/_execute
{
  "parameters": {
    "question": "Do I have any alerting monitors?"
  }
}

OpenSearch 返回集群上设置的告警监视器列表以及告警监视器的总数

{
  "inference_results": [
    {
      "output": [
        {
          "name": "response",
          "result": "Monitors=[{id=j_9mYo0Bk4MTqircEzk_,name=test-monitor,type=query_level_monitor,enabled=true,enabledTime=1706752873144,lastUpdateTime=1706752873145}{id=ZuJnYo0B9RaBCvhuEVux,name=test-monitor-2,type=query_level_monitor,enabled=true,enabledTime=1706752938405,lastUpdateTime=1706752938405}]TotalMonitors=2"
        }
      ]
    }
  ]
}

如果未找到监视器，OpenSearch 将在结果中返回一个空数组

{
  "inference_results": [
    {
      "output": [
        {
          "name": "response",
          "result": "Monitors=[]TotalMonitors=0"
        }
      ]
    }
  ]
}

注册参数

下表列出了注册代理时可用的所有工具参数。所有参数都是可选的。

参数 类型 描述
monitorId 字符串 要搜索的监视器的 ID。
monitorName 字符串 要搜索的监视器的名称。
monitorNamePattern 字符串 用于匹配要搜索的监视器名称的通配符查询。
enabled 布尔型 是否返回有关当前已启用监视器的信息。将此参数留空（或将其设置为 null）以返回有关已启用和已禁用监视器的信息。将此参数设置为 true 以仅返回有关已启用监视器的信息。将此参数设置为 false 以仅返回有关已禁用监视器的信息。默认值为 null。
hasTriggers 布尔型 是否返回有关已启用触发器的监视器的信息。将此参数留空（或将其设置为 null）以返回有关已启用和已禁用触发器的监视器的信息。将此参数设置为 true 以仅返回有关已启用触发器的监视器的信息。将此参数设置为 false 以仅返回有关已禁用触发器的监视器的信息。默认值为 null。
索引 字符串 返回的监视器跟踪的索引的索引名称或索引模式。
sortOrder 字符串 结果的排序顺序。有效值为 asc（升序）和 desc（降序）。默认值为 asc。
sortString 字符串 指定用于对结果进行排序的监视器字段。默认值为 name.keyword。
size 整数 要返回的结果数量。默认值为 20。
startIndex 整数 开始分页监视器的索引。默认值为 0。

执行参数

下表列出了运行代理时可用的所有工具参数。

参数 类型 必需/可选 描述
question 字符串 必需 要发送到 LLM 的自然语言问题。
剩余 350 字符

有问题？。

想贡献力量？ 或 。