Просмотр кода страницы Перенос расширений Python

== Требования ==

* [https://www.python.org/downloads/ Python 3.10].
* Ключ-АСТРОМ версии 1.286 или более поздней.
* <code>dt-extensions-sdk[cli]</code> установлен в вашем <code>PATH</code>.

{| class="wikitable"
|Проверьте, установлен ли у вас <code>dt-extensions-sdk</code> в <code>PATH</code>, запустив <code>dt-sdk --version</code> на терминале.
|}

== Последовательность действи ==
Чтобы перенести существующее расширение '''Python EF1''' с помощью '''Visual Studio Code''', выполните следующие действия.

# Создайте новое расширение '''EF2'''.
# Импортируйте расширение '''EF1''' с помощью команды <code>astromkey extensions: Convert Python</code>.
# Преобразуйте код, переместив класс из исходного расширения в файл <code>__main__.py</code> нового расширения.

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

# Откройте пустую папку в '''Visual Studio Code''', затем выполните команду <code>astromkey extensions: Initialize Workspace</code>.
# Выберите версию схемы (рекомендуется последняя) и сертификаты, которые вы хотите использовать для подписи расширения.
# Выберите тип проекта <code>Python Extension 2.0</code>.
# Дайте своему расширению имя; оно должно соответствовать соглашению об именовании модулей '''Python''', используя все строчные буквы с необязательными подчеркиваниями.

=== Импорт существующего расширения EF1 ===
'''Первый шаг''' — конвертировать старый файл <code>plugin.json</code> в новый формат <code>activationSchema.json</code>. Это автоматически создаст пользовательский интерфейс '''Settings 2.0''' для вашего расширения, который определяет пользовательский интерфейс для настройки расширения.

Выполните команду <code>astromkey extensions: Convert Python</code>. Вы можете импортировать существующее расширение '''Python''' из:

* Расширения '''zip'''- файла
* Файла '''plugin.json'''
* Вашей среды Ключ-АСТРОМ

В этом примере мы импортируем из среды Ключ-АСТРОМ , что дает вам список всех расширений '''Python''' в этой среде.

Если вы хотите импортировать данные со своего компьютера, откроется окно выбора файлов, в котором вы сможете выбрать '''ZIP-файл''' расширения или файл '''plugin.json'''.

После выбора расширения ваши настройки <code>activationSchema.json</code> будут перезаписаны правильными. Вам необходимо проверить файл, чтобы убедиться, что ваш интерфейс выглядит так, как вы хотите.

При импорте локального расширения ЕдиногоАгента удалите запись <code>activation > remote</code> из файла <code>extension.yaml file</code>.

Однако при импорте удаленного расширения АктивногоШлюза удалите <code>activation > local</code>.

Вы также можете заставить свое расширение работать удаленно и локально, сохранив обе записи и изменив файл <code>activationSchema.json</code> соответствующим образом.

=== Изменение кода расширения ===
Перенесите существующий код расширения в файл нового расширения <code>__main__.py</code>. Проще всего это сделать, вставив код из существующего класса расширения в новый класс <code>ExtensionImpl</code>.

Вот наиболее существенные изменения, которые вам необходимо внести в свой код:

==== Справочник по преобразованию кодов ====
{| class="wikitable"
!Описание
!Метод EF1
!Метод EF2
!Примечания
|-
|Ведение логов
|<code>self.logger.info("message")</code>
|<code>self.logger.info("message")</code>
|Остается прежним
|-
|Получение пользовательских параметров
|<code>self.config.get("param_name", "default_value")</code>
|<code>self.activation_config.get("param_name", "default_value")</code>
|Вы можете найти и заменить все записи <code>self.config.</code> на <code>self.activation_config.</code>
|-
|Сообщение о событии
|<code>self.results_builder.report_custom_info_event</code>
|<code>self.report_dt_event</code>
|Постарайтесь не включать топологию (группы, устройства, идентификаторы) в код; это определяется далее в файле <code>extension.yaml</code>.
|-
|Сообщение метрики
|<code>device.absolute("metric_key", metric_value, {"dimension_name": "dimension_value"})</code>
|<code>self.report_metric("metric_key", metric_value, {"dimension_name": "dimension_value"})</code>
|В коде Python больше нет концепции <code>device</code>; отправляйте метрики напрямую.
|-
|Создание группы и пользовательского устройства
|<code>self.topology_builder.create_group</code>,<code>group.create_device</code>
|<code>n/a</code>
|Не существует; топология определена в файле <code>extension.yaml</code>.
|}

=== Создание и загрузка расширения ===
Соберите расширение, выполнив команду <code>astromkey extensions: Build</code>. Если сборка прошла успешно, вы увидите приглашение загрузить расширение в среду Ключ-АСТРОМ и активировать его. Примите оба приглашения.

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