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

2025-12-11T16:01:18Z

← Предыдущая версия		Версия от 16:01, 11 декабря 2025
Строка 126:		Строка 126:

	* '''Запрос данных''' — действие, которое запускает запрос селектора сущностей и визуализирует его результаты.		* '''Запрос данных''' — действие, которое запускает запрос селектора сущностей и визуализирует его результаты.
	* '''Проверка''' '''селектора''' — действие для проверки этого селектора на соответствие вашей среде ~~Dynatrace~~.		* '''Проверка''' '''селектора''' — действие для проверки этого селектора на соответствие вашей среде Ключ-АСТРОМ.
	* '''Значок''', отображающий последний статус проверки для этого селектора. Наведите на него курсор, чтобы узнать подробности.		* '''Значок''', отображающий последний статус проверки для этого селектора. Наведите на него курсор, чтобы узнать подробности.

Строка 175:		Строка 175:

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

	=== Как работает индивидуальная диагностика? ===		=== Как работает индивидуальная диагностика? ===

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

2025-09-17T19:19:18Z

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

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

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

Продолжайте читать, чтобы узнать, как максимально эффективно использовать эти функции.

== Обзор функций ==
{| class="wikitable"
!Тип объекта
!Описание
|-
|Дополнения кода
|Предложения по автодополнению слов или полей манифеста
|-
|Действия кода
|Команды, генерирующие или редактирующие содержимое манифеста вашего расширения
|-
|Линза кода
|Дополнительные команды для взаимодействия с данными расширения
|-
|Режим быстрой разработки
|Рабочий процесс, ориентированный на скорость доставки
|-
|Диагностика
|Дополнительная диагностика помимо простой проверки схемы
|}

== Дополнения кода ==
Автодополнение кода или подсказки появляются в ключевых точках манифеста расширения. Они автоматически или по запросу ('''Ctrl + Пробел''') предлагают известные значения, которые можно вставить в позицию курсора.

=== Реализованные триггеры ===
{| class="wikitable"
!Триггер ключевого слова
!Эффекты
|-
|В элементах списка <code>fromType:</code> или <code>toType:</code> внутри <code>topology.relationships</code>
|Просматривайте встроенные и пользовательские типы сущностей
|-
|В элементах <code>sourceAttribute:</code> внутреннего списка <code>mappingRules</code> топологических отношений
|Просмотреть атрибуты сущности (сущность должна присутствовать в атрибуте <code>fromType</code>)
|-
|В элементах <code>destinationAttribute:</code> внутреннего списка <code>mappingRules</code> топологических отношений
|Просмотр атрибутов сущности (сущность должна присутствовать в атрибуте <code>toType</code>)
|-
|На <code>entityType:</code> и <code>entityTypes:</code>
|Просмотрите соответствующие типы сущностей
|-
|Вкл. <code>key:</code> (атрибутов внутри свойств экрана)
|Атрибуты предлагаются на основе топологии и встроенных значений.
|-
|На <code>entitySelectorTemplate:</code>
|Используйте сочетание клавиш '''Ctrl + Пробел''' для запуска автодополнения при создании селектора или выберите один из готовых селекторов (из связей, указанных в вашем манифесте).
|-
|Вкл. <code>iconPattern:</code> (в пределах правил топологии) или <code>icon:</code> (в пределах заголовка staticContent)
|Просмотрите доступные коды иконок Barista
|-
|На <code>key:</code> (карточек в <code>screens</code>, либо в макете, либо в отдельных списках)
|Просмотреть ключи карт, определенных, но еще не использованных
|-
|Вкл. <code>value:</code>, для метрик и измерений расширения Prometheus
|Просматривайте метрики и параметры, полученные с помощью кода Prometheus.
|-
|В разделе <code>description:</code> (в манифесте <code>metrics</code>)
|Для тех метрик, которые были получены с помощью кода Prometheus, добавьте описание из полученных данных.
|}

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

