IKuznetsov: Новая страница: «Это общее описание расширения файла '''YAML''' на основе источника данных '''JMX''' и способов об...»

2025-06-23T18:34:37Z

Новая страница: «Это общее описание расширения файла '''YAML''' на основе источника данных '''JMX''' и способов об...»

Новая страница

Это общее описание расширения файла '''YAML''' на основе источника данных '''JMX''' и способов объявления показателей и измерений, которые вы хотели бы собирать с помощью вашего расширения.

== Метрические значения ==
Значение метрики может поступать из разных источников.

Наиболее распространенным источником является числовой атрибут '''JMX MBean''':
{| class="wikitable"
|metrics:

- key: com.example.somekey

value: attribute:ThreadCount
|}
Это будет искать атрибут с именем <code>ThreadCount</code>. Возвращаемое значение должно быть либо числовым (любой подкласс <code>java.lang.Number</code>, например <code>Integer</code>, <code>Long</code>, <code>Double</code>), либо <code>boolean</code> (преобразованным в <code>0</code> for <code>false</code> и <code>1</code> for <code>true</code>).

'''JMX''' позволяет определять атрибуты с комплексными нечисловыми типами. Из такого нечислового значения атрибута можно извлечь числовое значение. Для этого требуется указать, к каким методам или полям следует получить доступ.

Например:
{| class="wikitable"
|metrics:

- key: com.example.somekey

value:

attribute: SomeNonNumericAttribute

accessor: getSomeNumericValue()
|}
Подробное описание синтаксиса см . в разделе '''Синтаксис доступа''' ниже.

Особым случаем является использование всегда одного и того же постоянного значения вместо запроса атрибута:
{| class="wikitable"
|metrics:

- key: com.example.somekey

value: const:1
|}
Если <code>query</code> соответствует одному '''MBean''', эта метрика всегда будет выдавать значение <code>1</code>. Это можно использовать для сообщения только о наличии определенного '''MBean'''. Если запрос соответствует нескольким '''MBean''', эта метрика будет выдавать значение, соответствующее количеству совпадений '''MBean'''.

== Индивидуальные размеры ==
Каждое пользовательское измерение состоит из константы <code>key</code> и <code>value</code>. Значение может поступать из разных источников.

Самый простой случай — задать значение измерения как постоянную строку:
{| class="wikitable"
|dimensions:

- key: k1

value: const:constant_value
|}
Это создаст метрику, в которой измерение <code>k1</code> всегда имеет значение <code>constant_value</code>.

Значение свойства ключа имени объекта '''MBean''' можно использовать в качестве значения измерения:
{| class="wikitable"
|query: java.lang:type=GarbageCollector,name=*

dimensions:

- key: k1

value: property:name
|}
Это создаст метрику, где измерение <code>k1</code> соответствует значению ключевого свойства <code>name</code>. Например, '''MBean''' <code>java.lang:type=GarbageCollector,name=YoungGen</code> создаст метрику, где измерение <code>k1</code> имеет значение <code>YoungGen</code>.

Если в процессе задействовано 3 разных сборщика мусора, создаются метрики с 3 разными значениями измерений, которые можно построить на независимой диаграмме.

Атрибут '''MBean''' также может использоваться в качестве значения измерения.
{| class="wikitable"
|query: java.lang:type=Compilation

dimensions:

- key: k1

value: attribute:Name
|}
Это создаст метрику, где измерение <code>k1</code> соответствует значению атрибута <code>Name</code>. В настоящее время поддерживаются только неизменяемые атрибуты. Атрибут для определенного '''MBean''' запрашивается только один раз, когда '''MBean''' впервые обнаруживается ЕдинымАгентом.

Подобно значениям метрик, можно извлечь значение измерения из сложного атрибута, используя выражение доступа:
{| class="wikitable"
|query: java.lang:type=Compilation

dimensions:

- key: k1

value:

attribute: SomeAttribute

accessor: getName()
|}
Этот метод будет искать атрибут с именем <code>SomeAttribute</code>, вызывать его <code>getName</code> и использовать возвращаемое значение в качестве значения для измерения <code>k1</code>.

== Синтаксис ==
{| class="wikitable"
!
!Описание
|-
|<code>getSomeNumericValue()</code>
|Вызов метода <code>getSomeNumericValue</code> без параметров.
|-
|<code>getSomeNumericValue</code>
|Скобки — необязательные методы без параметров.
|-
|<code>getA().getB()</code>
|Вызов метода с именем <code>getA</code>, затем для возвращаемого им значения вызов метод с именем <code>getB</code>.
|-
|<code>getA(1)</code>
|Вызов метода <code>getA</code> с целочисленным аргументом <code>1</code>.
|-
|<code>getA("x")</code>
|Вызов метода <code>getA</code> со строковым аргументом <code>x</code>.
|-
|<code>getA(1, "x")</code>
|Вызов метода <code>getA</code> с двумя аргументами.
|-
|<code>getA()[1]</code>
|Вызов метода с именем <code>getA</code>, затем из возвращаемого значения извлечение значения с индексом 1.
|}

== Переменные расширения ==
Переменные расширения можно использовать, чтобы разрешить пользователям расширения отслеживать только определенные '''MBean'''-компоненты:
{| class="wikitable"
|vars:

- id: gc_name_filter

displayName: Garbage Collector Name

type: text

jmx:

groups:

- group: jvm

subgroups:

- subgroup: basic

query: java.lang:type=GarbageCollector

queryFilters:

- field: name

filter: var:gc_name_filter

dimensions:

- key: k1

value: property:name

metrics:

- key: com.example.jmx.var

type: count

value: attribute:CollectionTime
|}
Это создает переменную, которая называется <code>gc_name_filter</code> и <code>Garbage Collector Name</code> в пользовательском интерфейсе. Значение переменной будет использоваться для выбора определенного '''MBean'''. Например, если значение переменной равно <code>YoungGen</code>, то полный запрос имени объекта будет <code>java.lang:type=GarbageCollector,name=YoungGen</code>

Каждая конфигурация мониторинга может выбрать определенное значение для этой переменной. Чтобы гарантировать, что несколько конфигураций мониторинга с разными значениями переменных не будут перепутаны в пользовательском интерфейсе, рекомендуется также добавить измерение для свойства <code>name</code>, как показано выше.

Справка о источнике данных JMX - История изменений

IKuznetsov: Новая страница: «Это общее описание расширения файла '''YAML''' на основе источника данных '''JMX''' и способов об...»