Search Monitors tool

원문 보기 위키 갱신 2026.10.14

출처: 문서

본문

Search Monitors 도구

2.13에서 도입됨 {: .label .label-purple }

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": {}
    }
  ]
}

{% include copy-curl.html %}

매개변수 설명은 등록 매개변수를 참조하세요.

OpenSearch는 에이전트 ID로 응답해요:

{
  "agent_id": "EuJYYo0B9RaBCvhuy1q8"
}

2단계: 에이전트 실행

다음 요청을 보내 에이전트를 실행하세요:

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

{% include copy-curl.html %}

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`	String	검색할 모니터의 ID예요.
`monitorName`	String	검색할 모니터의 이름이에요.
`monitorNamePattern`	String	검색할 모니터 이름을 일치시키는 데 사용되는 와일드카드 쿼리예요.
`enabled`	Boolean	현재 활성화된 모니터에 대한 정보를 반환할지 여부예요. 이 매개변수를 설정하지 않거나(또는 `null`로 설정) 활성화된 모니터와 비활성화된 모니터 모두에 대한 정보를 반환해요. 이 매개변수를 `true`로 설정하면 활성화된 모니터에 대한 정보만 반환해요. 이 매개변수를 `false`로 설정하면 비활성화된 모니터에 대한 정보만 반환해요. 기본값은 `null`이에요.
`hasTriggers`	Boolean	트리거가 활성화된 모니터에 대한 정보를 반환할지 여부예요. 이 매개변수를 설정하지 않거나(또는 `null`로 설정) 트리거가 활성화된 모니터와 비활성화된 모니터 모두에 대한 정보를 반환해요. 이 매개변수를 `true`로 설정하면 트리거가 활성화된 모니터에 대한 정보만 반환해요. 이 매개변수를 `false`로 설정하면 트리거가 비활성화된 모니터에 대한 정보만 반환해요. 기본값은 `null`이에요.
`indices`	String	반환된 모니터가 추적하는 인덱스의 인덱스 이름 또는 인덱스 패턴이에요.
`sortOrder`	String	결과의 정렬 순서예요. 유효한 값은 `asc`(오름차순) 및 `desc`(내림차순)이에요. 기본값은 `asc`예요.
`sortString`	String	결과를 정렬할 모니터 필드를 지정해요. 기본값은 `name.keyword`예요.
`size`	Integer	반환할 결과 수예요. 기본값은 `20`이에요.
`startIndex`	Integer	시작할 모니터의 페이지 인덱스예요. 기본값은 `0`이에요.

실행 매개변수

다음 표는 에이전트를 실행할 때 사용할 수 있는 모든 도구 매개변수를 나열해요.

매개변수	유형	필수/선택	설명
`question`	String	Required	LLM에 보낼 자연어 질문이에요.

도구 테스트

이 도구는 에이전트 워크플로의 일부로 실행하거나 Execute Tool API를 사용하여 독립적으로 실행할 수 있어요. Execute Tool API는 개별 도구를 테스트하거나 독립 실행형 작업을 수행하는 데 유용해요.

더 알아보기 (Learn more)

원문 전체: https://docs.opensearch.org/latest/ml-commons-plugin/agents-tools/tools/search-monitors-tool/