› › ›

API Cluster Info

Данная функциональность находится в стадии технического предварительного просмотра и может быть изменена или удалена в будущих выпусках. Elastic будет работать над устранением любых проблем, но функции в стадии технического предварительного просмотра не подпадают под SLA поддержки официальных функций GA.

Возвращает информацию о кластере.

Запрос

GET /_info/<target>

Предварительные условия

Если функции безопасности Elasticsearch включены, у вас должны быть monitor или manage права доступа к кластеру, чтобы использовать этот API.

Описание

Вы можете использовать API Cluster Info для получения информации о кластере.

Параметры пути

<target>

(Строка) Ограничивает возвращаемую информацию до конкретных target. Список опций, разделенных запятыми:

_all: Вся доступная информация. Не может быть смешана с другими параметрами.
http: Информация о подключениях HTTP.
ingest: Информация об Ingest.
thread_pool: Статистика о каждом пуле потоков, включая текущий размер, размер очереди и отклоненные задачи.
script: Содержит статистику сценариев кластера.

Тело ответа

cluster_name: (string) Имя кластера. Основано на параметре Cluster name setting.

http

(object) Содержит информацию HTTP для кластера.

Свойства http

current_open

(integer) Текущее количество открытых HTTP-соединений для кластера.

total_opened

(integer) Общее количество открытых HTTP-соединений для кластера.

clients

(array of objects) Информация о текущих и недавно закрытых HTTP-клиентских соединениях. Клиенты, которые были закрыты дольше, чем параметр http.client_stats.closed_channels.max_age, здесь не представлены.

Свойства clients

id: (integer) Уникальный ID для HTTP-клиента.
agent: (string) Заявленный агент для HTTP-клиента. Если недоступен, это свойство не включено в ответ.
local_address: (string) Локальный адрес для HTTP-соединения.
remote_address: (string) Удалённый адрес для HTTP-соединения.
last_uri: (string) URI последнего запроса клиента.
x_forwarded_for: (string) Значение из HTTP-заголовка x-forwarded-for клиента. Если недоступно, это свойство не включено в ответ.
x_opaque_id: (string) Значение из HTTP-заголовка x-opaque-id клиента. Если недоступно, это свойство не включено в ответ.
opened_time_millis: (integer) Время, когда клиент открыл соединение.
closed_time_millis: (integer) Время, когда клиент закрыл соединение, если соединение закрыто.
last_request_time_millis: (integer) Время последнего запроса от этого клиента.
request_count: (integer) Количество запросов от этого клиента.
request_size_bytes: (integer) Совокупный размер в байтах всех запросов от этого клиента.

ingest

(object) Содержит информацию о приёме данных для кластера.

Свойства ingest

total

(object) Содержит информацию об операциях приёма данных для кластера.

Свойства total

count: (integer) Общее количество документов, принятых по всему кластеру.
time: (time value) Общее время, затраченное на предварительную обработку документов по всему кластеру.
time_in_millis: (integer) Общее время, в миллисекундах, затраченное на предварительную обработку документов по всему кластеру.
current: (integer) Общее количество документов, которые в данный момент принимаются.
failed: (integer) Общее количество неудачных операций приёма данных по всему кластеру.

pipelines

(object) Содержит информацию о конвейерах приёма данных для кластера.

Свойства pipelines

<pipeline_id>

(object) Содержит информацию о конвейере приёма данных.

Свойства <pipeline_id>

count

(integer) Количество документов, предварительно обработанных конвейером приёма данных.

time

(time value) Общее время, затраченное на предварительную обработку документов в конвейере приёма данных.

time_in_millis

(integer) Общее время, в миллисекундах, затраченное на предварительную обработку документов в конвейере приёма данных.

failed

(integer) Общее количество неудачных операций для конвейера приёма данных.

ingested_as_first_pipeline

(byte value) Общий принятый размер всех документов, которые были впервые обработаны этим конвейером. Размер документа не добавляется к значению статистики для этого конвейера, если это конечный конвейер после конвейера по умолчанию, конвейер, запущенный после процессора перенаправления, или находится внутри процессора конвейера. Вместо этого размер документа добавляется к значению статистики конвейера, который изначально принял документ.

ingested_as_first_pipeline_in_bytes

(integer) Общий принятый размер, в байтах, всех документов, которые были впервые обработаны этим конвейером. Размер документа не добавляется к значению статистики для этого конвейера, если это конечный конвейер после конвейера по умолчанию, конвейер, запущенный после процессора перенаправления, или находится внутри процессора конвейера. Вместо этого размер документа добавляется к значению статистики конвейера, который изначально принял документ.

produced_as_first_pipeline

