6 JMX 的自动发现 objects

概述

可以对所有JMX MBean或MBean属性进行discover,或者指定用于发现这些objects的模式。

在发现规则配置中,理解MBean与MBean属性之间的区别是强制性的。MBean是一个object,它可以代表一个设备、一个应用程序或任何需要被管理的资源。

例如,存在一个代表Web服务器的MBean。它的属性包括连接数、线程数、请求超时、http file缓存、memory使用情况等。用通俗易懂的语言来表达,我们可以将一台咖啡机定义为一个MBean,它具有以下需要监控的属性:每杯水的用量、特定时间段内的平均用水量、每杯所需的咖啡豆数量、咖啡豆和水的补充时间等。

监控项键值

发现规则 配置中,在 Type 字段中选择 JMX agent

JMX 对象发现支持两个监控项键值 - jmx.discovery[] 和 jmx.get[]:

监控项键值
返回值 参数 注释
jmx.discovery[<discovery mode>,<object name>,<unique short description>]
此监控项返回一个包含 LLD 宏的 JSON 数组,用于描述 MBean 对象或其属性。 discovery mode - 以下之一:attributes(获取 JMX MBean 属性,默认)或 beans(获取 JMX MBeans)
object name - 对象名称模式(参见 documentation),用于标识要检索的 MBean 名称(默认为空,检索所有已注册的 bean)
unique short description - 一个唯一描述,允许在主机上使用相同 discovery mode 和 object name 的多个 JMX 监控项(可选)
示例:
→ jmx.discovery - 获取所有 JMX MBean 属性
→ jmx.discovery[beans] - 获取所有 JMX MBeans
→ jmx.discovery[attributes,"*:type=GarbageCollector,name=*"] - 获取所有垃圾收集器属性
→ jmx.discovery[beans,"*:type=GarbageCollector,name=*"] - 获取所有垃圾收集器

由于宏名称生成仅支持有限字符,因此此监控项可返回的 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 - 对象名称模式(参见 documentation),用于标识要检索的 MBean 名称(默认为空,检索所有已注册的 bean)
unique short description - 一个唯一描述,允许在主机上使用相同 discovery mode 和 object name 的多个 JMX 监控项(可选)
使用此监控项时,需要定义自定义低级发现宏,并通过 JSONPath 指向从返回的 JSON 中提取的值。

如果未传递任何参数,则会请求 JMX 中所有 MBean 属性。对于 JMX 发现不指定参数,或者尝试为类似 *:type=*,name=* 的大范围获取所有属性,可能会导致潜在的性能问题。

使用jmx.discovery

该 监控项 返回一个 JSON object,其中包含用于描述 MBean objects 或属性的低级别自动发现宏。例如,在 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})(请参见下文 限制)。
限制

通过 JMX 属性名称创建 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} - Zabbix 内部使用,用于描述 MBean 的 domain
  • {#JMXOBJ} - Zabbix 内部使用,用于描述 MBean object
  • {#JMXNAME} - 从 "name" 属性生成

被忽略的属性包括:

  • тип : 属性名称包含不支持的字符(非 ASCII 字符)
  • attributes[] : 属性名称包含不支持的字符(方括号不被支持)
  • Name : 该属性名称已存在(name=test)
  • domAin : 该名称为 Zabbix 保留名称
示例

让我们回顾两个更实用的示例,以展示如何使用 MBean 创建 LLD 规则。为了更好地理解收集 MBean 的 LLD 规则与收集 MBean 属性的 LLD 规则之间的区别,请参见下表:

MBean1 MBean2 MBean3
MBean1Attribute1 MBean2Attribute1 MBean3Attribute1
MBean1Attribute2 MBean2Attribute2 MBean3Attribute2
MBean1Attribute3 MBean2Attribute3 MBean3Attribute3
示例 1:发现 MBeans

此规则将返回 3 个对象:列的顶行:MBean1、 MBean2、MBean3。

有关对象的更多信息,请参阅 supported macros 表中的 Discovery of MBeans 部分。

收集 MBeans(不含属性)的发现规则配置如下:

lld\_rule\_mbean.png

此处使用的 key:

jmx.discovery[beans,"*:type=GarbageCollector,name=*"]

所有不带属性的垃圾回收器都会被发现。由于垃圾回收器具有相同的属性集,我们可以在监控项原型中按如下方式使用所需属性:

lld\_rule\_mbean\_prototypes.png

此处使用的 key:

jmx[{#JMXOBJ},CollectionCount] 
jmx[{#JMXOBJ},CollectionTime] 
jmx[{#JMXOBJ},Valid] 

LLD 发现规则的结果将类似于以下内容(会发现两个垃圾回收器的监控项):

discovery\_rule\_mbean\_3.png

示例 2:发现 MBean 属性

此规则将返回 9 个对象,包含以下字段: MBean1Attribute1, MBean2Attribute1, MBean3Attribute1,MBean1Attribute2,MBean2Attribute2, MBean3Attribute2, MBean1Attribute3, MBean2Attribute3, MBean3Attribute3。

有关对象的更多信息,请参阅 supported macros 表中的 Discovery of MBean attributes 部分。

收集 MBean 属性的发现规则配置如下所示:

lld\_rule\_mbean\_attr.png

此处使用的 key 为:

jmx.discovery[attributes,"*:type=GarbageCollector,name=*"]

所有带有单个监控项属性的垃圾回收器都会被发现。

lld\_rule\_mbean\_attr\_prototypes.png

在这种特定情况下,将会针对每个 MBean 属性从原型创建一个监控项。此配置的主要缺点是无法从触发器原型创建触发器,因为所有属性只有一个监控项原型。因此,这种设置可用于数据收集,但不建议用于自动监控。

使用 jmx.get

jmx.get[]jmx.discovery[] 监控项类似,但它不会将 Java 对象属性转换为低级别发现宏名称,因此可以返回不受与 LLD 宏名称生成相关的限制影响的值,例如连字符或非 ASCII 字符。

在使用 jmx.get[] 进行发现时,可以在发现规则配置的自定义 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
        }
    }
]