IKuznetsov в 16:00, 11 декабря 2025

2025-12-11T16:00:43Z

← Предыдущая		Версия 16:00, 11 декабря 2025
Строка 112:		Строка 112:
	* В окне '''VS Code''' необходимо открыть рабочее пространство или папку.		* В окне '''VS Code''' необходимо открыть рабочее пространство или папку.
	* Вам необходимо подключиться к среде Ключ-АСТРОМ.		* Вам необходимо подключиться к среде Ключ-АСТРОМ.
	* Параметр <code>~~dynatraceExtensions~~.rootOrCaCertificate</code> необходимо задать либо глобально, либо для рабочей области.		* Параметр <code>astromkeyExtensions.rootOrCaCertificate</code> необходимо задать либо глобально, либо для рабочей области.

	=== Этапы рабочего процесса ===		=== Этапы рабочего процесса ===
Строка 122:		Строка 122:
	# Проверяются локальные пути ЕдиногоАгента и АктивногоШлюза на наличие, и выдается запрос на загрузку сертификата в эти расположения.		# Проверяются локальные пути ЕдиногоАгента и АктивногоШлюза на наличие, и выдается запрос на загрузку сертификата в эти расположения.
	#* В '''Windows''':		#* В '''Windows''':
	#** ЕдиныйАгент: <code>%PROGRAMDATA%\~~dynatrace~~\oneagent\agent\config\certificates</code>		#** ЕдиныйАгент: <code>%PROGRAMDATA%\astromkey\oneagent\agent\config\certificates</code>
	#** АктивныйШлюз: <code>%PROGRAMDATA%\~~dynatrace~~\remotepluginmodule\agent\conf\certificates</code>		#** АктивныйШлюз: <code>%PROGRAMDATA%\astromkey\remotepluginmodule\agent\conf\certificates</code>
	#* В '''Linux''':		#* В '''Linux''':
	#** ЕдиныйАгент: <code>/var/lib/~~dynatrace~~/oneagent/agent/config/certificates</code>		#** ЕдиныйАгент: <code>/var/lib/astromkey/oneagent/agent/config/certificates</code>
	#** АктивныйШлюз: <code><CONFIG>/remotepluginmodule/agent/conf/certificates/</code>		#** АктивныйШлюз: <code><CONFIG>/remotepluginmodule/agent/conf/certificates/</code>

IKuznetsov: Новая страница: «Все основные рабочие процессы, автоматизированные дополнением '''Ключ-АСТРОМ Extensions''', пр...»

2025-09-17T20:16:37Z

Новая страница: «Все основные рабочие процессы, автоматизированные дополнением '''Ключ-АСТРОМ Extensions''', пр...»

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

Все основные рабочие процессы, автоматизированные дополнением '''Ключ-АСТРОМ Extensions''', представлены в виде команд '''VS Code''' и доступны на палитре команд редактора. Чтобы открыть палитру команд, нажмите клавишу '''F1'''. Там вы найдете все доступные команды с префиксом '''Ключ-АСТРОМ Extensions'''.

== Обзор команд ==
{| class="wikitable"
!Команда
!Описание
|-
|Инициализировать рабочее пространство
|Зарегистрируйтесь и инициализируйте своё рабочее пространство. Первый шаг к началу работы.
|-
|Схемы загрузки
|Загрузите файлы схемы и настройте проверку манифеста
|-
|Сгенерировать сертификаты
|Генерация сертификатов разработчика для подписи расширений
|-
|Распространить сертификат
|Распространите свой сертификат CA среди компонентов, которые его используют.
|-
|Собрать
|Создайте свое расширение и подписанный пакет
|-
|Загрузить
|Загрузите последний пакет расширения в вашу среду Ключ-АСТРОМ.
|-
|Активировать
|Активировать версию текущего расширения
|-
|Создать документацию
|Создайте файл <code>README.md</code> о расширении и его содержимом.
|-
|Создать дашборд
|Создайте дашборд целевой страницы для интеграции с вашим расширением
|-
|Создать оповещение
|Сгенерируйте метрические события для оповещения в сочетании с вашим расширением
|-
|Конвертировать JMX
|Преобразование расширения управления Java (JMX) в фреймворк 2.0
|}

== Инициализировать рабочее пространство ==
Эта команда инициализирует новое или существующее рабочее пространство для разработки '''Расширения 2.0''' и регистрирует его в нашем дополнении '''VS Code'''. В ходе инициализации создаются начальная структура папок и несколько шаблонов файлов расширения, которые помогут корректно запустить любой проект.

