Справочник команд для VS Code

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

Обзор команд

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

Инициализировать рабочее пространство

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

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

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

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

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

1. Обеспечивает внутреннее хранилище для этого проекта.
2. Вызовите рабочий процесс из раздела Загрузка схем. Этот шаг можно пропустить, если вы уже зарегистрировали своё рабочее пространство в Ключ-АСТРОМ Extensions.
3. Связать сертификаты с рабочей областью. Выбрать:
   • Использовать существующий: проверяет настройки сертификата и ключа разработчика.
   • Создать новые: вызывает рабочий процесс из Генерации сертификатов (ниже).
4. Зарегистрируйте рабочее пространство с помощью Ключ-АСТРОМ Extensions.
5. Создайте папку и файлы проекта на основе выбранного шаблона.

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

Расширение 2.0

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

Расширение Python 2.0

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

Преобразование JMX 1.0

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

Существующее расширение 2.0

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

Схемы загрузки

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

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

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

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

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

Сгенерировать сертификаты

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

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

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

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

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

Распространение сертификата

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

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

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

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

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

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

Сборка

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

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

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

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

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

Загрузка

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

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

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

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

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

Активация

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

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

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

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

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

Создание документации

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

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

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

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

1. Команда считывает манифест расширения, извлекая все общие топологические сущности.
2. Далее из манифеста извлекаются метрики.
3. Далее из манифеста извлекаются дашборды.
4. После этого оповещения преобразуются в понятные человеку сводки.
5. Метрики сопоставляются с наборами характеристик и связываются с определенными сущностями.
6. Создается файл readme, в котором при необходимости пропускается недостающая информация.

Создание дашборда

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

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

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

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

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

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

Создание оповещения

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

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

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

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

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

Конвертировать JMX

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

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

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