=== В настоящее время реализованы триггеры ===
{| class="wikitable"
!Триггер действия
!Эффекты
|-
|Внутри <code>propertiesCard</code> при нажатии на свойства
|Автоматически добавить свойства для атрибутов и отношений сущности
|-
|Внутри <code>entitiesListCards</code> при нажатии на столбцы
|Автоматически добавить столбцы для атрибутов и связей перечисленных сущностей
|-
|Внутри <code>chartsCards</code> и <code>entitiesListCards</code> при нажатии на диаграммы внутри карточки
|Автоматически добавить диаграммы для показателей, которых еще нет в карточке
|-
|Внутри <code>graphChartConfig</code> при нажатии на метрики
|Добавить в диаграмму больше показателей, которые не используются в окружающей карточке.
|-
|Внутри <code>screens</code> при нажатии на <code>chartsCards</code>
|Автоматически добавить карты диаграмм для целых наборов показателей
|-
|Внутри <code>screens</code> при нажатии на <code>entitiesListCards</code>
|Автоматически добавить карточки для листинга этого объекта, а также связанных с ним объектов
|-
|При нажатии на ссылку <code>metrics</code> в источнике данных Prometheus
|Автоматически добавить данные из скопированной конечной точки Prometheus
|-
|На <code>screens</code>
|Автоматически создать целые экраны унифицированного анализа для ваших сущностей
|-
|Внутри <code>entitiesListCards</code> при нажатии на <code>filtering</code>
|Вставить целые блоки фильтрации с фильтром по имени по умолчанию
|-
|Внутри <code>entitiesListCards</code> и внутри <code>filtering</code>, при нажатии на <code>filters</code>
|Вставить индивидуальный фильтр для атрибутов сущности
|-
|Внутри <code>screens</code> при нажатии на <code>actions</code>
|Вставить глобальные действия для настройки расширения
|-
|Внутри <code>actions</code> при нажатии на <code>actions</code>
|Вставить выражение действия для настройки расширения.
|}

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

=== Метрические селекторы ===
Линза автоматически появляется в любом месте <code>metricSelector</code> и показывает:

* '''Запрос данных''' — действие, которое запускает запрос селектора метрик и визуализирует его результаты.
* '''Проверка селектора''' — действие для проверки этого селектора на соответствие вашей среде Ключ-АСТРОМ.
* '''Значок''', отображающий последний статус проверки для этого селектора. Наведите на него курсор, чтобы узнать подробности.

Результаты выбора метрик отображаются на отдельной панели метрик.

Любые ошибки, возникающие при запросах к вашей среде, отображаются на панели вывода Ключ-АСТРОМ (по умолчанию в нижней части редактора).

=== Селекторы сущностей ===
Линза автоматически появляется везде, где упоминается <code>entitySelector</code>, и показывает:

* '''Запрос данных''' — действие, которое запускает запрос селектора сущностей и визуализирует его результаты.
* '''Проверка''' '''селектора''' — действие для проверки этого селектора на соответствие вашей среде Dynatrace.
* '''Значок''', отображающий последний статус проверки для этого селектора. Наведите на него курсор, чтобы узнать подробности.

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

=== Prometheus ===
Линза появляется автоматически после определения источника данных '''Prometheus''' и показывает:

* '''Сбор данных''' — действие, которое подключается к конечной точке скрапера Prometheus и собирает ее данные.
* '''Изменить конфигурацию''' — действие, позволяющее вносить изменения в подключенную конечную точку Prometheus.
* '''Текст''', указывающий статус последнего действия по сбору данных, например, временную метку и количество собранных метрик.

После извлечения данных их можно использовать с действиями кода для:

* Вставки определения метрик в раздел манифеста <code>prometheus</code>
* Вставки размера в раздел манифеста <code>prometheus</code>
* Вставки метрических метаданных в раздел манифеста <code>metrics</code>

=== Запросы интерфейса управления Windows (WMI) ===
Линза автоматически появляется над запросами внутри определения источника данных '''WMI''' и показывает:

* '''Выполнить запрос WMI''': действие, которое запускает ваш запрос на локальном компьютере '''Windows'''.
* '''Текст''', указывающий сводку результатов запроса (т. е. сколько экземпляров объектов было найдено)

Полные результаты выполнения '''WMI'''-запроса отображаются на отдельной панели. После выполнения запроса вы можете использовать результаты с помощью автодополнения кода .

=== Унифицированные экраны анализа ===
Линза автоматически появляется над определениями типов сущностей внутри элемента манифеста <code>screens</code> и показывает:

* '''Открыть список''': действие, открывающее окно браузера для просмотра списка унифицированного анализа этой сущности.
* '''Открыть представление сведений''': действие, открывающее окно браузера для представления сведений об унифицированном анализе этой сущности.

{| class="wikitable"
|Если ваш тип сущности еще не существует - '''код ответа 404'''.
|}

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

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

Сопутствующая строка состояния подтверждает, что режим активен, и отображает статус последней попытки сборки.

При таком рабочем процессе проверка перед загрузкой пропускается в угоду скорости, а любые проблемы немедленно сообщаются через выходной канал.

При разработке статических активов, таких как экраны унифицированного анализа, этот режим — самый быстрый способ циклически просматривать различные изменения, прежде чем найти идеальную конфигурацию.

== Диагностика ==
Зачастую совершенно корректный YAML-файл всё равно создаёт манифест, который вызывает проблемы при загрузке расширения в Dynatrace или при его последующем запуске. Многие из таких ситуаций можно обнаружить на ранних этапах, и Dynatrace Extensions стремится выявить их, чтобы вы могли исправить их и сократить количество неудачных попыток развёртывания.

