ローカルチェック

ローカルチェックは、ターゲットホストがサポートする任意のプログラミング言語で記述できます。 スクリプトは、各チェックが 4 つの部分で構成される状態行を生成するように作成する必要があります。 以下に例を示します。

4つの部分は空白で区切られ、以下の意味を持ちます:

この出力の 4 つの部分の間には、必ず正確に 1 つのスペース（ASCII0x20 ）を挿入する必要があります。 状態の詳細内では、スペースを任意の順序で使用できます。

出力の結果が不明な場合は、echo コマンドを使用して小さなスクリプトを作成して、簡単にテストすることができます。 テストしたい出力をecho コマンドに挿入します。 この例では、外部には二重引用符を使用しています。これは、内部変数 (環境変数およびスクリプトで設定された変数) が評価されるためです。 その結果、サービス名の引用符は、シェルによって文字列の終わりと始まりとして解釈されて（したがって出力から削除されて）しまわないように、\ で囲む必要があります。

Windows ホストの場合、このようなスクリプトは次のように表示されます。

どちらのスクリプトも、出力結果は同じになります。

Checkmk では、この出力のみ関連があり、この出力をどのように作成したかは関係ありません。

ちなみに、スクリプトには任意の数の出力を記述することができます。 各出力行には、Checkmk で独自のサービスが作成されます。 そのため、Checkmkで複数行の出力を行う場合など、マスクされていない限り、出力に改行文字は使用できません。

ローカルスクリプトがエージェントによって正しく呼び出されているかどうかを、エラー分析で確認できます。

スクリプトが作成されたら、それを適切なホストに配布することができます。 使用するパスは、オペレーティングシステムによって異なります。 パス名のリストは、以下の「ファイルおよびディレクトリ」に記載されています。

Unix 系システムでは、スクリプトを実行可能にすることを忘れないでください。 この例で示しているパスは、Linux (デフォルト設定のエージェントパッケージ) 用のものです。

エージェントベーカリーを使用する場合、スクリプトはルールベースの手順で配布できます。 ルールの作成の詳細については、「エージェントベーカリーによる配布」の章をご覧ください。

Checkmk エージェントが起動されるたびに、スクリプトに含まれるローカルチェックも実行され、エージェントの出力に追加されます。 サービスディスカバリーも、他のサービスと同様に自動的に機能します。

サービスが監視に追加され、変更がアクティブになると、ローカルチェックによる自己作成サービスの実装は完了です。 サービスディスカバリー中に問題が発生した場合は、エラー分析が役立ちます。

ローカルチェックでメトリックを定義することもできます。 メトリックデータの最短の構文は次のとおりです。

ここで、value は現在の値です。

メトリックデータの完全な構文は次のとおりです。

ここで、warn およびcrit は（上限）閾値です。 これらの閾値をグラフに表示するには、動的計算を有効にする必要があります（状態P ）。 その後、Checkmk を使用して状態が計算されます。min およびmax で最後に指定したパラメータによって、値の範囲が固定されます。

完全な例は以下のようになります:

値はセミコロンで区切られます。 値が不要な場合は、フィールドを空のままにしたり、末尾で省略したりします。例えば、warn 、crit 、max の場合：

ローカルチェックのメトリック定義は、他のタイプのチェックのメトリック定義と変わりません。 最終的には、メトリックに単位とわかりやすい名前を割り当てるには、 3 つの選択肢があります。

複数のメトリックを出力することもできます。 定義では、これらは「パイプ」文字 (|) で区切られます。例えば、次のように記述します。

Windows ホストでは、これらのパイプが出力にも表示されるように、スクリプトでこれらのパイプの前にサーキュムフレックス (^) を付ける必要があります。

2 つのメトリックを含む完全な出力は、次のように表示されます。

新しいサービスを監視に追加すると、サービスリストの「Summary 」フィールドに、状態の詳細に関するテキストが表示されます。 サービスをクリックすると、そのサービスの詳細ページが表示されます。 メトリックは「Details 」フィールドに表示され、その下には Checkmk によって自動的に生成されたサービスのグラフが表示されます。

前のセクションでは、メトリックの値を提供し、それを使用してグラフを生成する方法を学びました。 次のステップは、追加で渡された閾値を使用して、サービスの状態を動的に計算することです。 これはまさに、プラグインによって生成される多くの状態と、受信したデータの準備を一致させるために Checkmk が実現している機能です。