Вы можете подробно изучить эту команду, посетив наше [[Начало работы с VS Code|Руководство по началу работы]].

=== Предпосылки для команд ===

* В окне '''VS Code''' необходимо открыть рабочее пространство или папку.
* Вам необходимо подключиться к среде Ключ-АСТРОМ.

=== Этапы рабочего процесса ===

# Обеспечивает внутреннее хранилище для этого проекта.
# Вызовите рабочий процесс из раздела '''Загрузка схем'''. Этот шаг можно пропустить, если вы уже зарегистрировали своё рабочее пространство в '''Ключ-АСТРОМ Extensions'''.
# Связать сертификаты с рабочей областью. <u>Выбрать</u>:
#* '''Использовать существующий''': проверяет настройки сертификата и ключа разработчика.
#* '''Создать новые''': вызывает рабочий процесс из '''Генерации сертификатов''' (ниже).
# Зарегистрируйте рабочее пространство с помощью '''Ключ-АСТРОМ Extensions'''.
# Создайте папку и файлы проекта на основе выбранного шаблона.

=== Шаблоны проектов ===

==== Расширение 2.0 ====
Это вариант по умолчанию. Независимо от того, есть ли у вас уже всё содержимое и вы хотите зарегистрировать рабочее пространство в нашем дополнении или создать новое расширение с нуля, он сгенерирует папку расширения и манифест с минимальным набором обязательных данных для любого расширения.

