ライブステータスによるステータスデータの取得

ライブステータスへのアクセスは、Unix ソケットを使用して ライブステータスクエリ言語 (LQL) によって行われます。その構文は HTTP に基づいています。

コマンドラインから、インターフェースにアクセスする方法はいくつかあります。 その 1 つは、printf およびunixcat コマンドを使用して ソケットに指示を送信する方法です。unixcat ツールは、インスタンスユーザー用に Checkmk にすでに含まれています。重要：ソケットへの入力は 大文字と小文字が区別されるため、常に次の点に注意してください。

インターフェースは、すべてのコマンドとヘッダーを別々の行で入力することを期待しています。 このような改行は、\n でマークすることができます。上記のコマンドの代わりに、lq スクリプトコマンドを使用することもできます。このコマンドを使用すると、入力時に一部のフィールドが自動補完されるため、 作業が少し楽になります。

または、対話型入力ストリームを開始し、コマンドの後に ヘッダーを入力することもできます。空白行を入力すると、そのコマンドがヘッダーとともに実行され 、さらに次の行を入力すると、ソケットへのアクセスが終了します。この例では 、空白行の前の部分はすべてコマンドに属し、 1 行目と 2 行目の空白行の間の部分は応答です。

以下の例は、常にlq コマンドで実行されます。クエリが短い場合は直接 フォームで、長いクエリの場合はエントリストリームとして実行されます。

Checkmk は Python を多用しているため、この言語のスクリプトが実用的です。 以下のスクリプトは、ライブステータスソケットへのアクセス用の基礎として使用できます。

Checkmk は、Python、Perl、C++ プログラミング言語用の API を提供しており 、ライブステータスへのアクセスを簡略化しています。各言語の 使用方法を説明するサンプルコードが用意されています。これらのサンプルのパスは 「ファイルとディレクトリ」の章に記載されています。

これまでの例では、すべてのホストのすべての情報をクエリしていました。 しかし、実際には、特定の列のみが必要になる場合が多いでしょう。 すでに述べたColumns ヘッダーを使用すると、出力をこの列に限定することができます。 個々の列名は、単純な空白文字で区切られます。

ご覧のとおり、1 行内で個々の値はセミコロンで区切られています。

重要：これらのヘッダーを使用する場合、出力からヘッダーが省略されます。 ColumnHeadersヘッダーを使用することで、出力にヘッダーを再挿入できます。

クエリを特定の行に制限するには、指定した内容に基づいて列をフィルタリングすることができます。 特定のステータスのサービスのみを検索する場合は、フィルタを使用して実現できます。 例

この例では、CRIT ステータスのすべてのサービスが検索され 、ホスト名、サービス内容、およびステータスが出力されます。 このようなフィルタは、もちろん組み合わせることもでき、CRIT ステータスで、まだ承認されていないサービスに制限することもできます。

Columns にリストされていない列でもフィルタリングできることがわかります。

ヘッダー「OrderBy 」を使用すると、任意の列の内容、あるいは辞書キーの値に応じて出力を並べ替えることができます。 これにより、たとえば、すべてのホストをアルファベット順のリストを作成することができます。

