3 ローレベルディスカバリ

概要

ローレベルディスカバリは、コンピューター上のさまざまなエンティティのアイテム、トリガー、およびグラフを自動的に作成する方法を提供します。 たとえば、Zabbixは各ファイルシステムまたはネットワークインターフェイスのアイテムを手動で作成しなくても、マシン上のファイルシステムまたはネットワークインターフェイスの監視を自動的に開始できます。 さらに、定期的に実行されるディスカバリの結果に基づいて、不要なエンティティを自動的に削除するようにZabbixを設定することができます。

ユーザーは特定のJSONプロトコルに基づいて独自のディスカバリを定義できます。

検出プロセスの一般的なアーキテクチャは次のとおりです。

まずユーザーは"設定"→ "テンプレート" → "ディスカバリ"列でディスカバリルールを作成します。 ディスカバリルールは、（1）必要なエンティティ（ファイルシステムやネットワークインターフェイスなど）を検出するアイテムと、（2）アイテムの値に基づいて作成する必要のあるアイテム、トリガー、グラフのプロトタイプで構成されます。

必要なエンティティを検出するアイテムは、他の場所で見られる通常のアイテムのようなものです。サーバーはZabbixエージェント（またはアイテムのタイプが設定されているもの）にそのアイテムの値を要求し、エージェントはテキスト値で応答します。 違いは、エージェントが応答する値には、検出されたエンティティのリストがJSON形式で含まれている必要があることです。 この形式の詳細は、カスタムディスカバリチェックの実装者にとってのみ重要ですが、戻り値にはマクロ→値のペアのリストが含まれていることを知っておく必要があります。 たとえば、アイテム"net.if.discovery"は"{#IFNAME}" → "lo"と"{#IFNAME}" → "eth0"の2つのペアを返す場合があります。

これらのマクロは、名前、キー、およびその他のプロトタイプフィールドで使用され、検出された各エンティティの実際のアイテム、トリガー、グラフ、さらにはホストを作成するために、受け取った値に置き換えられます。 ローレベルディスカバリマクロの使用についてはオプションのリストを参照してください。

サーバーは検出したアイテムの値を受け取ると、マクロ→値のペアを確認し、ペアごとにプロトタイプに基づいて実際のアイテム、トリガー、およびグラフを生成します。 上記の"net.if.discovery"の例では、サーバーはループバックインターフェイス"lo"用のアイテム、トリガー、およびグラフの1つのセットと、インターフェイス"eth0"用の別のセットを生成します。

Zabbix 4.2以降、ローレベルディスカバリルールによって返されるJSONの形式が変更されていることに注意してください。 JSONに"データ"オブジェクトが含まれることはもはや期待されていません。 ローレベルディスカバリは、JSONドキュメント内のローレベルディスカバリマクロ値へのアイテム値の前処理やカスタムパスなどの新機能をサポートするために、配列を含む通常のJSONを受け入れるようになりました。