==== Расширение Python 2.0 ====
Этот параметр создаёт новое расширение, использующее источник данных '''Python'''. В рамках настройки мы также загрузим и установим модуль [https://github.com/dynatrace-extensions/dt-extensions-python-sdk Ключ-АСТРОМ Extensions SDK] для '''Python'''.

==== Преобразование JMX 1.0 ====
Источник данных '''JMX''' теперь доступен в разделе '''Расширения''', а это значит, что пришло время конвертировать ваши расширения '''JMX''' из фреймворка '''1.0'''. Этот тип проекта поможет вам предоставить расширение '''JMX 1.0''' (из локального файла или вашего клиента), которое будет конвертировано в новый фреймворк и создан манифест.

==== Существующее расширение 2.0 ====
Нужно отредактировать уже развёрнутое расширение? Хотите узнать, как выглядит содержимое расширения, созданного с помощью Ключ-АСТРОМ? Этот вариант загружает пакет '''расширения 2.0''' из вашего клиента и распаковывает его в ваше рабочее пространство.

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

=== Предпосылки для команд ===

* Вам необходимо подключиться к среде Ключ-АСТРОМ.

=== Этапы рабочего процесса ===

# Ваша среда Ключ-АСТРОМ будет запрошена на предмет списка доступных версий схемы. Вам будет предложено выбрать нужную версию.
# Файлы, связанные с выбранной версией схемы, загружаются и сохраняются в глобальном хранилище '''Visual Studio Code'''.
#* Если вы уже загружали файлы ранее, вам будет предложено это сделать, и вы можете пропустить этот шаг.
# Настройки рабочей области обновляются, чтобы включить проверку манифеста расширения с помощью выбранной схемы.
#* Если в рабочей области присутствует файл манифеста, он будет обновлен до выбранной минимальной версии.

== Сгенерировать сертификаты ==
Эта команда генерирует все учетные данные, необходимые для подписания и проверки расширений.

=== Предпосылки для команд ===

* В окне '''VS Code''' необходимо открыть рабочее пространство или папку.

=== Этапы рабочего процесса ===

# Для создания вашего сертификата '''CA''' создается пара ключей '''RSA'''.
# Генерируется еще одна пара ключей '''RSA''', которая затем используется для создания вашего сертификата разработчика, добавляя ваш сертификат '''CA''' в качестве органа, выдавшего эти учетные данные.
# Сертификат разработчика генерируется из пары ключей '''RSA''', а сертификат '''CA''' добавляется в качестве выдающего органа этого сертификата.
#* <u>Примечание</u>: Вы можете настроить все данные, используемые для создания этих сертификатов, с помощью настроек.
# Все промежуточные файлы хранятся в хранилище рабочей области '''VS Code''', а настройки учётных данных для этой рабочей области обновляются с учётом путей к сгенерированным файлам. Это делается в файле <code>./vscode/settings.json</code>.
# Вызов рабочего процесса из '''Распространения сертификата''' (ниже)'''.'''

== Распространение сертификата ==
Эта команда загружает сертификат центра сертификации рабочей области в хранилище учётных данных Ключ-АСТРОМ. Кроме того, при обнаружении локально установленных агентов ЕдиногоАгента или АктивногоШлюза этот сертификат также загружается на них.

=== Предпосылки для команд ===

* В окне '''VS Code''' необходимо открыть рабочее пространство или папку.
* Вам необходимо подключиться к среде Ключ-АСТРОМ.
* Параметр <code>dynatraceExtensions.rootOrCaCertificate</code> необходимо задать либо глобально, либо для рабочей области.

=== Этапы рабочего процесса ===

# Надстройка проверяет, связан ли уже идентификатор записи '''Ключ-АСТРОМ Credentials Vault''' с этим рабочим пространством, и выводит запрос на перезапись записи.
#* Если выбрана перезапись, запись обновляется новым файлом.
#* В противном случае рабочий процесс продолжается с созданием новой записи в хранилище учетных данных.
# Вам будет предложено ввести имя для этих учётных данных и ('''необязательно''') описание. После этого файл будет загружен с этими данными.
# Проверяются локальные пути ЕдиногоАгента и АктивногоШлюза на наличие, и выдается запрос на загрузку сертификата в эти расположения.
#* В '''Windows''':
#** ЕдиныйАгент: <code>%PROGRAMDATA%\dynatrace\oneagent\agent\config\certificates</code>
#** АктивныйШлюз: <code>%PROGRAMDATA%\dynatrace\remotepluginmodule\agent\conf\certificates</code>
#* В '''Linux''':
#** ЕдиныйАгент: <code>/var/lib/dynatrace/oneagent/agent/config/certificates</code>
#** АктивныйШлюз: <code><CONFIG>/remotepluginmodule/agent/conf/certificates/</code>

{| class="wikitable"
|Для этого шага '''VS Code''' необходимо запустить с правами администратора. Например, в '''Windows''' используйте '''Запуск от имени администратора'''.
|}

== Сборка ==
Эта команда создает ваше расширение и упаковывает его в подписанный архив '''ZIP'''-файла, а затем помещает его в папку <code>dist</code> рабочей области.

=== Предпосылки для команд ===

* Зарегистрированное рабочее пространство должно быть открыто в окне '''VS Code'''.
* Сертификаты разработчика должны быть связаны с рабочим пространством.
* Не требуется обнаруживать никаких ошибок/проблем с помощью манифеста расширения.

=== Этапы рабочего процесса ===

# Версия расширения берётся из манифеста. Если вы подключены к среде Ключ-АСТРОМ, версия проверяется на наличие конфликтов и автоматически увеличивается при необходимости.
# Манифест расширения и ресурсы упакованы в '''ZIP'''-архив, подписанный с использованием ваших учётных данных разработчика. Полученная подпись и архив добавляются в итоговый '''ZIP'''-файл, представляющий пакет расширения.
# Если вы подключены к среде Ключ-АСТРОМ, пакет проходит проверку. Любые ошибки проверки сообщаются в выходном канале (в окне редактора), и рабочий процесс завершается. Только корректные пакеты перемещаются в папку <code>dist</code> вашего рабочего пространства.
# Вызов рабочего процесса из '''Загрузки''' (ниже).

== Загрузка ==
Эта команда загружает самый последний пакет из папки <code>dist</code> вашего рабочего пространства в подключенную среду.

=== Предпосылки для команд ===

* Зарегистрированное рабочее пространство должно быть открыто в окне '''VS Code'''.
* Вам необходимо подключиться к среде Ключ-АСТРОМ.
* Архивный файл '''ZIP''' должен находиться в папке рабочего пространства <code>dist</code>.

=== Этапы рабочего процесса ===

# Мы проверяем, возможна ли загрузка, запрашивая количество уже развернутых версий этого расширения.
#* Если версий слишком много, вам будет предложено удалить самую старую.
#* Надстройка пытается удалить самую старую версию. Однако если это не удается (например, с ней могут быть связаны конфигурации мониторинга), вам будет предложено выбрать другую версию для удаления.
# Когда это возможно, расширение загружается.
# Для активации этой версии вызовите рабочий процесс из '''Активации''' (ниже).

== Активация ==
Эта команда активирует версию расширения вашего рабочего пространства.

=== Предпосылки для команд ===

* Зарегистрированное рабочее пространство должно быть открыто в окне '''VS Code'''.
* Вам необходимо подключиться к среде Ключ-АСТРОМ.

=== Этапы рабочего процесса ===

# Имя расширения считывается из манифеста в вашем рабочем пространстве.
# Ваша среда Ключ-АСТРОМ будет проанализирована на наличие доступных версий расширения, и вам будет предложено выбрать, какую из них активировать.
#* Этот шаг пропускается, если команда вызывается из другого рабочего процесса. Например, '''Загрузка''' (выше).
# Выбранная версия активируется в вашей среде Ключ-АСТРОМ.

== Создание документации ==
Эта команда автоматически генерирует расширенную документацию в файле <code>README.md</code>, анализируя пакет расширения и его содержимое.

=== Предпосылки для команд ===

* Зарегистрированное рабочее пространство должно быть открыто в окне '''VS Code'''.

=== Этапы рабочего процесса ===

# Команда считывает манифест расширения, извлекая все общие топологические сущности.
# Далее из манифеста извлекаются метрики.
# Далее из манифеста извлекаются дашборды.
# После этого оповещения преобразуются в понятные человеку сводки.
# Метрики сопоставляются с наборами характеристик и связываются с определенными сущностями.
# Создается файл <code>readme</code>, в котором при необходимости пропускается недостающая информация.

== Создание дашборда ==
Эта команда считывает манифест расширения и создает обзорный дашборд, который служит целевой страницей для расширения.

=== Предпосылки для команд ===

* Зарегистрированное рабочее пространство должно быть открыто в окне '''VS Code'''.
* Манифест расширения должен содержать как минимум [[Справка о источнике данных WMI|определение топологии]].

=== Этапы рабочего процесса ===

# Команда извлекает общие типы сущностей, определённые в манифесте, и все связанные с ними метрики. Для каждого типа сущности берутся первые одна или две метрики.
# Ваш дашборд создается на основе шаблона, содержащего следующее:
#* Плитки с отдельными значениями, которые показывают количество отдельных отслеживаемых объектов.
#* Список ссылок разметки, чтобы каждая сущность имела быструю точку входа на свой единый экран анализа.
#* Таблицы для каждого типа сущностей, а также графические диаграммы на основе связанных показателей.
# Ваш дашборд сохраняется в файле <code>./extension/dashboards/overview_dashboard.json</code>, а манифест расширения редактируется для включения ссылки на этот актив.
# Рабочий процесс завершается предложением загрузить этот дашборд в среду Ключ-АСТРОМ.

{| class="wikitable"
|Ваш дашборд будет автоматически загружен в процессе развертывания расширения. Этот последний шаг предлагается, если вы хотите предварительно ознакомиться с ресурсом перед развертыванием расширения.
|}

== Создание оповещения ==
Эта команда создает метрическое событие на основе метрик, определенных в манифесте вашего расширения.

=== Предпосылки для команд ===

* Зарегистрированное рабочее пространство должно быть открыто в окне '''VS Code'''.
* Манифест расширения должен содержать метаданные метрик.

=== Этапы рабочего процесса ===

# Команда анализирует манифест расширения и отображает список всех доступных метрик. Выберите одну, чтобы продолжить.
# Затем вам будет предложено ввести название для этого оповещения.
# Вам необходимо выбрать, произойдет ли нарушение порогового значения, когда метрика станет выше или ниже заданного уровня.
# Наконец, укажите фактическое значение, к которому относится порог оповещения.
# Команда завершается записью '''JSON'''-файла оповещения в папку <code>./extension/alerts</code> и обновлением манифеста расширения для включения в него недавно сгенерированного оповещения.

== Конвертировать JMX ==
Эта команда преобразует существующее расширение '''JMX''' в '''расширение 2.0'''.

=== Этапы рабочего процесса ===

# Вам будет предложено указать, как следует загрузить расширение '''JMX''':
#* '''Локально''' — просмотрите свою файловую систему и выберите файл '''JSON''' или '''ZIP''', содержащий расширение '''JMX'''.
#* '''Удаленно''' — просматривайте расширения '''JMX''', доступные на подключенном клиенте.
# Если не удается определить технологию процесса автоматически, вам будет предложено выбрать ее.
# Вас спросят, следует ли включить данные на страницу сведений о вашем хостере.
# Рабочий процесс обрабатывает '''JSON'''-файл расширения '''JMX''' и преобразует его в эквивалентный манифест '''расширения 2.0'''.
# Рабочий процесс сохраняет сгенерированный манифест в папке <code>extension/extension.yaml</code> или запрашивает место для сохранения, если эта папка отсутствует в вашей рабочей области.

Справочник команд для VS Code - История изменений

IKuznetsov в 16:00, 11 декабря 2025

IKuznetsov: Новая страница: «Все основные рабочие процессы, автоматизированные дополнением '''Ключ-АСТРОМ Extensions''', пр...»