=== Как работает индивидуальная диагностика? ===
При каждом редактировании манифеста расширения набор диагностических инструментов будет обновлять все диагностические элементы, относящиеся к этому файлу. На основе результатов поиска соответствующий контент выделяется в манифесте, а наведение курсора на выделенный фрагмент позволяет получить более подробную информацию о проблеме.

В некоторых случаях при наведении курсора может отображаться ссылка '''Быстрое исправление'''. Если она доступна, содержимое документа будет изменено для устранения выделенной проблемы.

<u>Предупреждения о диагностике:</u>

* <code>Error</code>— эти результаты выделены красным цветом и представляют проблемы, которые могут привести к сбою расширения при его развертывании. Команда '''Сборка''' не будет работать, если в манифесте есть диагностика уровня серьёзности <code>Error</code>.
* <code>Warning</code>— эти результаты выделены желтым цветом и представляют собой проблемы, которые не препятствуют функционированию расширения, но все же могут привести к нежелательному поведению.

=== В настоящее время реализована диагностика ===
{| class="wikitable"
!Код
!Серьезность
!Что это значит?
|-
|DED001
|<code>Error</code>
|У вашего расширения нет имени, которое является обязательным.
|-
|DED002
|<code>Error</code>
|Имя вашего расширения должно содержать менее 50 символов.
|-
|DED003
|<code>Error</code>
|Имя вашего расширения недействительно. Оно должно содержать только строчные буквы, цифры, дефисы, символы подчёркивания и точки.
|-
|DED004
|<code>Error</code>
|Имя вашего расширения должно начинаться с <code>custom:</code>, но это не так.
|-
|DED005
|<code>Warning</code>
|Внутренние имена расширений Ключ-АСТРОМ не должны начинаться с <code>custom:</code>.
|-
|DED006
|<code>Warning</code>
|Метрики типа <code>count</code> должны иметь ключи, заканчивающиеся на <code>.count</code> или <code>_count</code> .
|-
|DED007
|<code>Warning</code>
|Метрики типа <code>gauge</code> не должны иметь ключей, заканчивающихся на <code>.count</code> или <code>_count</code>.
|-
|DED008
|<code>Error</code>
|Вы упомянули эту карту-ключ в макете экрана, но у нее нет определения.
|-
|DED009
|<code>Warning</code>
|Вы определили эту карту, но не ссылаетесь на нее в макете экрана.
|-
|DED010
|<code>Warning</code>
|Данные об этом идентификаторе объекта ('''OID''') отсутствуют в сети. Рекомендуем проверить его.
|-
|DED011
|<code>Error</code>
|Этот '''OID''' недоступен для чтения. Права доступа ( [https://learn.microsoft.com/en-us/windows/win32/wmisdk/access-and-max-access-clauses MAX-ACCESS] ) не позволяют это сделать.
|-
|DED012
|<code>Error</code>
|Этот '''OID''' возвращает строку, но вы используете ее в качестве значения метрики.
|-
|DED013
|<code>Warning</code>
|Этот '''OID''' возвращает счетчик, но вы используете его в качестве метрики <code>Gauge</code>.
|-
|DED014
|<code>Warning</code>
|Этот '''OID''' возвращает показатель, но вы используете его в качестве метрики счетчика.
|-
|DED015
|<code>Error</code>
|Неверный синтаксис '''OID'''. '''OID''' не должен начинаться/заканчиваться с «'''.'''» и может содержать только точки и цифры.
|-
|DED016
|<code>Error</code>
|Неверный синтаксис '''OID'''. '''OID''' не должны заканчиваться на «'''.0'''», если для «'''table'''» в подгруппе установлено значение «'''true'''».
|-
|DED017
|<code>Error</code>
|Неверный синтаксис '''OID'''. '''OID''' должны заканчиваться на «'''.0'''», если для «'''table'''» в подгруппе задано значение «'''false'''».
|-
|DED018
|<code>Error</code>
|В онлайн-данных этот '''OID''' указан как статический, но вы используете его внутри подгруппы «'''table'''».
|-
|DED019
|<code>Error</code>
|Онлайн-данные сопоставляют этот '''OID''' с записями таблицы, но вы не используете его внутри подгруппы «'''table'''».
|}
Сам код ничего не означает; он просто предоставляет уникальный идентификатор среди всех диагностических сообщений, которые могут появляться в '''VS Code'''. Мы выбрали префикс '''DED''', чтобы обозначить '''диагностика расширений Ключ-АСТРОМ'''.

Поддержка разработки для VS Code - История изменений

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

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