私のブックマーク
ブックマークを追加
ブックマークを削除フォロワースタッツAPI
クロスクラスターレプリケーションフォロワースタッツを取得します。
リクエスト
Python
resp = client.ccr.follow_stats(index="<index>",)print(resp)
Js
const response = await client.ccr.followStats({index: "<index>",});console.log(response);
コンソール
GET /<index>/_ccr/stats
前提条件
- Elasticsearchのセキュリティ機能が有効になっている場合、フォロワーインデックスを含むクラスターに対して
monitorクラスター権限を持っている必要があります。詳細については、セキュリティ権限を参照してください。
説明
このAPIはフォロワースタッツを取得します。このAPIは、指定されたインデックスに関連する各シャードのフォロワーに関するタスクのシャードレベルのスタッツを返します。
パスパラメータ
<index>- (必須、文字列) インデックスパターンのカンマ区切りリスト。
クエリパラメータ
timeout- (オプション、時間) 結果を待つ時間の量を制御します。デフォルトは無制限です。
レスポンスボディ
indices- (配列) フォロワーインデックス統計の配列。
- `````fatal_exception
- (オブジェクト) フォロワータスクをキャンセルした致命的な例外を表すオブジェクト。この状況では、フォロワータスクはフォロワー再開APIで手動で再開する必要があります。
index- (文字列) フォロワーインデックスの名前。
total_global_checkpoint_lag- (長整数) フォロワーがリーダーに対してどれだけ遅れているかを示します。これは、すべてのシャードに対する
leader_global_checkpointとfollower_global_checkpointの差の合計です。 shards- (配列) シャードレベルのフォロワータスク統計の配列。
- `````bytes_read
- (長整数) リーダーから読み取った転送バイトの合計。
これは推定値であり、圧縮が有効な場合は考慮されません。 failed_read_requests- (長整数) 失敗した読み取りの数。
failed_write_requests- (長整数) フォロワーで実行された失敗したバルク書き込みリクエストの数。
follower_aliases_version- (長整数) フォロワーが同期しているインデックスエイリアスのバージョン。
follower_global_checkpoint- (長整数) フォロワーの現在のグローバルチェックポイント。
leader_global_checkpointとfollower_global_checkpointの差は、フォロワーがリーダーに対してどれだけ遅れているかを示します。 follower_index- (文字列) フォロワーインデックスの名前。
follower_mapping_version- (長整数) フォロワーが同期しているマッピングバージョン。
follower_max_seq_no- (長整数) フォロワーの現在の最大シーケンス番号。
follower_settings_version- (長整数) フォロワーが同期しているインデックス設定のバージョン。
last_requested_seq_no- (長整数) リーダーから要求された最後のバッチの開始シーケンス番号。
leader_global_checkpoint- (長整数) フォロワータスクが知っているリーダーの現在のグローバルチェックポイント。
leader_index- (文字列) フォローされているリーダークラスター内のインデックスの名前。
leader_max_seq_no- (長整数) フォロワータスクが知っているリーダーの現在の最大シーケンス番号。
operations_read- (長整数) リーダーから読み取った操作の合計数。
operations_written- (長整数) フォロワーで書き込まれた操作の数。
outstanding_read_requests- (整数) フォロワーからのアクティブな読み取りリクエストの数。
outstanding_write_requests- (整数) フォロワーでのアクティブなバルク書き込みリクエストの数。
read_exceptions- (配列) 失敗した読み取りを表すオブジェクトの配列。
read_exceptionsのオブジェクトのプロパティ exception- (オブジェクト) 読み取りが失敗した原因となった例外を表します。
from_seq_no- (長整数) リーダーから要求されたバッチの開始シーケンス番号。
retries- (整数) バッチが再試行された回数。
remote_cluster- (文字列) リーダーインデックスを含むリモートクラスター。
shard_id- (整数) 数値シャードID、値は0からレプリカの数-1まで。
successful_read_requests- (長整数) 成功したフェッチの数。
successful_write_requests- (長整数) フォロワーで実行されたバルク書き込みリクエストの数。
time_since_last_read_millis- (長整数) リーダーに読み取りリクエストが送信されてからのミリ秒数。
フォロワーがリーダーに追いつくと、この数は設定されたread_poll_timeoutまで増加し、その時点で別の読み取りリクエストがリーダーに送信されます。 total_read_remote_exec_time_millis- (長整数) リモートクラスターでの読み取りに費やされた合計時間。
total_read_time_millis- (長整数) 読み取りが未解決だった合計時間、読み取りがリーダーに送信されてからフォロワーに応答が返されるまでの時間を測定します。
total_write_time_millis- (長整数) フォロワーでの書き込みに費やされた合計時間。
write_buffer_operation_count- (整数) フォロワーでキューに入れられた書き込み操作の数。
write_buffer_size_in_bytes- (長整数) 現在書き込みのためにキューに入れられている操作の合計バイト数。
例
この例はフォロワースタッツを取得します：
Python
resp = client.ccr.follow_stats(index="follower_index",)print(resp)
Js
const response = await client.ccr.followStats({index: "follower_index",});console.log(response);
コンソール
GET /follower_index/_ccr/stats
コンソール-結果
{"indices" : [{"index" : "follower_index","total_global_checkpoint_lag" : 256,"shards" : [{"remote_cluster" : "remote_cluster","leader_index" : "leader_index","follower_index" : "follower_index","shard_id" : 0,"leader_global_checkpoint" : 1024,"leader_max_seq_no" : 1536,"follower_global_checkpoint" : 768,"follower_max_seq_no" : 896,"last_requested_seq_no" : 897,"outstanding_read_requests" : 8,"outstanding_write_requests" : 2,"write_buffer_operation_count" : 64,"follower_mapping_version" : 4,"follower_settings_version" : 2,"follower_aliases_version" : 8,"total_read_time_millis" : 32768,"total_read_remote_exec_time_millis" : 16384,"successful_read_requests" : 32,"failed_read_requests" : 0,"operations_read" : 896,"bytes_read" : 32768,"total_write_time_millis" : 16384,"write_buffer_size_in_bytes" : 1536,"successful_write_requests" : 16,"failed_write_requests" : 0,"operations_written" : 832,"read_exceptions" : [ ],"time_since_last_read_millis" : 8}]}]}
