Начало работы с VS Code

Материал из Документация Ключ-АСТРОМ
Версия от 16:24, 17 сентября 2025; IKuznetsov (обсуждение | вклад) (Новая страница: «Начните работу с '''Ключ-АСТРОМ Extensions''', следуя этому руководству, чтобы настроить редакт...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Начните работу с Ключ-АСТРОМ Extensions, следуя этому руководству, чтобы настроить редактор Visual Studio Code и создать свое первое расширение и загрузить его в Ключ-АСТРОМ за 5 минут.

Прежде чем начать

Установка

Расширения Ключ-АСТРОМ можно найти в магазине приложений Visual Studio Code. Установите их оттуда или через поиск расширений VS Code.

Токен доступа

Наше дополнение VS Code автоматизирует многие операции по разработке Расширений 2.0 с помощью API Ключ-АСТРОМ.

Чтобы получить от этого максимум пользы, создайте токен доступа API со следующими областями действия:

  • WriteConfig
  • ReadConfig
  • credentialVault.read
  • credentialVault.write
  • extensions.read
  • extensions.write
  • extensionEnvironment.write
  • extensionEnvironment.read
  • extensionConfigurations.read
  • extensionConfigurations.write
  • metrics.read
  • entities.read
  • settings.read
  • settings.write
Пользовательский интерфейс Ключ-АСТРОМ предоставляет специальный шаблон под названием Extension Development (Разработка расширений), который применяет именно эти области действия токенов.

Настройки подключения

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

В этой ситуации вам необходимо изменить настройки, прежде чем продолжить работу с этим руководством. Перейдите в раздел Файл > Параметры > Настройки, разверните раздел Расширения и найдите раздел Расширения Ключ-АСТРОМ. Прокрутите вниз, пока не увидите раздел Параметры подключения клиента, и выберите Изменить в settings.json.

Зарегистрируйте URL-адрес вашей выделенной среды в открытом файле и либо укажите путь к файлу CA, либо отключите проверку SSL. Например:

{

  "dynatraceExtensions.tenantConnectivitySettings": [

    {

      "tenantUrl": "https://my.custom.dynatrace/e/abcd-123",

      "certificatePath": "/tmp/certificates/ca.crt"

    }

  ]

}

Подключение к Ключ-АСТРОМ

Для начала подключитесь к среде Ключ-АСТРОМ. Для подключения выполните следующие действия:

  • Перейдите в расширение Ключ-АСТРОМ Extensions в пользовательском интерфейсе VS Code, затем нажмите кнопку Добавить среду. Вам потребуется указать базовый URL-адрес для доступа к Ключ-АСТРОМ. Он должен соответствовать одному из следующих шаблонов:
    • https://<Id>.live.dynatrace.com для SaaS-сред.
    • https://<Domain>/e/<Id> для сред Managed.
    • https://<Id>.apps.dynatrace.com для новейшей платформы Ключ-АСТРОМ. Примечание: замените <Id> на идентификатор вашей среды и <Domain> на домен вашей среды Managed.
  • Укажите токен доступа API, который вы подготовили ранее, и при желании укажите метку.
  • Установите это как текущую среду.

Надстройка отображает вашу среду в списке и будет использовать её для всех операций API. Подробнее об использовании представления «Среда» см. в разделе Специализированные представления.

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

Пришло время создать ваш первый проект. Если вам нужно открыть другую папку рабочего пространства, выберите « Открыть папку. В противном случае нажмите кнопку Инициализировать рабочее пространство, чтобы начать.

Чтобы узнать, как использовать представление Рабочие пространства, посетите страницу Рабочие пространства Расширений 2.0.

1. Проверка схемы

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

2. Сертификаты разработчиков

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

Проверьте настройки расширения, чтобы узнать точный путь к месту хранения ваших учетных данных.

Рабочий процесс предлагает несколько дополнительных удобных шагов:

  • Использовать ли эти сертификаты по умолчанию для всех рабочих пространств:
    • Это приведет к обновлению глобальных настроек Ключ-АСТРОМ Extensions с учетом этого выбора.
    • В рамках этого руководства выберите Да.
  • Следует ли загружать новый сертификат CA в хранилище учетных данных Ключ-АСТРОМ.
    • Вам необходимо указать название и, по желанию, описание.
    • В рамках этого руководства выберите Да и предоставьте дополнительные сведения.
  • Следует ли загружать новый сертификат CA в локально установленные ЕдиныеАгенты и АктивныеШлюзы.
    • Этот шаг отображается только в том случае, если обнаружена локальная установка ЕдиногоАгента или АктивногоШлюза.
    • Для этого шага потребуется запустить VS Code с правами администратора.
    • В рамках этого руководства выберите Нет.

Чтобы узнать, как использовать имеющиеся у вас сертификаты разработчика, посетите раздел Учетные данные.

3. Шаблон проекта

Заключительный этап рабочего процесса — выбор типа проекта, который вы хотите запустить. Это позволит расширению сгенерировать соответствующие файлы.

Поскольку это ваше первое расширение, выберите на этом этапе Расширения 2.0 ⭐.

Этот параметр является выбором по умолчанию для новых проектов и создает следующую начальную настройку:

  • extension- папка, в которой размещены все ресурсы расширения.
  • extension/extension.yaml- это файл манифеста вашего расширения.
Чтобы узнать больше о других типах проектов, посетите раздел Шаблоны проектов.

Кроме того, все шаблоны также создают следующие папки и файлы:

  • .vscode- папка для хранения настроек VS Code, специфичных для рабочего пространства.
  • dist- папка для хранения всех пакетов расширений.
  • config- папка для хранения файлов конфигурации мониторинга.
  • .gitignore- файл, содержащий полезные правила для игнорирования ненужных элементов из вашего git-репозитория.

Внесите некоторые изменения в ваше расширение

Для начала откройте манифест расширения и внесите несколько изменений. Дайте расширению название и укажите себя в качестве автора.

Например, обновите файл extension/extension.yaml, указав следующую информацию:

name: custom:my.first.extension

version: "0.0.1"

minDynatraceVersion: "1.265.0"

author:

  name: <Your-Name>

Замените <Your-Name> именем автора.

Опубликуйте свое расширение

Наконец, выполните следующие шаги для загрузки вашего расширения в Ключ-АСТРОМ.

  1. Нажмите клавишу F1 и выберите команду Расширения Ключ-АСТРОМ: Сборка. Рабочий процесс выполнит сборку вашего расширения, создав пакет в вашей папке dist.
  2. При появлении запроса на загрузку расширения в Ключ-АСТРОМ выберите Да.
  3. При появлении запроса на активацию данной версии расширения выберите Да.

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

Источник — https://doc.fit4u.kz/index.php?title=Начало_работы_с_VS_Code&oldid=5746