6 JMXオブジェクトの検出
概要
すべての JMX MBean または MBean 属性を 検出 したり、これらのオブジェクトの検出パターンを指定したりできます。
ディスカバリ ルールを設定するには、MBean と MBean 属性の違いを理解しておく必要があります。 MBean は、管理が必要なデバイス、アプリケーション、または任意のリソースを表すことができるオブジェクトです。
たとえば、Web サーバーを表す MBean があります。 その属性は、接続数、スレッド数、リクエスト タイムアウト、http ファイル キャッシュ、メモリ使用量などです。 この考えを人間の包括的な言語で表現すると、コーヒー マシンを豆と水の補充時間などを監視対象の属性として持つ MBean として定義できます。
アイテムキー
ディスカバリルールの設定で、Type フィールドに JMX agent を選択します。
JMX オブジェクトのディスカバリでは、2 つのアイテムキーがサポートされています - jmx.discovery[] と jmx.get[] です。
| アイテムキー | |||
|---|---|---|---|
| 戻り値 | パラメータ | コメント | |
| jmx.discovery[<discovery mode>,<object name>,<unique short description>] | |||
| このアイテムは、MBean オブジェクトまたはその属性を説明する LLD マクロを含む JSON 配列を返します。 | discovery mode - 次のいずれか: attributes (JMX MBean 属性を取得、デフォルト) または beans (JMX MBeans を取得) object name - 取得する MBean 名を識別するオブジェクト名パターン (documentation を参照) (デフォルトは空で、登録済みのすべての bean を取得) unique short description - ホスト上で同じ discovery mode と object name を持つ複数の JMX アイテムを区別できる一意の説明 (省略可) |
例: → jmx.discovery - すべての JMX MBean 属性を取得 → jmx.discovery[beans] - すべての JMX MBeans を取得 → jmx.discovery[attributes,"*:type=GarbageCollector,name=*"] - すべての garbage collector 属性を取得 → jmx.discovery[beans,"*:type=GarbageCollector,name=*"] - すべての garbage collectors を取得 このアイテムが返せる MBean プロパティには、マクロ名生成でサポートされる文字が限られているため、いくつかの制限があります (サポートされる文字は次の正規表現で表せます: A-Z0-9_\.)。そのため、たとえばハイフンを含む単語や非 ASCII 文字を持つ MBean プロパティをディスカバリするには、jmx.get[] を使用する必要があります。 |
|
| jmx.get[<discovery mode>,<object name>,<unique short description>] | |||
このアイテムは、MBean オブジェクトまたはその属性を含む JSON 配列を返します。jmx.discovery[] と比べると、LLD マクロは定義しません。 |
discovery mode - 次のいずれか: attributes (JMX MBean 属性を取得、デフォルト) または beans (JMX MBeans を取得) object name - 取得する MBean 名を識別するオブジェクト名パターン (documentation を参照) (デフォルトは空で、登録済みのすべての bean を取得) unique short description - ホスト上で同じ discovery mode と object name を持つ複数の JMX アイテムを区別できる一意の説明 (省略可) |
このアイテムを使用する場合は、JSONPath を使用して返された JSON から抽出した値を指すカスタムの low-level discovery マクロを定義する必要があります。 | |
パラメータが渡されない場合、JMX のすべての MBean 属性が要求されます。JMX ディスカバリでパラメータを指定しない場合や、*:type=*,name=* のような広い範囲で全属性を取得しようとすると、パフォーマンス上の問題が発生する可能性があります。
jmx.discovery の使用
このアイテムは、MBean オブジェクトまたは属性を記述するローレベルディスカバリマクロを含む JSON オブジェクトを返します。たとえば、MBean 属性のディスカバリでは、次のようになります(見やすさのために整形しています)。
[
{
"{#JMXVALUE}":"0",
"{#JMXTYPE}":"java.lang.Long",
"{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
"{#JMXDESC}":"java.lang:type=GarbageCollector,name=PS Scavenge,CollectionCount",
"{#JMXATTR}":"CollectionCount"
},
{
"{#JMXVALUE}":"0",
"{#JMXTYPE}":"java.lang.Long",
"{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
"{#JMXDESC}":"java.lang:type=GarbageCollector,name=PS Scavenge,CollectionTime",
"{#JMXATTR}":"CollectionTime"
},
{
"{#JMXVALUE}":"true",
"{#JMXTYPE}":"java.lang.Boolean",
"{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
"{#JMXDESC}":"java.lang:type=GarbageCollector,name=PS Scavenge,Valid",
"{#JMXATTR}":"Valid"
},
{
"{#JMXVALUE}":"PS Scavenge",
"{#JMXTYPE}":"java.lang.String",
"{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
"{#JMXDESC}":"java.lang:type=GarbageCollector,name=PS Scavenge,Name",
"{#JMXATTR}":"Name"
},
{
"{#JMXVALUE}":"java.lang:type=GarbageCollector,name=PS Scavenge",
"{#JMXTYPE}":"javax.management.ObjectName",
"{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
"{#JMXDESC}":"java.lang:type=GarbageCollector,name=PS Scavenge,ObjectName",
"{#JMXATTR}":"ObjectName"
}
]
MBean のディスカバリでは、次のようになります(見やすさのために整形しています)。
[
{
"{#JMXDOMAIN}":"java.lang",
"{#JMXTYPE}":"GarbageCollector",
"{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
"{#JMXNAME}":"PS Scavenge"
}
]
サポートされるマクロ
以下のマクロは、ディスカバリルール filter およびアイテム、トリガー、グラフのプロトタイプで使用できます:
| Macro | Description |
|---|---|
| MBean属性のディスカバリ | |
| {#JMXVALUE} | 属性値。 |
| {#JMXTYPE} | 属性タイプ。 |
| {#JMXOBJ} | オブジェクト名。 |
| {#JMXDESC} | 属性名を含むオブジェクト名。 |
| {#JMXATTR} | 属性名。 |
| MBeanのディスカバリ | |
| {#JMXDOMAIN} | MBeanドメイン。(Zabbix予約名) |
| {#JMXOBJ} | オブジェクト名。(Zabbix予約名) |
| {#JMX<key property>} | MBeanプロパティ ({#JMXTYPE}、{#JMXNAME} など) (制限事項 を参照)。 |
制限事項
MBean のプロパティ名から LLD マクロ名を作成するアルゴリズムには、いくつかの制限があります。
- 属性名は大文字に変換されます
- 属性名に LLD マクロ名でサポートされていない文字が含まれている場合、その属性名は無視されます(LLD マクロは生成されません)。サポートされる文字は、次の正規表現で表せます:
A-Z0-9_\. - 属性名が "obj" または "domain" の場合、予約済みの Zabbix プロパティ {#JMXOBJ} および {#JMXDOMAIN} の値と重複するため、無視されます
次の jmx.discovery("beans" モード)の例を考えてみてください。MBean には以下のプロパティが定義されています(一部は無視されます。以下を参照してください):
name=test
тип=Type
attributes []=1,2,3
Name=NameOfTheTest
domAin=some
JMX ディスカバリの結果、次の LLD マクロが生成されます:
- {#JMXDOMAIN} - MBean のドメインを表す Zabbix 内部プロパティ
- {#JMXOBJ} - MBean オブジェクトを表す Zabbix 内部プロパティ
- {#JMXNAME} - "name" プロパティから作成
無視されるプロパティは次のとおりです:
- тип : 名前にサポートされていない文字(非 ASCII)が含まれています
- attributes[] : 名前にサポートされていない文字が含まれています(角括弧はサポートされていません)
- Name : すでに定義されています(name=test)
- domAin : Zabbix の予約名です
例
MBean を使用した LLD ルール作成の、より実践的な例をさらに 2 つ見ていきましょう。
MBean を収集する LLD ルールと、MBean 属性を収集する LLD ルールの違いをよりよく理解するために、次の表を参照してください。
| MBean1 | MBean2 | MBean3 |
| MBean1Attribute1 | MBean2Attribute1 | MBean3Attribute1 |
| MBean1Attribute2 | MBean2Attribute2 | MBean3Attribute2 |
| MBean1Attribute3 | MBean2Attribute3 | MBean3Attribute3 |
例1: MBeanの検出
このルールは3つのオブジェクトを返します。列の先頭行: MBean1、MBean2、MBean3。
オブジェクトの詳細については、サポートされるマクロの表、MBeanの検出 セクションを参照してください。
MBeanを収集する検出ルールの設定(属性なし)は、次のようになります。

ここで使用されるキー:
jmx.discovery[beans,"*:type=GarbageCollector,name=*"]
すべての属性を持たないガベージコレクタが検出されます。ガベージコレクタは同じ属性セットを持つため、アイテムプロトタイプで必要な属性を次のように使用できます。

ここで使用されるキー:
jmx[{#JMXOBJ},CollectionCount]
jmx[{#JMXOBJ},CollectionTime]
jmx[{#JMXOBJ},Valid]
LLD検出ルールの結果は、次のようなものになります(2つのガベージコレクタに対してアイテムが検出されます)。

例 2: MBean属性の検出
このルールは、次のフィールドを持つ 9 個のオブジェクトを返します。 MBean1Attribute1, MBean2Attribute1, MBean3Attribute1,MBean1Attribute2,MBean2Attribute2, MBean3Attribute2, MBean1Attribute3, MBean2Attribute3, MBean3Attribute3。
オブジェクトの詳細については、supported macros 表の Discovery of MBean attributes セクションを参照してください。
MBean属性を収集する検出ルールの設定は、次のようになります。

ここで使用されているキー:
jmx.discovery[attributes,"*:type=GarbageCollector,name=*"]
単一のアイテム属性を持つすべてのガベージコレクターが検出されます。

この特定のケースでは、各MBean属性ごとにアイテムがプロトタイプから作成されます。この設定の主な欠点は、すべての属性に対してアイテムプロトタイプが 1 つしかないため、トリガープロトタイプからトリガーを作成できないことです。そのため、この構成はデータ収集には使用できますが、自動監視には推奨されません。
jmx.get の使用
jmx.get[] は jmx.discovery[] アイテムと似ていますが、Java オブジェクトのプロパティを low-level discovery のマクロ名に変換しません。そのため、ハイフンや非 ASCII 文字など、LLD マクロ名の生成に関連する 制限 を受けずに値を返すことができます。
jmx.get[] をディスカバリに使用する場合、low-level discovery マクロは、ディスカバリルールの設定にあるカスタム LLD マクロ タブで個別に定義できます。JSONPath を使用して、必要な値を指定します。
MBeansの検出
検出アイテム: jmx.get[beans,"com.example:type=*,*"]
レスポンス:
[
{
"object": "com.example:type=Hello,data-src=data-base,ключ=значение",
"domain": "com.example",
"properties": {
"data-src": "data-base",
"ключ": "значение",
"type": "Hello"
}
},
{
"object": "com.example:type=Atomic",
"domain": "com.example",
"properties": {
"type": "Atomic"
}
}
]
MBean 属性の検出
検出アイテム: jmx.get[attributes,"com.example:type=*,*"]
レスポンス:
[
{
"object": "com.example:type=*",
"domain": "com.example",
"properties": {
"type": "Simple"
}
},
{
"object": "com.zabbix:type=yes,domain=zabbix.com,data-source=/dev/rand,ключ=значение,obj=true",
"domain": "com.zabbix",
"properties": {
"type": "Hello",
"domain": "com.example",
"data-source": "/dev/rand",
"ключ": "значение",
"obj": true
}
}
]