状態を決定する出力の最初のフィールドに、数値ではなく文字「P 」を渡すと、渡された閾値に基づいてサービス状態が計算されます。 実際の値に加えて、転送された閾値もグラフに黄色と赤色の線で表示されます。

出力は次のように表示されます:

… サービスビューでの表示は次のようになります。

この表示は、以前の表示と2点異なります：

一部のパラメータには、上限閾値だけでなく下限閾値も設定されています。 その一例が、湿度記録です。 このような場合、ローカルチェックでは、WARN およびCRIT 状態それぞれについて 2 つの閾値を渡すオプションが用意されています。 これらはコロンで区切られ、それぞれ下限閾値と上限閾値を表します。

一般的な構文では、次のように表示されます。

… 例では次のように表示されます:

… サービスビューの表示では、次のように表示されます。

下限の閾値のみに関心がある場合は、上限の閾値のフィールドを省略してください。

この出力では、値が 40 未満の場合はWARN 、30 未満の場合はCRIT になるようサービスを指定しています。 したがって、指定した値が 37 の場合、サービスはWARN 状態になります。

出力を複数行に分割するオプションも利用できます。 Checkmk は Linux で動作するため、エスケープシーケンス'\n' を使用して、改行を強制することができます。 スクリプト言語の都合でバックスラッシュ自体をエスケープする必要がある場合でも、Checkmk はそれを正しく解釈します。

サービスの詳細では、これらの追加行は「Summary 」の下に表示されます。

Linux またはその他の Unix 系オペレーティングシステムでは、あらゆるプラグインを非同期で実行できます。 ローカルチェックの場合、必要な設定はプラグインの場合とよく似ています。 これを行うには、出力をキャッシュする秒数と同じ名前のサブディレクトリを作成し、そのサブディレクトリにスクリプトを配置します。

次の例では、ローカルチェックは 10 分（600 秒）ごとにのみ実行されます。

キャッシュされたデータは、キャッシュディレクトリに書き込まれます。

キャッシュされたデータを提供するサービスの場合、キャッシュ固有の情報がサービスビューに追加されます。

Windows でも、設定はエージェントプラグインの場合と同様です。 Linux などでは特別なサブディレクトリを使用しますが、Windows では、設定ファイルでオプションを設定します。

上記のように、Windows では、非同期実行 (async) と時間間隔 (cache_age) を個別に設定できます。

あるいは、Windows では、エージェントベーカリーで設定を行うこともできます。

自作のスクリプトで問題が発生した場合は、以下の潜在的なエラーの原因をチェックしてください。

スクリプト自体に問題がない場合は、エージェントをホストで実行できます。 Linux、BSD などの Unix 系オペレーティングシステムでは、以下のコマンドを使用できます。-A オプションを使用すると、ヒット後に表示する追加行数を指定できます。 この数は、予想される出力行数に合わせてカスタマイズできます。

最後の行では、現在の Unix 時間と実行間隔（秒単位）が記載された「cached 」という情報によって、キャッシュされたサービスを認識できます。

Windows では、Linux のgrep コマンドとよく似た結果を、パワーシェルとSelect-String コマンドレットを使用して実現できます。次のコマンドでは、Context パラメータの後の2桁の数字で、ヒットの前後に出力する行数を指定します。

最後のステップとして、cmk コマンドを使用して、Checkmk サーバーでスクリプト出力の処理をテストすることもできます。サービスディスカバリーでは 1 回、

... また、同様のコマンドを使用して、サービス出力の処理もテストできます。

両方のコマンドでは、このトピックに関係のない行を省略して出力を短縮しています。

あるいは 、監視でホストのサービスリストを開き、サービスCheck_MK とその列Icons に移動します。 そこで、メニューエントリDownload agent output を選択して、エージェントの出力全体を含むテキストファイルを取得することができます。

ローカルチェックでエラーが発生した場合、Checkmk はサービス出力でそれらを識別します。 これは、誤ったメトリック、スクリプト出力の誤った情報または不完全な情報、および無効な状態にも適用されます。 これらのエラーメッセージは、スクリプトのエラーを迅速に特定するのに役立ちます。

ローカルチェックは、これらのディレクトリに保存します。 ローカルチェックは、任意の実行可能ファイルにすることができます。

local セクションを含む個々のセクションのキャッシュデータはここに保存され、データが有効である限り、実行ごとにエージェントに再アタッチされます。