暗黙的に、出力は期待どおり昇順（asc ）でソートされます。 ただし、desc` を指定することで、希望するソートを明示的に指定したり、ソートを逆順に変更したりすることもできます。

クエリを少し長くして、たとえばパフォーマンスデータでソートすると、興味深いランキングリストを作成できます。 次の例では、ホストがアップタイムの降順で表示されています。

テーブルの一部の列は、単一の値ではなく、その値のリスト全体を返します。 このようなリストを効果的に検索できるように、これらの場合、 オペレーターには別の機能があります。オペレーターの完全なリストは、 リストのオペレーターを参照してください。 たとえば、オペレーター「>= 」には「contains」という機能があります。これを使用すると、 たとえば、特定の連絡先を検索することができます。

上記の例のように、連絡先はコンマで区切られてcontacts 列にリストされます。これにより、別の列の先頭ではないことが明確に区別できます。 等価演算子の特別な機能は、リストが空であるかどうかをチェックすることです。 4.2. フィルタの組み合わせ

いくつかのフィルタは、すでに組み合わせています。直感的には 、データが表示されるためには、すべてのフィルタを通過しなければならないと思われるでしょう。 フィルタは、論理演算子and で連結されます。 特定のフィルタを論理和でリンクするには、フィルタ 文字列コードの最後にor:の後に整数を入力します。カウンターは、 最後の行のうち、or で組み合わせることができる行の数を指定します。この方法により、グループ を必要に応じて形成および組み合わせることができます。以下は簡単な例です。 ここでは、2 つのフィルタが組み合わされ、ステータスがWARN またはUNKNOWNのすべてのサービスが表示されます。

組み合わせの結果を否定したり、グループをさらに 他のグループと組み合わせることもできます。この例では、ステータスがOK でなく、説明がFilesystem で始まる、または UNKNOWN 以外のステータスを持つすべてのサービスが表示されます。

出力フォーマットは 2 つの方法で指定できます。 1 つの方法は、標準出力で使用される区切り文字を再定義することです。 もう 1 つの方法は、Python または JSON フォーマットに準拠して出力することです。

単一のサービスまたはサービスのグループの状態には興味がない場合もあります。 はるかに重要なのは、現在のWARN 状態にあるサービスの数、または監視されているデータベースの数です。 ライブステータスは、Stats を使用して統計情報を生成および出力することができます。 5.2. 数値

Overview は、ホスト、 サービス、およびイベントの統計情報を Livestatus から取得し、Checkmk のインターフェースに表示することでデータを受け取ります。 Livestatus に直接アクセスすることで、独自の要約を作成することができます。

なお、このような統計情報はすべてのフィルターと組み合わせることができます。

統計は、and/or と組み合わせることもできます。その場合、ヘッダーはStatsAnd またはStatsOr と呼ばれます。出力を逆にする場合は、StatsNegate を使用してください。 この例では、ホストの総数 （最初のStats ）が出力され、さらに、stale とマークされ、かつダウンタイムにリストされていないホストの 数も出力されます （Stats 2 と 3 は論理「AND」でリンクされています）。

フィルタと統計の結果を組み合わせるさまざまなオプションについて、混乱しないでください。 条件を満たすすべてのホストは、 ヘッダーを使用して出力されますが、統計情報を含む出力は xml-ph-0000@deepl.internal フィルタが適用される頻度の合計になります。Filterヘッダーを使用して出力されます。統計では、出力はStats フィルターが適用される頻度の合計になります。

値に対して計算を行い、たとえば 平均値や最大値を出力することもできます。使用可能なすべてのオペレーターの完全なリストは こちらをご覧ください。

次の例では、ホストのチェックプラグインがステータスの計算に要した平均、最小、 最大時間をリストで出力します。

メトリックを使用した計算は、やや特殊な方法でハンドルされます。 ここでも、Stats ヘッダーのすべての関数を使用できます。 ただし、これらはサービスのすべてのメトリックに 個別に適用されます。 たとえば、次の例では、ホストグループの CPU 使用率のメトリックが 合計されます。

ライブステータスのlog テーブルを使用すると、コアの監視ヒストリーに直接アクセスできます。 そのため、LQL を使用して特定のイベントを簡単にフィルタリングすることができます。 たとえば、可用性テーブルは、これらのテーブルを使用して生成されます。 概要を明確にし、クエリを主題ごとに制限するために、次のログクラスにアクセスできます。

これらのログクラスを使用するだけで、 表示するエントリのタイプを非常にうまく制限することができます。 クエリで考慮される時間範囲もさらに制限されます。 これは、そうしないと、インスタンスの完全なヒストリーが検索され 、情報の洪水によりシステムに論理的に大きなブレーキがかかる可能性があるため、重要です。

出力の制限としてさらに有効なのは、エントリに表示する (Columns) です。 以下の例では、過去 1 時間に 記録されたすべての通知を検索します。

重要：エントリストリームの対話モードでは、 例で使用されている変数は使用できないことを確認し、 クエリは常に時間範囲に制限してください。

ファイルのローテーションおよび最大サイズを変更することができます。 さらに、Checkmk が中断する前にファイルから読み込む行数を指定することもできます。 これらはすべて、インスタンスの構成に応じて、クエリのパフォーマンスに影響を与える可能性があります。 以下の 3 つのパラメータを使用できます。 これらのパラメータは、Setup > General > Global Settings > Monitoring Core で確認およびカスタマイズできます。

ネットワーク経由でライブステータスにアクセスするには、ライブステータスプロセスの Unix ソケットを TCP ポートに接続します。 これにより、リモートマシンでスクリプトを実行し、データを処理すべき場所から直接収集することができます。

サイトがオフになっている場合、TCP 経由のアクセスは、次のコマンドで有効にできます。omd コマンド：

サイトが起動すると、通常、TCP 経由のライブステータスはデフォルトのポート 6557 でアクティブになります。 TCP 経由のライブステータスを使用するサイトが複数ある Checkmk サーバーでは、次に高い未使用のポートが選択されます。

ポートや認可された IP アドレスなどのすべての設定は、omd config で設定できます。 または、これらの設定はセットアップで行うこともできます。 Checkmk では、ライブステータス通信の SSL 暗号化はデフォルトで有効になっています。

ローカルネットワーク外からライブステータスにアクセスする必要がある場合、IP アドレスのみによるアクセス保護では不十分な場合があります。 この場合に認証されたアクセス権を取得する最も簡単な方法は、Secure Shell を使用することです。

SSH を使用すると、リモートサーバーで実行されるコマンドを渡すことができます。

あるいは、SSH トンネルを介して、Livestatus ポートを現在作業しているホストに転送することもできます。

接続が確立されたら、2 番目のコンソールセッションで、openssl s_client によるアクセスが可能かどうかをテストできます。

このテストが成功すれば、Livestatus ネットワークに直接アクセスするために作成したスクリプトは、localhost で使用できます。

ライブステータスは、データクエリだけでなく 、コア（CMC または Nagios）に直接コマンドを発行するためにも使用できます。 正しいコマンドには、必ずタイムスタンプが含まれます。これは、実際には必要なものなら何でもかまいません。 ただし、ログでプロセスの実行時間を追跡するために追加で使用されるため 、できるだけ正確な時刻を入力することをお勧めします。 タイムスタンプが欠落しているコマンドは、エラーメッセージを表示せずに破棄され 、ログに単純なエントリが記録されます。 cmc.log!

タイムスタンプをできるだけ正確にするため、コマンドは入力ストリームで設定せず、直接発行することをお勧めします。 このような場合、変数にもアクセスでき、実際の現在の 時刻を指定することができます。 この形式は、Checkmk Raw の Nagios-Core と、商用版の CMC の両方で機能します。

このフォーマットは、Checkmk Rawの Nagios-Core と、商業版の CMC の両方で機能します。 ただし、2 つのコアでは、コマンドは部分的にしか重複していません。 Nagios-Core のコマンドの完全なリストは、Nagios のweb サイトに直接掲載されています。 CMC で使用できるコマンドは、 コマンドリファレンス

コマンドのリストでは、構文は次のフォームになっています。

ご存じのとおり、Checkmk ではコマンドの発行にはよりシンプルな形式を使用しています。 Nagios 形式を Checkmk と互換性のある形式にするには、コマンド、タイムスタンプ、および必要に応じて変数 を指定するだけです。