(byte value) Общий выданный размер всех документов, которые были впервые обработаны этим конвейером. Размер документа не добавляется к значению статистики для этого конвейера, если это конечный конвейер после конвейера по умолчанию, конвейер, запущенный после процессора перенаправления, или находится внутри процессора конвейера. Вместо этого размер документа добавляется к значению статистики конвейера, который изначально принял документ.

produced_as_first_pipeline_in_bytes

(integer) Общий выданный размер, в байтах, всех документов, которые были впервые обработаны этим конвейером. Размер документа не добавляется к значению статистики для этого конвейера, если это конечный конвейер после конвейера по умолчанию, конвейер, запущенный после процессора перенаправления, или находится внутри процессора конвейера. Вместо этого размер документа добавляется к значению статистики конвейера, который изначально принял документ.

processors

(array of objects) Содержит информацию для процессоров приёма данных для конвейера приёма данных.

Свойства processors

<processor>

(object) Содержит информацию для процессора приёма данных.

Свойства <processor>

count: (integer) Количество документов, преобразованных процессором.
time: (time value) Время, затраченное процессором на преобразование документов.
time_in_millis: (integer) Время, в миллисекундах, затраченное процессором на преобразование документов.
current: (integer) Количество документов, которые в данный момент преобразуются процессором.
failed: (integer) Количество неудачных операций для процессора.

thread_pool

(object) Содержит информацию о пулах потоков кластера.

Свойства thread_pool

<thread_pool_name>

(object) Содержит информацию о пуле потоков кластера с именем <thread_pool_name>.

Свойства <thread_pool_name>

threads: (integer) Количество потоков в пуле потоков.
queue: (integer) Количество задач в очереди для пула потоков.
active: (integer) Количество активных потоков в пуле потоков.
rejected: (integer) Количество задач, отклоненных исполнителем пула потоков.
largest: (integer) Наибольшее количество активных потоков в пуле потоков.
completed: (integer) Количество задач, выполненных исполнителем пула потоков.

script

(объект) Содержит статистику сценариев кластера.

Свойства script

compilations: (целое число) Общее количество выполненных кластером инлайновых компиляций сценариев.
compilations_history: (объект) Содержит недавнюю историю компиляций сценариев.

Свойства compilations_history

5m: (длинное целое число) Количество компиляций сценариев за последние пять минут.
15m: (длинное целое число) Количество компиляций сценариев за последние пятнадцать минут.
24h: (длинное целое число) Количество компиляций сценариев за последние сутки.

cache_evictions: (целое число) Общее количество раз, когда кэш сценариев удалял старые данные.
cache_evictions_history: (объект) Содержит недавнюю историю удалений из кэша сценариев.

Свойства cache_evictions

5m: (длинное целое число) Количество удалений из кэша сценариев за последние пять минут.
15m: (длинное целое число) Количество удалений из кэша сценариев за последние пятнадцать минут.
24h: (длинное целое число) Количество удалений из кэша сценариев за последние сутки.

compilation_limit_triggered: (целое число) Общее количество раз, когда механизм защиты от отказов компиляции сценариев ограничивал инлайновые компиляции сценариев.

Примеры

resp = client.cluster.info(
    target="_all",
)
print(resp)

resp1 = client.cluster.info(
    target="http",
)
print(resp1)

resp2 = client.cluster.info(
    target="ingest",
)
print(resp2)

resp3 = client.cluster.info(
    target="thread_pool",
)
print(resp3)

resp4 = client.cluster.info(
    target="script",
)
print(resp4)

resp5 = client.cluster.info(
    target="http,ingest",
)
print(resp5)

response = client.cluster.info(
  target: '_all'
)
puts response

response = client.cluster.info(
  target: 'http'
)
puts response

response = client.cluster.info(
  target: 'ingest'
)
puts response

response = client.cluster.info(
  target: 'thread_pool'
)
puts response

response = client.cluster.info(
  target: 'script'
)
puts response

response = client.cluster.info(
  target: 'http,ingest'
)
puts response

const response = await client.cluster.info({
  target: "_all",
});
console.log(response);

const response1 = await client.cluster.info({
  target: "http",
});
console.log(response1);

const response2 = await client.cluster.info({
  target: "ingest",
});
console.log(response2);

const response3 = await client.cluster.info({
  target: "thread_pool",
});
console.log(response3);

const response4 = await client.cluster.info({
  target: "script",
});
console.log(response4);

const response5 = await client.cluster.info({
  target: "http,ingest",
});
console.log(response5);

# returns all stats info of the cluster
GET /_info/_all

# returns the http info of the cluster
GET /_info/http

# returns the http info of the cluster
GET /_info/ingest

# returns the thread_pool info of the cluster
GET /_info/thread_pool

# returns the script info of the cluster
GET /_info/script

# returns the http and ingest info of the cluster
GET /_info/http,ingest

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-info.html