Создание расширений Python - История изменений

IKuznetsov: /* Визуализация данных */

2026-04-13T22:24:03Z

Визуализация данных

← Предыдущая		Версия 22:24, 13 апреля 2026
Строка 419:		Строка 419:
	На данный момент мы отправляем в Ключ-АСТРОМ только метрические данные.		На данный момент мы отправляем в Ключ-АСТРОМ только метрические данные.

	Мы можем визуализировать эти показатели с помощью <code>Dashboards~~</code>, <code>Notebooks~~</code> или <code>Metric Explorer</code>.		Мы можем визуализировать эти показатели с помощью <code>Dashboards</code> или <code>Metric Explorer</code>.

	Полноценное расширение будет включать дашборды, топологию, экраны и многое другое. Полный пример кода можно найти на странице [https://github.com/dynatrace-extensions/python-rabbitmq расширения RabbitMQ на GitHub].		Полноценное расширение будет включать дашборды, топологию, экраны и многое другое. Полный пример кода можно найти на странице [https://github.com/dynatrace-extensions/python-rabbitmq расширения RabbitMQ на GitHub].

IKuznetsov в 15:28, 18 сентября 2025

2025-09-18T15:28:35Z

← Предыдущая		Версия 15:28, 18 сентября 2025
Строка 24:		Строка 24:

	# Откройте пустую папку в '''Visual Studio Code'''.		# Откройте пустую папку в '''Visual Studio Code'''.
	# Выполните команду <code>~~Dynatrace~~ extensions: Initialize workspace</code>.		# Выполните команду <code>astromkey extensions: Initialize workspace</code>.
	# Выберите последнюю доступную версию схемы.		# Выберите последнюю доступную версию схемы.
	# Создайте новый сертификат или используйте существующий.		# Создайте новый сертификат или используйте существующий.
Строка 107:		Строка 107:
	Нам также потребуется включить в качестве зависимости наше расширение <code>requests</code>.		Нам также потребуется включить в качестве зависимости наше расширение <code>requests</code>.
	{\| class="wikitable"		{\| class="wikitable"
	\|from ~~dynatrace_extension~~ import Extension, Status, StatusValue		\|from astromkey_extension import Extension, Status, StatusValue

	import requests		import requests
Строка 153:		Строка 153:
	}		}

	# 3 - Send a metric to ~~Dynatrace~~		# 3 - Send a metric to astromkey

	self.report_metric("rabbitmq.cluster.queues", cluster["object_totals"]["queues"], dimensions)		self.report_metric("rabbitmq.cluster.queues", cluster["object_totals"]["queues"], dimensions)
Строка 279:		Строка 279:
	=== Финальный код ===		=== Финальный код ===
	{\| class="wikitable"		{\| class="wikitable"
	\|from ~~dynatrace_extension~~ import Extension, Status, StatusValue		\|from astromkey_extension import Extension, Status, StatusValue

	import requests		import requests
Строка 325:		Строка 325:
	}		}

	# 3 - Send a metric to ~~Dynatrace~~		# 3 - Send a metric to astromkey

	self.report_metric("rabbitmq.cluster.queues", cluster["object_totals"]["queues"], dimensions)		self.report_metric("rabbitmq.cluster.queues", cluster["object_totals"]["queues"], dimensions)
Строка 400:		Строка 400:

	== Сборка расширения ==		== Сборка расширения ==
	Если вы ещё этого не сделали, вы можете сгенерировать сертификаты разработчика с помощью команды '''Visual Studio Code''' <code>~~Dynatrace~~ extensions: Generate certificates</code>. Подробнее об этой команде см. в [[Справочник команд для VS Code\|документации по генерации сертификатов]].		Если вы ещё этого не сделали, вы можете сгенерировать сертификаты разработчика с помощью команды '''Visual Studio Code''' <code>astromkey extensions: Generate certificates</code>. Подробнее об этой команде см. в [[Справочник команд для VS Code\|документации по генерации сертификатов]].

	Чтобы создать пакет расширения, выполните команду <code>~~Dynatrace~~ extensions: Build</code>.		Чтобы создать пакет расширения, выполните команду <code>astromkey extensions: Build</code>.

	Эта команда запустит команду <code>dt-sdk build</code>, которая создаст подписанный файл расширения в папке <code>custom_rabbitmq-extension-0.0.1.zip</code>. Клюя-АСТРОМ будет запускать только расширения <code>dist</code>, [[О расширениях\|подписанные доверенным сертификатом]].		Эта команда запустит команду <code>dt-sdk build</code>, которая создаст подписанный файл расширения в папке <code>custom_rabbitmq-extension-0.0.1.zip</code>. Клюя-АСТРОМ будет запускать только расширения <code>dist</code>, [[О расширениях\|подписанные доверенным сертификатом]].

IKuznetsov: Новая страница: «Ключ-АСТРОМ предоставляет средства для разработки расширений '''Python''' с помощью новой пл...»

2025-09-18T15:24:07Z

Новая страница: «Ключ-АСТРОМ предоставляет средства для разработки расширений '''Python''' с помощью новой пл...»

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

Ключ-АСТРОМ предоставляет средства для разработки расширений '''Python''' с помощью новой платформы '''Расширения'''. Эти расширения следует использовать, когда существующие источники данных не подходят для ваших задач.

Разрабатывайте расширения '''Python''', когда:

* Вам нужна сложная логика для извлечения показателей, событий или логов из источника.
* Невозможно осуществить сбор данных с помощью декларативного источника данных ('''SQL''', '''SNMP''', '''WMI''', '''JMX''', '''Prometheus''' и т. д.).

Пакет [https://pypi.org/project/dt-extensions-sdk/ dt -extensions-sdk python] предоставляет комплект разработки программного обеспечения ('''SDK''') и интерфейс командной строки ('''CLI'''), обеспечивающие поддержку вашего расширения '''Python'''.

Расширения '''Python''' также поддерживаются нашим [[Дополнение для VS Code|дополнением Visual Studio Code]], это рекомендуемый нами способ их разработки.
----В этом пошаговом руководстве мы создадим работающее расширение <code>RabbitMQ</code> с нуля.

Это расширение будет использовать [https://www.rabbitmq.com/docs/management API управления RabbitMQ] для получения метрик для кластера, узлов и очередей.

== Требования ==
Вам понадобится следующее:

* [https://code.visualstudio.com/download Visual Studio Code] с установленным и настроенным [[Дополнение для VS Code|дополнением Extensions]].
* [https://www.python.org/downloads/ Python 3.10]
* [https://pypi.org/project/dt-extensions-sdk/ dt-extensions-sdk]
* Ключ-АСТРОМ 1.286+

== Создание нового расширения ==

# Откройте пустую папку в '''Visual Studio Code'''.
# Выполните команду <code>Dynatrace extensions: Initialize workspace</code>.
# Выберите последнюю доступную версию схемы.
# Создайте новый сертификат или используйте существующий.
# Выберите тип проекта <code>Python Extension 2.0</code>.
# Дайте расширению имя <code>rabbitmq_extension</code>.

'''Расширения Python''' — это просто модули '''Python''', которые должны следовать соглашениям об именовании [https://peps.python.org/pep-0008/ PEP8], то есть имя должно быть написано строчными буквами и разделено символами подчеркивания.
{| class="wikitable"
|Чтобы запустить команду в Visual Studio Code, нажмите <code>F1</code> или <code>Ctrl+Shift+P</code> и введите имя команды.
|}
Наше расширение '''Visual Studio Code''' автоматически вызовет команду <code>dt-sdk create</code>, которая создаст необходимые файлы и папки для расширения.

Открыв файл <code>extension/extension.yaml</code>, вы можете изучить структуру расширения '''Python'''.

В нём объявлены имя модуля '''Python''', минимальная версия '''Python''' и схема активации для удалённого расширения АктивногоШлюза или локального расширения ЕдиногоАгента.

Нажатие на иконку кода <code>Simulate extension</code> запустит расширение в среде '''Visual Studio Code'''.
{| class="wikitable"
|Если вы не видите кнопку <code>Simulate extension</code>, перезагрузите окно Visual Studio Code с помощью <code>F1 > Reload Window</code>.
|}

== RabbitMQ ==
Мы предлагаем вам использовать '''Docker''' для тестирования этого расширения на реальном брокере '''RabbitMQ'''.

Вы можете запустить узел '''RabbitMQ''' с включенным расширением управления:
{| class="wikitable"
|docker run -d --name rabbit -p 15672:15672 rabbitmq:3-management
|}
Чтобы сделать расширение более интересным, войдите в систему <code><nowiki>http://localhost:15672</nowiki></code>, используя учетные данные по умолчанию <code>guest:guest</code>, и создайте новую очередь.

== Схема активации ==
При настройке нашего расширения нам необходимо запросить у пользователя три вида информации:

* URL-адрес управления RabbitMQ
* Имя пользователя
* Пароль

Вы можете определить эти параметры в файле <code>extension/activationSchema.json</code>. По умолчанию '''SDK''' создаёт этот файл с полями для '''URL'''-адреса, имени пользователя и пароля, что удобно для нас. Вам следует изменить этот файл в соответствии с конкретными потребностями расширения в большинстве случаев использования.

Во время разработки '''SDK''' считывает эти значения конфигурации из файла <code>activation.json</code>. Измените этот файл так, чтобы он указывал на наш локальный экземпляр '''RabbitMQ'''.
{| class="wikitable"
|{

"enabled": true,

"description": "rabbitmq_extension activation",

"version": "0.0.1",

"activationContext": "REMOTE",

"pythonRemote": {

"endpoints": [

{

"url": "<nowiki>http://localhost:15672</nowiki>",

"user": "guest",

"password": "guest"

}

]

}

}
|}
Вы можете использовать <code>activation.json</code> только во время разработки и он не входит в комплект расширения. Будьте осторожны, чтобы случайно не закоммитить секретные данные в систему управления версиями.

== Получение данных ==
В этом разделе мы реализуем метод расширения <code>query</code>. Этот метод вызывается каждую минуту и отвечает за извлечение данных из экземпляра '''RabbitMQ'''.

=== Метрики на уровне кластера ===
Начнем с отчета о количестве очередей в нашем экземпляре '''RabbitMQ'''.

Для этого мы можем вызвать конечную точку [https://rawcdn.githack.com/rabbitmq/rabbitmq-server/v3.13.0/deps/rabbitmq_management/priv/www/api/index.html /api/overview].

Нам также потребуется включить в качестве зависимости наше расширение <code>requests</code>.
{| class="wikitable"
|from dynatrace_extension import Extension, Status, StatusValue

import requests

class ExtensionImpl(Extension):

def initialize(self):

self.extension_name = "rabbitmq_extension"

def query(self):

"""

The query method is automatically scheduled to run every minute

"""

self.logger.info("query method started for rabbitmq_extension.")

for endpoint in self.activation_config["endpoints"]:

url = endpoint["url"]

user = endpoint["user"]

password = endpoint["password"]

self.logger.debug(f"Running endpoint with url '{url}'")

# We've added these three lines

# 1 - Make a request to the /api/overview endpoint

cluster = requests.get(f"{url}/api/overview", auth=(user, password)).json()

# 2 - Collect some dimensions for our metrics

dimensions = {

"cluster": cluster["cluster_name"],

"rabbitmq_version": cluster["rabbitmq_version"]

}

# 3 - Send a metric to Dynatrace

self.report_metric("rabbitmq.cluster.queues", cluster["object_totals"]["queues"], dimensions)

self.logger.info("query method ended for rabbitmq_extension.")

def fastcheck(self) -> Status:

"""

This is called when the extension runs for the first time.

If this AG cannot run this extension, raise an Exception or return StatusValue.ERROR!

"""

return Status(StatusValue.OK)

def main():

ExtensionImpl().run()

if __name__ == '__main__':

main()
|}
Чтобы включить запросы как зависимость, добавьте <code>install_requires</code> в <code>setup.py</code>:
{| class="wikitable"
|{

"enabled": true,

"description": "rabbitmq_extension activation",

"version": "0.0.1",

"activationContext": "REMOTE",

"pythonRemote": {

"endpoints": [

{

"url": "<nowiki>http://localhost:15672</nowiki>",

"user": "guest",

"password": "guest"

}

]

}

}
|}
Не забудьте также установить пакет <code>requests</code> в вашей среде разработки с помощью <code>pip install requests</code>

Запуск расширения теперь должен показать собираемую метрику:
{| class="wikitable"
|2024-02-29 21:42:56,099 [INFO] api (MainThread): send_metric: rabbitmq.cluster.queues,

cluster="rabbit@49bf21ab3628",rabbitmq_version="3.12.12" gauge,1 1709264569592
|}
В этом руководстве мы не будем добавлять дополнительные метрики, но вы можете воспользоваться '''API''' управления '''RabbitMQ''' в вашем локальном экземпляре и добавить дополнительные метрики в своё расширение. Доступ к нему можно получить по адресу <code><nowiki>http://localhost:15672/api/overview</nowiki></code>.

=== Метрики на уровне узла ===
Добавление метрик к узлам кластера '''RabbitMQ''' — аналогичный процесс.

Кластер может состоять из множества узлов, поэтому давайте пройдёмся по ним и выведем некоторые метрики.

Добавьте следующие строки после сообщения метрики <code>cluster</code>:
{| class="wikitable"
|# 4 - Get nodes

nodes = requests.get(f"{url}/api/nodes", auth=(user, password)).json()

for node in nodes:

# 5 - Add node specific dimensions, including it's parent (the cluster) dimensions

node_dimensions = {

"node": node["name"],

**dimensions

}

# 6 - Report a metric for each node

self.report_metric("rabbitmq.node.mem_used", node["mem_used"], node_dimensions)
|}

=== Метрики на уровне очереди ===
Наконец, давайте добавим некоторые метрики для очередей в нашем экземпляре '''RabbitMQ'''.
{| class="wikitable"
|# 7 - Get queues

queues = requests.get(f"{url}/api/queues", auth=(user, password)).json()

for queue in queues:

# 8 - Add queue specific dimensions, including it's parent (the cluster) dimensions

queue_dimensions = {

"name": queue["name"],

"node": queue["node"],

"state": queue["state"],

**dimensions

}

# 9 - Report a metric for each queue

self.report_metric("rabbitmq.queue.messages", queue["messages"], queue_dimensions)
|}

=== Финальный код ===
{| class="wikitable"
|from dynatrace_extension import Extension, Status, StatusValue

import requests

class ExtensionImpl(Extension):

def initialize(self):

self.extension_name = "rabbitmq_extension"

def query(self):

"""

The query method is automatically scheduled to run every minute

"""

self.logger.info("query method started for rabbitmq_extension.")

for endpoint in self.activation_config["endpoints"]:

url = endpoint["url"]

user = endpoint["user"]

password = endpoint["password"]

self.logger.debug(f"Running endpoint with url '{url}'")

# We've added these three lines

# 1 - Make a request to the /api/overview endpoint

cluster = requests.get(f"{url}/api/overview", auth=(user, password)).json()

# 2 - Collect some dimensions for our metrics

dimensions = {

"cluster": cluster["cluster_name"],

"rabbitmq_version": cluster["rabbitmq_version"]

}

# 3 - Send a metric to Dynatrace

self.report_metric("rabbitmq.cluster.queues", cluster["object_totals"]["queues"], dimensions)

# 4 - Get nodes

nodes = requests.get(f"{url}/api/nodes", auth=(user, password)).json()

for node in nodes:

# 5 - Add node specific dimensions, including it's parent (the cluster) dimensions

node_dimensions = {

"node": node["name"],

**dimensions

}

# 6 - Report a metric for each node

self.report_metric("rabbitmq.node.mem_used", node["mem_used"], node_dimensions)

# 7 - Get queues

queues = requests.get(f"{url}/api/queues", auth=(user, password)).json()

for queue in queues:

# 8 - Add queue specific dimensions, including it's parent (the cluster) dimensions

queue_dimensions = {

"name": queue["name"],

"node": queue["node"],

"state": queue["state"],

**dimensions

}

# 9 - Report a metric for each queue

self.report_metric("rabbitmq.queue.messages", queue["messages"], queue_dimensions)

self.logger.info("query method ended for rabbitmq_extension.")

def fastcheck(self) -> Status:

"""

This is called when the extension runs for the first time.

If this AG cannot run this extension, raise an Exception or return StatusValue.ERROR!

"""

return Status(StatusValue.OK)

def main():

ExtensionImpl().run()

if __name__ == '__main__':

main()
|}
Вам следует разделить метод <code>query</code> на более мелкие методы.

Полный код можно найти в нашем настоящем [https://github.com/dynatrace-extensions/python-rabbitmq расширении '''RabbitMQ''' на '''Github'''], которое включает дашборды, топологию, экраны, все метрики и многое другое.

== Сборка расширения ==
Если вы ещё этого не сделали, вы можете сгенерировать сертификаты разработчика с помощью команды '''Visual Studio Code''' <code>Dynatrace extensions: Generate certificates</code>. Подробнее об этой команде см. в [[Справочник команд для VS Code|документации по генерации сертификатов]].

Чтобы создать пакет расширения, выполните команду <code>Dynatrace extensions: Build</code>.

Эта команда запустит команду <code>dt-sdk build</code>, которая создаст подписанный файл расширения в папке <code>custom_rabbitmq-extension-0.0.1.zip</code>. Клюя-АСТРОМ будет запускать только расширения <code>dist</code>, [[О расширениях|подписанные доверенным сертификатом]].

Расширение '''Visual Studio Code''' также предложит вам загрузить расширение в среду Ключ-АСТРОМ, что является приятной и удобной функцией.

== Настройка расширения ==
Перейдите в Ключ-АСТРОМ и настройте расширение. Вы можете использовать приложение '''Расширения''' или перейти в раздел <code>Infrastructure Observability</code> > <code>Extensions</code>, чтобы настроить расширение.
{| class="wikitable"
|Для запуска этого расширения из АктивногоШлюза или ЕдиногоАгента необходимо доверять вашему сертификату разработчика.

Информацию о том, как распространять его, можно найти в [[Расширения знаков|документации по расширениям Sign]] .
|}

== Визуализация данных ==
На данный момент мы отправляем в Ключ-АСТРОМ только метрические данные.

Мы можем визуализировать эти показатели с помощью <code>Dashboards</code>, <code>Notebooks</code> или <code>Metric Explorer</code>.

Полноценное расширение будет включать дашборды, топологию, экраны и многое другое. Полный пример кода можно найти на странице [https://github.com/dynatrace-extensions/python-rabbitmq расширения RabbitMQ на GitHub].