組み込みのディスカバリキーが更新され、JSONドキュメントのルートにあるローレベルディスカバリ行の配列が返されるようになりました。 配列フィールドで{#MACRO}構文がキーとして使用されている場合、Zabbixはマクロと値を自動的に抽出します。 新しいネイティブディスカバリチェックでは"データ"要素なしで新しい構文が使用されます。 ローレベルディスカバリの値を処理する場合、最初にrootが特定されます（$.または$.dataの配列）。

"data"要素はディスカバリに関連するすべてのネイティブアイテムから削除されていますが、下位互換性のためにZabbixは"data"要素を含むJSON表記を引き続き受け入れます。ですがその使用は推奨されていません。 JSONに"data"配列要素が1つしかないオブジェクトが含まれている場合、JSONPath$.dataを使用して要素のコンテンツを自動的に抽出します。 ローレベルディスカバリはJSONPath構文で指定されたカスタムパスを持つオプションのユーザー定義ローレベルディスカバリマクロを受け入れるようになりました。

参照：検出されたエンティティ

ローレベルディスカバリの設定

ファイルシステム検出の例に基づいて、ローレベルディスカバリについて説明します。

次の手順でディスカバリを構成します。

• 設定 → テンプレートまたはホストを開く
• 適当なテンプレートまたはホストのディスカバリ行をクリックする

• 画面右上にあるディスカバリルールの作成をクリックする
• ディスカバリルールフォームに必要な詳細を記入します

ディスカバリルール

ディスカバリルールフォームには、ディスカバリ中のデータフローを左から右に表す5つのタブが含まれています。

• ディスカバリルール - 最も重要なこととして、検出されたデータを取得するための組み込みアイテムまたはカスタムスクリプトを指定します
• 保存前処理 - 検出されたデータに前処理を適用します
• LLDマクロ - 検出されたアイテム、トリガーなどで使用するいくつかのマクロ値を設定できます
• フィルター - 検出された値をフィルタリングできます
• オーバーライド - 特定の検出されたオブジェクトに適用するときに、アイテム、トリガー、グラフ、またはホストプロトタイプを変更できます。

ディスカバリルールタブには、検出に使用するアイテムキー（およびいくつかの一般的なディスカバリルール属性）が含まれています。

すべての必須入力フィールドは、赤いアスタリスクでマークされています。

保存前処理

保存前処理タブでは、検出結果に適用する変換ルールを定義できます。 このステップでは、1つまたは複数の変換が可能です。 変換は定義された順序で実行されます。 すべての保存前処理はZabbixサーバーによって行われます。

参照：

• 保存前処理の詳細
• 保存前処理のテスト

テンプレートを介してディスカバリルールがホストに適用されている場合、このタブのコンテンツは読み取り専用であることに注意してください。

LLDマクロ

LLDマクロタブではカスタマイズしたローレベルディスカバリマクロを指定できます。

カスタムマクロは、返されたJSONに必要なマクロがまだ定義されていない場合に役立ちます。 例：

• ファイルシステム検出用のネイティブのvfs.fs.discoveryキーは{#FSNAME}、{#FSTYPE}などの事前定義されたLLDマクロを含むJSONを返します。 これらのマクロは、アイテムで使用でき、プロトタイプをトリガーします（ページの後続のセクションを参照）。 カスタムマクロを定義する必要はありません。
• vfs.fs.getエージェントアイテムはファイルシステムデータを含むJSONを返しますが、事前定義されたLLDマクロはありません。 この場合マクロを自分で定義し、JSONPathを使用してJSONの値にマップすることができます。

抽出された値は、ディスカバリアイテム、トリガーなどで使用できます。値は、検出の結果とこれまでの前処理ステップから抽出されることに注意してください。

フィルター

フィルタを使用して、条件に一致するエンティティのアイテム、トリガー、およびグラフを生成できます。フィルタータブには、検出値をフィルター処理できる検出ルールフィルター定義が含まれています。

オーバーライド

オーバーライドタブでは、アイテム、トリガー、グラフ、ホストのプロトタイプのリスト、または特定の条件を満たす検出されたオブジェクトの属性をルールに基づいて変更できます。

オーバーライドは、（存在する場合）並べ替え可能なドラッグアンドドロップリストに表示され、定義された順序で実行されます。 新しいオーバーライドの詳細を構成するには、オーバーライドブロックの をクリックします。既存のオーバーライドを編集するには、オーバーライド名をクリックすると、 ポップアップウィンドウが開き、オーバーライドルールの詳細を編集できます。

必須パラメーターは赤いアスタリスクでマークされています。

実行内容の設定

新しい実行内容を設定するには、実行内容ブロックのをクリックします。 既存の実行内容を編集するには各実行内容のをクリックすると詳細を編集できるポップアップウィンドウが開きます。

パラメータ			説明
オブジェクト			次の4種類のオブジェクトを使用できます。 アイテムのプロトタイプ トリガーのプロトタイプ グラフのプロトタイプ ホストプロトタイプ
トリガー条件式			操作を適用する必要があるエンティティをフィルタリングします。
	条件式		サポートされている条件： 等しい - パターンと等しいプロトタイプに適用 等しくない - パターンと等しくないプロトタイプに適用 含む - プロトタイプ名に文字列パターンが含まれる場合に適用 含まない - プロトタイプ名に文字列パターンが含まれていない場合は適用 一致する - プロトタイプ名がパターン内の正規表現と一致する場合は適用します 一致しない - プロトタイプ名がパターン内の正規表現と一致しない場合に適用
	パターン		正規表現または検索する文字列
	オブジェクト：アイテムのプロトタイプ
		自動生成時のステータス有効	チェックボックスをオンにするとボタンが表示され、元のアイテムのプロトタイプ設定を上書きできます。 はい - アイテムは有効な状態で追加されます。 いいえ - アイテムは検出されたエンティティに追加されますが、無効な状態になります。
		ディスカバリ	チェックボックスをオンにするとボタンが表示され、元のアイテムのプロトタイプ設定を上書きできます。 はい - アイテムが追加されます。 いいえ - アイテムは追加されません。
		監視間隔	チェックボックスをオンにすると2つのオプションが表示され、アイテムに異なる監視間隔を設定できます。 間隔 - アイテムの更新間隔。 ユーザーマクロおよびタイムサフィックス（例：30s,1m,2h,1d）がサポートされています。 監視間隔のカスタマイズを使用する場合は0に設定する必要があります。 監視間隔のカスタマイズ - をクリックして、柔軟なスケジュール間隔を指定します。 詳細については、監視間隔のカスタマイズを参照してください。
		ヒストリの保存期間	チェックボックスをオンにするとボタンが表示され、異なるヒストリの保存期間を設定できます。 ヒストリを保存しない - ヒストリは保存されません。 保存期間 - 選択すると保存期間を指定するための入力フィールドが右側に表示されます。 ユーザーマクロとLLDマクロがサポートされています。
		トレンドの保存期間	チェックボックスをオンにするとボタンが表示され、異なるトレンドの保存期間を設定できます。 トレンドを保存しない - トレンドは保存されません。 保存期間 - 選択すると保存期間を指定するための入力フィールドが右側に表示されます。 ユーザーマクロとLLDマクロがサポートされています。
		タグ	チェックボックスをオンにすると新しいブロックが表示され、タグと値のペアを指定できます。 これらのタグはタグ名が一致していても、アイテムのプロトタイプで指定されたタグに追加されます。
	オブジェクト：トリガーのプロトタイプ
		自動生成時のステータス有効	チェックボックスをオンにするとボタンが表示され、元のトリガーのプロトタイプ設定を上書きできます。 はい - トリガーは有効な状態で追加されます。 いいえ - トリガーは検出されたエンティティに追加されますが、無効な状態になります。
		ディスカバリ	チェックボックスをオンにすると、ボタンが表示され、元のトリガーのプロトタイプ設定を上書きできます。 はい - トリガーが追加されます。 いいえ - トリガーは追加されません。
		深刻度	チェックボックスをオンにするとトリガーの深刻度ボタンが表示され、深刻度を変更できます。
		タグ	チェックボックスをオンにすると新しいブロックが表示され、タグと値のペアを指定できます。 これらのタグはタグ名が一致していても、トリガープロトタイプで指定されたタグに追加されます。
	オブジェクト：グラフのプロトタイプ
		ディスカバリ	チェックボックスをオンにするとボタンが表示され、元のグラフのプロトタイプ設定を上書きできます。 はい - グラフが追加されます。 いいえ - グラフは追加されません。
	オブジェクト：ホストプロトタイプ
		自動生成時のステータス有効	チェックボックスをオンにするとボタンが表示され、元のホストプロトタイプ設定を上書きできます。 はい - ホストは有効な状態で追加されます。 いいえ - ホストは無効な状態で追加されます。
		ディスカバリ	チェックボックスをオンにするとボタンが表示され、元のホストプロトタイプ設定を上書きできます。 はい - ホストが検出されます。 いいえ - ホストは検出されません。
		テンプレートをリンク	チェックボックスをオンにするとテンプレートを指定するための入力フィールドが表示されます。 テンプレート名を入力するか、フィールドの横にある選択をクリックして、ポップアップウィンドウのリストからテンプレートを選択します。 ホストプロトタイプにリンクされているすべてのテンプレートは、このオーバーライドのテンプレートに置き換えられます。
		タグ	チェックボックスをオンにすると、新しいブロックが表示され、タグと値のペアを指定できます。 これらのタグは、タグ名が一致していても、ホストプロトタイプで指定されたタグに追加されます。
		ホストインベントリ	チェックボックスをオンにするとボタンが表示され、ホストプロトタイプの別のインベントリモードを選択できます。 無効 - ホストインベントリにデータを入力しない マニュアル - 詳細を手動で入力します 自動 - 収集されたメトリックに基づいてホストインベントリデータを自動入力します。

フォームボタン

フォームの下部にあるボタンを使用すると、いくつかの操作を実行できます。

	ディスカバリルールを追加します。 このボタンは新しいディスカバリルールでのみ使用できます。
	ディスカバリルールのプロパティを更新します。 このボタンは既存のディスカバリルールでのみ使用できます。
	現在のディスカバリルールのプロパティに基づいて、別のディスカバリルールを作成します。
	ディスカバリルールに基づいて検出をすぐに実行します。 ディスカバリルールはすでに存在している必要があります。詳細を参照してください。 注すぐに検出を実行すると、設定キャッシュは更新されないため、結果にはディスカバリルール設定の最近の変更が反映されません。
	ディスカバリルールを削除します。
	ディスカバリルールのプロパティ編集をキャンセルします。

検出されたエンティティ

以下のスクリーンショットは、検出されたアイテム、トリガー、およびグラフがホストの構成でどのように見えるかを示しています。 検出されたエンティティには、元のディスカバリルールへのオレンジ色のリンクがプレフィックスとして付けられます。

同じキーのアイテムや同じ名前のグラフなど、同じ一意性基準を持つ既存のエンティティがすでに存在する場合、検出されたエンティティは作成されないことに注意してください。この場合、フロントエンドにローレベルディスカバリルールが特定のエンティティを作成できなかったことを示すエラーメッセージが表示されます。ただ、一部のエンティティを作成できずにスキップする必要があったためであり、ディスカバリルール自体がサポートされなくなることはありません。 ディスカバリルールは、他のエンティティの作成/更新を続行します。

ローレベルディスカバリルールによって作成されたアイテム（同様に、トリガーとグラフ）は、検出されたエンティティ（ファイルシステム、インターフェイスなど）が検出されなくなった場合（またはフィルターを通過しなくなった場合）、アイテム、トリガー、およびグラフは存在しなくなったリソースの保持期間フィールドで定義された日数が経過するとに自動的に削除されます。

検出されたエンティティが「もう検出されていません」になると、アイテムリストに有効期間インジケータが表示されます。 マウスポインタをその上に移動すると、アイテムが削除されるまでの残り日数を示すメッセージが表示されます。

エンティティに削除のマークが付けられているが、予定された時間に削除されなかった場合（無効なディスカバリルールまたはアイテムホスト）次にディスカバリルールが処理されるときにエンティティは削除されます。

削除のマークが付けられている他のエンティティを含むエンティティは、ディスカバリルールレベルで変更されても更新されません。 たとえば、LLDベースのトリガーには、削除のマークが付けられたアイテムが含まれている場合、更新されません。

他のタイプの検出

次のセクションでは、他のタイプのすぐに使用可能な検出の詳細とハウツーを利用できます。

• ネットワークインターフェースの検出;
• CPUとCPUコアの検出;
• SNMP OIDsの検出;
• JMX オブジェクトの検出;
• ODBC SQL クエリを使った検出;
• Windows サービスの検出;
• Zabbixのホストインターフェース検出;

検出項目のJSON形式の詳細と、独自のファイルシステム検出器をPerlスクリプトとして実装する方法の例については、カスタムLLDルールの作成.を参照してください。

カスタムLLDルールの作成

データベース サーバー上のデータベースなど、あらゆる種類のエンティティを検出ための、完全カスタムの LLD ルールを作成することもできます。

そのためには、JSON を返すカスタム アイテムを作成し、見つかったオブジェクトとオプションでそれらのプロパティを指定する必要があります。 エンティティごとのマクロ数に制限はありません。組み込みのディスカバリルールは 1 つまたは 2 つのマクロ (たとえば、ファイル システム検出の場合は 2 つ) を返しますが、さらに多くのマクロを返すこともできます。

必要なJSON形式を例題で説明します。 古いZabbix1.8エージェント（"vfs.fs.discovery"をサポートしていないエージェント）を実行しているが、ファイルシステムを検出する必要があるとします。以下はマウントされたファイルシステムを検出し、ファイルシステム名とタイプの両方を含むJSONを出力するLinux用の単純なPerlスクリプトです。 これを使用する方法の1つは、キー"vfs.fs.discovery_perl"を持つUserParameterとして実行することです。

#!/usr/bin/perl
       
       $first = 1;
       
       print "[\n";
       
       for (`cat /proc/mounts`)
       {
           ($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
       
           print "\t,\n" if not $first;
           $first = 0;
       
           print "\t{\n";
           print "\t\t\"{#FSNAME}\":\"$fsname\",\n";
           print "\t\t\"{#FSTYPE}\":\"$fstype\"\n";
           print "\t}\n";
       }
       
       print "]\n";

出力例(わかりやすくするために再フォーマットされています)を以下に示します。 カスタム検出チェックの JSON は、同じ形式に従う必要があります。

[
           { "{#FSNAME}":"/",                           "{#FSTYPE}":"rootfs"   },
           { "{#FSNAME}":"/sys",                        "{#FSTYPE}":"sysfs"    },
           { "{#FSNAME}":"/proc",                       "{#FSTYPE}":"proc"     },
           { "{#FSNAME}":"/dev",                        "{#FSTYPE}":"devtmpfs" },
           { "{#FSNAME}":"/dev/pts",                    "{#FSTYPE}":"devpts"   },
           { "{#FSNAME}":"/lib/init/rw",                "{#FSTYPE}":"tmpfs"    },
           { "{#FSNAME}":"/dev/shm",                    "{#FSTYPE}":"tmpfs"    },
           { "{#FSNAME}":"/home",                       "{#FSTYPE}":"ext3"     },
           { "{#FSNAME}":"/tmp",                        "{#FSTYPE}":"ext3"     },
           { "{#FSNAME}":"/usr",                        "{#FSTYPE}":"ext3"     },
           { "{#FSNAME}":"/var",                        "{#FSTYPE}":"ext3"     },
           { "{#FSNAME}":"/sys/fs/fuse/connections",    "{#FSTYPE}":"fusectl"  }
       ]

前の例では、キーがプロトタイプで使用される LLD マクロ名と一致する必要があります。 別の方法としては、JSONPath{#FSNAME} → $.fsname および {#FSTYPE} → $.fstype を使用して LLD マクロ値を抽出することです。次のようなスクリプトでそれを可能にします:

#!/usr/bin/perl
        
       $first = 1;
        
       print "[\n";
        
       for (`cat /proc/mounts`)
       {
           ($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
        
           print "\t,\n" if not $first;
           $first = 0;
        
           print "\t{\n";
           print "\t\t\"fsname\":\"$fsname\",\n";
           print "\t\t\"fstype\":\"$fstype\"\n";
           print "\t}\n";
       }
        
       print "]\n";

出力例(わかりやすくするために再フォーマットされています)を以下に示します。 カスタム検出チェックの JSON は、同じ形式に従う必要があります。

[
           { "fsname":"/",                           "fstype":"rootfs"   },
           { "fsname":"/sys",                        "fstype":"sysfs"    },
           { "fsname":"/proc",                       "fstype":"proc"     },
           { "fsname":"/dev",                        "fstype":"devtmpfs" },
           { "fsname":"/dev/pts",                    "fstype":"devpts"   },
           { "fsname":"/lib/init/rw",                "fstype":"tmpfs"    },
           { "fsname":"/dev/shm",                    "fstype":"tmpfs"    },
           { "fsname":"/home",                       "fstype":"ext3"     },
           { "fsname":"/tmp",                        "fstype":"ext3"     },
           { "fsname":"/usr",                        "fstype":"ext3"     },
           { "fsname":"/var",                        "fstype":"ext3"     },
           { "fsname":"/sys/fs/fuse/connections",    "fstype":"fusectl"  }
       ]

次にディスカバリルールの[フィルタ]フィールドで、"{#FSTYPE}"をマクロとして指定し、正規表現として"rootfs|ext3"を指定します。

ユーザーパラメータを使用する場合、戻り値は512KBに制限されることに注意してください。 詳細についてはLLD戻り値のデータ制限を参照してください。