Просмотр кода страницы Справка о единых страницах анализа

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

== <code>detailsSettings</code> ==
Чтобы настроить экран с подробными данными, начните с указания типов информации <code>detailsSettings</code>, которые должны быть включены на единой странице анализа. Это позволит вам настроить страницу таким образом, чтобы отображались все наиболее актуальные и полезные для вас данные, диаграммы и визуализации.
{| class="wikitable"
|detailsSettings:

      staticContent:

        showProblems: true

        showProperties: true

        showTags: true

        showGlobalFilter: true

        showAddTag: true

      layout:

        autoGenerate: false

        cards:

          - key: cpu_mem

            type: CHART_GROUP

          - key: disks

            type: ENTITIES_LIST
|}

=== <code>staticContent</code> ===
Включать или отключать статические элементы, такие как задачи, свойства, теги, глобальный фильтр и опция '''Добавить тег'''.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>showProblems</code>
|boolean
|Если <code>true</code>, то на экране с подробной информацией отобразится проблемная карта.
|Необходимо
|-
|<code>showProperties</code>
|boolean
|Если <code>true</code>, на экране с подробной информацией отобразится карточка свойств.
|Необходимо
|-
|<code>showTags</code>
|boolean
|Если <code>true</code>, на экране с подробной информацией отображаются теги сущностей.
|Необходимо
|-
|<code>showFilterBar</code>
|boolean
|Если <code>true</code>, на экране с подробной информацией отобразится панель фильтров.
|Необходимо
|-
|<code>showAddTag</code>
|boolean
|Если <code>true</code>, на экране с подробной информацией отобразится опция Добавить тег.
|Необходимо
|}

=== <code>layout</code> ===
Справочные карточки, которые должны отображаться на экране (например, группы диаграмм или списки сущностей), или использовать автоматически сгенерированный макет экрана.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>autoGenerate</code>
|boolean
|Если <code>true</code>, содержимое экрана генерируется автоматически.
|Необходимо
|-
|<code>cards</code>
|enum
|Возможные значения для поля <code>type</code>: <code>CHART_GROUP</code>, <code>ENTITIES_LIST</code>, <code>EVENTS</code>, <code>LOGS</code>, <code>MESSAGE</code>, <code>METRIC_TABLE</code>, <code>INJECTIONS</code>, <code>BREAK_LINE</code>, <code>HEALTH_CARD</code>, <code>CARD_GROUP</code>.
|Необязательно
|}

== <code>detailsInjections</code> ==
Поле <code>detailsInjections</code> определяет параметры внедрения кода для страницы с подробными сведениями о сущности. Эта информация может быть использована для более точной оценки пользовательского опыта, а также для анализа первопричин проблем.
{| class="wikitable"
|Экран должен поддерживать внедрение контента — макет должен включать в себя место для размещения внедряемых карточек.
|}
{| class="wikitable"
|detailsInjections:

      - type: CHART_GROUP

        entitySelectorTemplate: type(custom:host), toRelationship.sameAs($(entityConditions))

        key: injectedChartGroups

      - type: ENTITIES_LIST

        key: injectedList

        width: HALF_SIZE

      - type: EVENTS

        key: injectedEvents

        width: FULL_SIZE
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>type</code>
|enum
|Определяет тип карточек, доступных для внедренмия. Возможные значения: <code>CHART_GROUP</code>, <code>ENTITIES_LIST</code>, <code>EVENTS</code>, <code>LOGS</code>, <code>MESSAGE</code>, <code>HEALTH_CARD</code>, <code>CARD_GROUP</code>, <code>METRIC_TABLE</code>.
|Необходимо
|-
|<code>key</code>
|String
|Уникальный ключ карточки, используемый для указания желаемой конфигурации карты.
|Необходимо
|-
|<code>entitySelectorTemplate</code>
|String
|Селектор сущностей, указывающий на связанные сущности.
{| class="wikitable mw-collapsible mw-collapsed"
!Подробнее
|-
|Он может служить нескольким целям — выбору Objectа, для которого будет отображаться диаграмма, и фильтрации их на основе определенных правил или связанных Objectов. Он используется в сочетании с <code>entityType</code> для дальнейшего уточнения того, какие Objectы подходят для карточки. Например, если <code>entityType</code> это <code>HOST</code>, вы можете использовать <code>entitySelectorTemplate</code> для отображения карточки только для хостов, использующих определенную операционную систему.

<code>$entityConditions</code> выступает в качестве динамического заполнителя, адаптируясь к контексту, в котором отображается карточка. Например, когда карточка отображается на странице, посвященной конкретному хосту, <code>$entityConditions</code> автоматически подстраивается под условия, применимые к этому хосту.

Например, когда на главной странице отображается карточка со следующей конфигурацией.
{| class="wikitable"
|"entitySelectorTemplate": "type(NETWORK_INTERFACE) AND fromRelationships.isNetworkInterfaceOf($(entityConditions))"
|}
Заполнитель <code>$(entityConditions)</code> будет автоматически заменен, чтобы указывать на конкретный хост-Object.
{| class="wikitable"
|"entitySelectorTemplate": "type(NETWORK_INTERFACE) AND fromRelationships.isNetworkInterfaceOf(type(HOST) AND entityId(HOST-<id>))"
|}
|}
|Необязательно
|-
|<code>width</code>
|enum
|Параметр, определяющий, сколько вертикального пространства занимает карточка. Возможные значения: <code>HALF_SIZE</code>, <code>FULL_SIZE</code>.
|Необязательно
|}

== <code>detailsFilter</code> ==
Поле <code>detailsFilter</code> определяет фильтры для экрана с подробными сведениями об Objectе. Оно позволяет настроить страницу таким образом, чтобы отображались только нужные данные. Если на экране есть разбиения по измерениям (диаграмма или таблица метрик), автоматически отображаются фильтры по метрическим измерениям. Чтобы отображать только фильтры по метрическим измерениям, задайте для этого поля пустое значение (<code>detailsFilters: {}</code>).
{| class="wikitable"
|detailsFilters:

      relationships:

        - type(HOST_GROUP), toRelationship.isInstanceOf($(entityConditions))

        - type(AZURE_REGION), fromRelationship.isSiteOf($(entityConditions))

      entityFilters:

        - displayName: filters

          filters:

            - type: entityName

              displayName: name

              freeText: false

              modifier: contains

              defaultSearch: true

              distinct: false

              entityTypes:

                - my:interface
|}

=== <code>relationships</code> ===
Вы можете включить фильтрацию, настроив связь между типом сущности экрана и связанным типом сущности. Например, отфильтровать список процессов по имени хоста:
{| class="wikitable"
|relationships:

  - type(HOST) AND toRelationship.isProcessOf($(entityConditions))
|}
Вы также можете настроить фильтрацию на нескольких уровнях. Например, отфильтровать процессы по имени группы хостов:
{| class="wikitable"
|relationships:

  - type(HOST) AND toRelationship.isProcessOf($(entityConditions))

  - type(HOST) AND fromRelationship.isInstanceOf(type(HOST_GROUP))
|}

=== <code>entityFilters</code> ===
Блок, определяющий группы фильтров (они отображаются слегка затемненными в списке фильтров).
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>filters</code>
|Array
|Сами фильтры, входящие в эту группу.
|Необходимо
|-
|<code>type</code>
|String
|Необходимо указать атрибут сущности, которую вы фильтруете. Примечание: каждая сущность имеет атрибут <code>entityName</code> по умолчанию.
|Необходимо
|-
|<code>displayName</code>
|String
|Как этот фильтр обозначен в веб-интерфейсе.
|Необходимо
|-
|<code>freeText</code>
|boolean
|Если значение равно <code>true</code>, пользователь может свободно вводить текст; в противном случае он должен выбрать текст из списка подсказок. Примечание: только атрибуты по умолчанию, такие как <code>entityName</code>, могут предлагать списки подсказок.
|Необходимо
|-
|<code>modifier</code>
|boolean
|Если значение <code>freeText</code> '''true''', это определяет, как текст должен сопоставляться с атрибутом. Если значение <code>freeText</code> '''false''', этот параметр необходимо опустить. Примечание: Все атрибуты, отличные от атрибутов по умолчанию, должны соответствовать этому значению <code>equals</code> независимо от этого параметра.
|Необязательно
|-
|<code>defaultSearch</code>
|boolean
|Если <code>true</code> пользователь начинает вводить текст, не выбрав предварительно фильтр, этот фильтр выбирается по умолчанию. В пределах блока <code>filtering</code> может быть включен только один фильтр.
|Необязательно
|-
|<code>distinct</code>
|boolean
|Если <code>true</code>, то может быть применен только один экземпляр этого фильтра.
|Необходимо
|-
|<code>entityTypes</code>
|Array
|Обязательный список типов сущностей, к которым применяется этот фильтр. Если вы его опустите, на панели фильтрации отобразится только вращающееся колесо из-за неполного определения.
|Необязательно
|}

== <code>listSettings</code> ==
В разделе <code>listSettings</code> вы можете настроить отображение списка на странице унифицированного анализа. Вы можете измеString выбор и порядок столбцов, способ сортировки списка, а также количество отображаемых строк.
{| class="wikitable"
|listSettings:

      staticContent:

        showGlobalFilter: true

        header:

          title: My hosts

          description: My hosts list

          icon: host

      layout:

        autoGenerate: false

        cards:

          - type: CHART_GROUP

            key: chart

          - type: ENTITIES_LIST

            key: entitiesList

          - type: INJECTIONS
|}

=== <code>staticContent</code> Необходимо ===
Включать или отключать статические элементы, такие как задачи, свойства, теги, глобальный фильтр и параметр '''Добавить тег'''.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>showProblems</code>
|boolean
|Если <code>true</code>, то на экране с подробной информацией отобразится проблемная карта.
|Необязательно
|-
|<code>showProperties</code>
|boolean
|Если <code>true</code>, на экране с подробной информацией отобразится карточка свойств.
|Необязательно
|-
|<code>showTags</code>
|boolean
|Если <code>true</code>, на экране с подробной информацией отображаются теги сущностей.
|Необязательно
|-
|<code>showGlobalFilter</code>
|boolean
|Если <code>true</code>, на экране с подробной информацией отобразится панель фильтров.
|Необходимо
|-
|<code>showAddTag</code>
|boolean
|Если <code>true</code>, на экране с подробной информацией отобразится опция Добавить тег.
|Необязательно
|-
|<code>header</code>
|Object
|Определение заголовка страницы.
|Необязательно
|-
|<code>breadcrumbs</code>
|Array
|Список навигационных цепочек, ведущих на страницу.
|Необязательно
|-
|<code>hideDefaultBreadcrumb</code>
|boolean
|Если установлено значение <code>true</code>, то стандартная навигационная цепочка для текущей страницы будет скрыта.
|Необязательно
|}

=== <code>layout</code> Необходимо ===
Справочные карточки, которые должны отображаться на экране (например, группы диаграмм или списки сущностей), или использовать автоматически сгенерированный макет экрана.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>autoGenerate</code>
|boolean
|Если <code>true</code>, содержимое экрана генерируется автоматически.
|Необходимо
|-
|<code>cards</code>
|enum
|Возможные значения для поля <code>type</code>: <code>CHART_GROUP</code>, <code>ENTITIES_LIST</code>, <code>MESSAGE</code>, <code>INJECTIONS</code>, <code>BREAK_LINE</code>.
|Необязательно
|}

== <code>listInjections</code> ==
Поле <code>listInjections</code> определяет параметры внедрения кода для экрана с подробными сведениями о сущности. Внедрение кода должно поддерживаться самим экраном — макет должен включать в себя место для размещения внедряемых карточек.
{| class="wikitable"
|listInjections:

      - type: CHART_GROUP

        key: injectedChartGroups

      - type: ENTITIES_LIST

        key: injectedList

        width: HALF_SIZE
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>type</code>
|enum
|Определяет тип карточек, доступных для внедрений. Возможные значения: <code>CHART_GROUP</code>, <code>ENTITIES_LIST</code>, <code>MESSAGE</code>, <code>METRIC_TABLE</code>.
|Необходимо
|-
|<code>key</code>
|String
|Уникальный ключ карточки, используемый для указания желаемой конфигурации карточки.
|Необходимо
|}

== <code>listFilters</code> ==
Поле <code>listFilters</code> определяет фильтры на странице списка.
{| class="wikitable"
|listFilters:

      relationships:

        - type(HOST_GROUP), toRelationship.isInstanceOf($(entityConditions))

        - type(AZURE_REGION), fromRelationship.isSiteOf($(entityConditions))

      entityFilters:

        - displayName: filters

          filters:

            - type: entityName

              entityTypes:

                - HOST_GROUP

                - AZURE_REGION

              freeText: false

              displayName: name

              distinct: true
|}

=== <code>relationships</code> ===
Вы можете включить фильтрацию, настроив связь между типом сущности экрана и связанным типом сущности. Например, отфильтровать список процессов по имени хоста:
{| class="wikitable"
|relationships:

  - type(HOST) AND toRelationship.isProcessOf($(entityConditions))
|}
Вы также можете настроить фильтрацию на нескольких уровнях. Например, отфильтровать процессы по имени группы хостов:
{| class="wikitable"
|relationships:

  - type(HOST) AND toRelationship.isProcessOf($(entityConditions))

  - type(HOST) AND fromRelationship.isInstanceOf(type(HOST_GROUP))
|}

=== <code>entityFilters</code> ===
Список фильтров сущностей. Для общих сущностей подсказки доступны только для типов фильтров <code>entityName</code>, <code>tag</code>, <code>healthState</code>, и <code>ipAddress</code> / <code>dt.ip_addresses</code>. Любые пользовательские атрибуты должны быть установлены в значение <code>freeText: true</code> с помощью <code>modifier: equals</code>. Подсказки не поддерживаются, поэтому необходимо ввести точное значение для фильтрации.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>filters</code>
|Array
|Сами фильтры, входящие в эту группу.
|Необходимо
|-
|<code>type</code>
|String
|Необходимо указать атрибут сущности, которую вы фильтруете. Примечание: каждая сущность имеет <code>entityName</code>атрибут по умолчанию.
|Необходимо
|-
|<code>displayName</code>
|String
|Как этот фильтр обозначен в веб-интерфейсе.
|Необходимо
|-
|<code>freeText</code>
|boolean
|Если значение равно <code>true</code>, пользователь может свободно вводить текст; в противном случае он должен выбрать текст из списка подсказок. Примечание: только атрибуты по умолчанию, такие как <code>entityName</code>, могут предлагать списки подсказок.
|Необходимо
|-
|<code>modifier</code>
|boolean
|Если значение <code>freeText</code> '''true''', это определяет, как текст должен сопоставляться с атрибутом. Если значение <code>freeText</code> '''false''', этот параметр необходимо опустить. Примечание: Все атрибуты, отличные от атрибутов по умолчанию, должны соответствовать значению <code>equals</code> независимо от этого параметра.
|Необязательно
|-
|<code>defaultSearch</code>
|boolean
|Если <code>true</code> пользователь начинает вводить текст, не выбрав предварительно фильтр, этот фильтр выбирается по умолчанию. В пределах блока <code>filtering</code> может быть включен только один фильтр.
|Необязательно
|-
|<code>distinct</code>
|boolean
|Если <code>true</code>, то может быть применен только один экземпляр этого фильтра.
|Необходимо
|-
|<code>entityTypes</code>
|Array
|Обязательный список типов сущностей, к которым применяется этот фильтр. Если вы его опустите, на панели фильтрации отобразится только вращающееся колесо из-за неполного определения.
|Необязательно
|}

== <code>propertiesCard</code> ==
В поле <code>propertiesCard</code> отображаются свойства сущности, показанные на карточке, в виде пар «ключ-значение». По умолчанию отображаются все доступные свойства атрибутов.
{| class="wikitable"
|propertiesCard:

      properties:

        - type: RELATION

          relation:

            entitySelectorTemplate: NOT VALIDATED IN SCHEMA

            displayName: default

        - type: ATTRIBUTE

          attribute:

            key: attribute

            displayName: Attribute
|}

=== <code>properties</code> Необходимо ===
Используйте эту конфигурацию для указания карточки свойств.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>type</code>
|enum
|Определяет тип свойства. Возможные значения: <code>RELATION</code>, <code>ATTRIBUTE</code>.
|Необязательно
|}

=== <code>RELATION</code> ===
Позволяет указать связь с конкретной сущностью.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>entitySelectorTemplate</code>
|String
|[[Селектор объектов|Селектор сущностей]], используемый для получения выбранных сущностей.
{| class="wikitable mw-collapsible mw-collapsed"
!Подробнее
|-
|Он может служить нескольким целям — выбору Objectа, для которого будет отображаться диаграмма, и фильтрации их на основе определенных правил или связанных Objectов. Он используется в сочетании с <code>entityType</code> для дальнейшего уточнения того, какие Objectы подходят для карточки. Например, если <code>entityType</code> это <code>HOST</code>, вы можете использовать <code>entitySelectorTemplate</code> для отображения карточки только для хостов, использующих определенную операционную систему.

<code>$entityConditions</code> выступает в качестве динамического заполнителя, адаптируясь к контексту, в котором отображается карточка. Например, когда карточка отображается на странице, посвященной конкретному хосту, <code>$entityConditions</code> автоматически подстраивается под условия, применимые к этому хосту.

Например, когда на главной странице отображается карточка со следующей конфигурацией.
{| class="wikitable"
|"entitySelectorTemplate": "type(NETWORK_INTERFACE) AND fromRelationships.isNetworkInterfaceOf($(entityConditions))"
|}
Заполнитель <code>$(entityConditions)</code> будет автоматически заменен, чтобы указывать на конкретный хост-Object.
{| class="wikitable"
|"entitySelectorTemplate": "type(NETWORK_INTERFACE) AND fromRelationships.isNetworkInterfaceOf(type(HOST) AND entityId(HOST-<id>))"
|}
|}
|Необходимо
|-
|<code>displayName</code>
|String
|Название отношения.
|Необходимо
|-
|<code>fallbackMessage</code>
|String
|Отображает дополнительное сообщение, если сущность не найдена. По умолчанию всё свойство скрыто.
|Необязательно
|}

=== <code>ATTRIBUTE</code> ===
Позволяет переопределять параметры отображения атрибутов.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>key</code>
|String
|Используется для ссылки на требуемый атрибут.
|Необходимо
|-
|<code>displayName</code>
|String
|Название атрибута.
|Необязательно
|}

== Карточки групп диаграмм ==
Карточки групп диаграмм позволяют визуализировать указанные показатели на отдельных диаграммах.

* Выражение <code>metricSelector</code> определяет метрики, на которых основана ваша диаграмма. Для получения дополнительной информации см. [[Селектор показателей|API метрик — Селектор метрик]]. В приведенных ниже примерах используются простые выражения селектора метрик, напрямую ссылающиеся на ключи метрик.

{| class="wikitable"
|chartsCards:

      - key: chartGroup

        conditions:

          - NOT VALIDATED IN SCHEMA

        numberOfVisibleCharts: 2

        charts:

          - displayName: Chart

            conditions:

              - NOT VALIDATED IN SCHEMA

            visualizationType: GRAPH_CHART

            graphChartConfig:

              visualization:

                themeColor: DEFAULT

                seriesType: LINE

              metrics:

                - metricSelector: NOT VALIDATED IN SCHEMA

                - metricSelector: builtin:host.cpu.usage:avg

                  visualization:

                    themeColor: DEFAULT

                    seriesType: LINE

          - displayName: Chart2

            visualizationType: PIE_CHART

            pieChartConfig:

              metric:

                metricSelector: NOT VALIDATED IN SCHEMA

              defaultAggregation: AVG

              showLegend: true

              themeColor: ORANGE

          - displayName: Chart3

            visualizationType: SINGLE_VALUE

            singleValueConfig:

              metric:

                metricSelector: NOT VALIDATED IN SCHEMA

              displayName: Single value

              defaultAggregation: COUNT

              showSparkline: true

              showTrend: true
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>key</code>
|String
|Уникальный ключ карточки, используемый для указания желаемой конфигурации карточки.
|Необходимо
|-
|<code>conditions</code>
|Array
|Определяет условия, которые должны быть выполнены для того, чтобы карточка группы диаграмм была видна.
|Необязательно
|-
|<code>numberOfVisibleCharts</code>
|Integer
|Количество диаграмм, отображаемых на странице единого анализа.
|Необходимо
|-
|<code>mode</code>
|enum
|Определяет поведение и интерактивность группы диаграмм. Возможные значения: <code>NORMAL</code>, <code>STATIC</code>.<sup>1</sup>
|Необходимо
|}
<sup>1</sup> Режим <code>NORMAL</code> позволяет взаимодействовать с диаграммами (просматривать различные точки данных или увеличивать/уменьшать масштаб). Диаграммы в режиме <code>STATIC</code> отображаются в фиксированном, ограниченном виде.

=== <code>charts</code> ===
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>displayName</code>
|String
|Название карточки.
|Необходимо
|-
|<code>conditions</code>
|Array
|Определяет условия, которые должны быть выполнены для того, чтобы карточка группы диаграмм была видна.
|Необязательно
|}

=== <code>visualizationType</code> ===
Параметр <code>visualizationType</code> определяет тип диаграммы: график <code>GRAPH_CHART</code>, круговая диаграмма <code>PIE_CHART</code> или диаграмма с одним значением <code>SINGLE_VALUE</code>. Если тип визуализации не указан, по умолчанию отображается график.

==== <code>GRAPH_CHART</code> ====
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>visualization</code>
|enum
|Позволяет задать цвет темы и тип области (<code>COLUMN</code>, <code>LINE</code> или <code>AREA</code>). Также можно включить отображение легенды оси, установив флаг <code>showLegend</code> в значение <code>true</code>.
|Необходимо
|-
|<code>metrics</code>
|Array
|Определяет способ получения данных для отдельной линии на графике.
|Необходимо
|-
|<code>thresholds</code>
|Array
|Определяет пороговые значения, после превышения которых фон диаграммы изменит цвет на выбранный.
|Необязательно
|}

===== <code>metricSelector</code> =====
Выражение для выбора метрики для выделенной метрической строки.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>visualization</code>
|enum
|Позволяет задать цвет темы и тип области (<code>COLUMN</code>, <code>LINE</code> или <code>AREA</code>). Также можно включить отображение легенды оси, установив флаг <code>showLegend</code> в значение <code>true</code>.
|Необязательно
|}

==== <code>PIE_CHART</code> ====
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>metric</code>
|Object
|Определяет способ получения данных для круговой диаграммы.
|Необходимо
|-
|<code>defaultAggregation</code>
|enum
|Определяет агрегацию по умолчанию для временных рядов диаграммы. Если она не определена или не выбрана, агрегация не поддерживается, она определяется на основе метаданных метрик.
|Необязательно
|}

==== <code>SINGLE_VALUE</code> ====
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>metric</code>
|Object
|Определяет способ получения данных для отдельного графика.
|Необходимо
|-
|<code>displayName</code>
|String
|Определяет имя значения.
|Необязательно
|-
|<code>defaultAggregation</code>
|enum
|Определяет агрегацию по умолчанию для временных рядов диаграммы. Если она не определена или не выбрана, агрегация не поддерживается, она определяется на основе метаданных метрик.
|Необязательно
|-
|<code>showSparkline</code>
|boolean
|Если <code>true</code>, то линия развертки видна.
|Необязательно
|-
|<code>showTrend</code>
|boolean
|Если <code>true</code>, то тенденция видна.
|Необязательно
|-
|<code>thresholds</code>
|Array
|Определяет пороговые значения, после превышения которых фон диаграммы изменит цвет на выбранный.
|Необязательно
|-
|<code>foldTransformation</code>
|enum
|Определяет метод преобразования, который сводит данные к одному значению. Возможные значения: <code>AUTO</code>, <code>LAST_VALUE</code>, <code>MAX</code>, <code>MIN</code>, <code>SUM</code>, <code>MEDIAN</code>, <code>VALUE</code>, <code>PERCENTILE_10</code>, <code>PERCENTILE_75</code>, <code>PERCENTILE_90</code>.
|Необязательно
|}

=== Список доступных условий ===
{| class="wikitable"
|<nowiki>ConditionName|param1key=param1value|param2key=param2value</nowiki>
|}
{| class="wikitable"
!Состояние
!Параметры
!Минимальная версия схемы
!Описание
|-
|<code>demo</code>
|Нет
|224
|Используется для демонстрации функции определения условий.
|-
|<code>isSaaS</code>
|Нет
|233
|Указывает, является ли тип развертывания сервера SaaS.
|-
|<code>featureFlag</code>
|Ключ флага функции
|233
|Проверяет состояние флага конкретной функции.
|-
|<code>entityAttribute</code>
|Динамические параметры <sup>1</sup>
|231
|Проверяет, обладает ли отслеживаемый на экране Object определенными атрибутами с указанными значениями или же он существует с любым значением.
|-
|<code>relatedEntity</code>
|<code>entitySelectorTemplate</code>
|230
|Проверяет существование указанной связанной сущности в среде.
|-
|<code>extensionConfigured</code>
|<code>extensionId</code>, <code>aboveOrEqualVersion</code>, <code>belowOrEqualVersion</code>, <code>featureSets</code>, <code>activatedOnHost</code><sup>2</sup>
|243
|Проверяет наличие указанного расширения в среде, учитывая другие параметры.
|-
|<code>uiPermission</code>
|Указанное разрешение пользовательского интерфейса
|243
|Подтверждает наличие у вас указанного разрешения (например, <code>CONFIG_WRITE</code>).
|-
|<code>isActive</code>
|Нет
|246
|Определяет, активен ли отслеживаемый Object на экране.
|-
|<code>serviceType</code>
|Тип сервиса
|246
|Подтверждает тип сервиса. Область действия <code>METype.SERVICE</code> ограничена экранами с подробной информацией.
|-
|<code>typeExists</code>
|Тип службы
|248
|Проверяет наличие указанной службы в среде <code>METype</code>.
|-
|<code>platform</code>
|Нет
|254
|Проверяет совместимость с 3-м поколением.
|-
|<code>metricAvailable</code>
|<code>metric</code><sup>3</sup> ,<code>lastWrittenWithinDays</code> <sup>4</sup>
|256
|Проверяет, связаны ли с данным ключом метрики метаданные и когда они были обновлены в последний раз.
|}
<sup>1</sup> Если параметры заданы с конкретным значением, они форматируются как <code>key=value</code>. Система проверит точное совпадение этой пары <code>key-value</code>. Если указан только ключ без какого-либо сопутствующего значения, система просто проверит наличие этого ключа с помощью <code>.exists()</code>.

<sup>2</sup> Расширение настроено для работы на текущем хосте.

<sup>3</sup> Ключ метрики

<sup>4</sup> Указанное количество дней, в течение которых система проверяет наличие последних обновлений.

== Карточки со списками сущностей ==
В карточке списка сущностей отображаются другие сущности, связанные с выбранной сущностью. Приведенный ниже '''YAML'''-файл содержит список всех дисков '''Synology''', сопоставленных с экземпляром '''DiskStation Manager''', на котором сосредоточено внимание на экране с подробными сведениями.

* Выражение <code>entitySelectorTemplate</code> задаёт сущности, которые следует отобразить на карточке. Для получения дополнительной информации см. [[Селектор показателей|Environment API v2 — Селектор сущностей]].
* В выражении <code>type(syn:disk),fromRelationships.runsOn($(entityConditions))</code> перечислены сущности типа <code>syn:disk</code>, имеющие отношение направления <code>from</code> и типа <code>runsOn</code> к Objectу <code>syn:diskmanager</code>, представленному с помощью заполнителя <code>$(entityConditions)</code>, обозначающего сфокусированную сущность.

{| class="wikitable"
|entitiesListCards:

      - key: disks

        displayName: Synology disks

        pageSize: 10

        displayCharts: false

        entitySelectorTemplate: "type(syn:disk),fromRelationships.runsOn($(entityConditions))"

        displayIcons: true

        enableDetailsExpandability: true

        numberOfVisibleCharts: 2

        columns:

          - type: ATTRIBUTE

            attribute:

              key: some_attribute

              displayName: Some attribute

          - type: RELATION

            relation:

              entitySelectorTemplate: type("syn:partition"),fromRelationship.isChildOf($(entityConditions))

              displayName: Partitions

              displayAmount: false

              fallbackMessage: "no partition"

        filtering:

          relationships:

            - type(syn:partition), fromRelationship.isChildOf($(entityConditions))

          entityFilters:

            - displayName: filters

              filters:

                - type: entityName

                  displayName: name

                  freeText: true

                  modifier: contains

                  defaultSearch: true

                  distinct: false

                  entityTypes:

                    - my:interface

                - type: entityName

                  displayName: Partition name

                  freeText: true

                  modifier: contains

                  defaultSearch: false

                  distinct: false

                  entityTypes:

                    - syn:partition
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>key</code>
|String
|Уникальный ключ карты, используемый для указания желаемой конфигурации карты.
|Необходимо
|-
|<code>displayName</code>
|String
|Название карты.
|Необязательно
|-
|<code>pageSize</code>
|Integer
|Количество строк, отображаемых на одной странице.
|Необходимо
|-
|<code>displayCharts</code>
|boolean
|Если значение равно <code>true</code>нулю, то над таблицей отобразятся диаграммы с агрегированными данными.
|Необходимо
|-
|<code>entitySelectorTemplate</code>
|String
|[[Селектор объектов|Селектор сущностей]] используется для поиска сущностей, которые должны быть отображены в списке.
{| class="wikitable mw-collapsible mw-collapsed"
!Подробнее
|-
|Он может служить нескольким целям — выбору Objectа, для которого будет отображаться диаграмма, и фильтрации их на основе определенных правил или связанных Objectов. Он используется в сочетании с <code>entityType</code> для дальнейшего уточнения того, какие Objectы подходят для карточки. Например, если <code>entityType</code> это <code>HOST</code>, вы можете использовать <code>entitySelectorTemplate</code> для отображения карточки только для хостов, использующих определенную операционную систему.

<code>$entityConditions</code> выступает в качестве динамического заполнителя, адаптируясь к контексту, в котором отображается карточка. Например, когда карточка отображается на странице, посвященной конкретному хосту, <code>$entityConditions</code> автоматически подстраивается под условия, применимые к этому хосту.

Например, когда на главной странице отображается карточка со следующей конфигурацией.
{| class="wikitable"
|"entitySelectorTemplate": "type(NETWORK_INTERFACE) AND fromRelationships.isNetworkInterfaceOf($(entityConditions))"
|}
Заполнитель <code>$(entityConditions)</code> будет автоматически заменен, чтобы указывать на конкретный хост-Object.
{| class="wikitable"
|"entitySelectorTemplate": "type(NETWORK_INTERFACE) AND fromRelationships.isNetworkInterfaceOf(type(HOST) AND entityId(HOST-<id>))"
|}
|}
|Необязательно
|-
|<code>displayIcons</code>
|boolean
|Если значение <code>true</code> равно нулю, в столбце <code>name</code> отображается значок Objectа.
|Необходимо
|-
|<code>enableDetailsExpandability</code>
|boolean
|Если задано значение <code>true</code>, строки можно развернуть диаграммами, связанными со значениями измерений в этой строке.
|Необходимо
|-
|<code>numberOfVisibleCharts</code>
|Integer
|Количество диаграмм, отображаемых на странице единого анализа.
|Необходимо
|-
|<code>displayProblemImpactWidget</code>
|boolean
|Если значение <code>true</code> равно нулю, над списком отобразится виджет, указывающий на то, что некоторые Objectы находятся в неисправном состоянии. Убедитесь, что включена видимая фильтрация с использованием фильтра состояния здоровья.
|Необязательно
|-
|<code>columns</code>
|Object
|Дополнительные столбцы атрибутов или связей.
|Необязательно
|-
|<code>filtering</code>
|Object
|Фильтрация внутри карточки списка сущностей. Она затрагивает только группу таблиц и диаграмм этой карточки.
|Необязательно
|}

=== <code>columns</code> ===
Дополнительные столбцы, отображаемые между столбцами '''Имя''' и '''Диаграмма'''. Доступны 2 типа: '''АТРИБУ'''» и '''СВЯЗЬ'''.

==== <code>RELATION</code> ====
Позволяет указать отношение к сущности (отношение 1:1) или к списку сущностей (отношение 1:n).
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>entitySelectorTemplate</code>
|String
|[[Селектор объектов|Селектор сущностей]], используемый для получения выбранных сущностей.
{| class="wikitable mw-collapsible mw-collapsed"
!Подробнее
|-
|Он может служить нескольким целям — выбору Objectа, для которого будет отображаться диаграмма, и фильтрации их на основе определенных правил или связанных Objectов. Он используется в сочетании с <code>entityType</code> для дальнейшего уточнения того, какие Objectы подходят для карточки. Например, если <code>entityType</code> это <code>HOST</code>, вы можете использовать <code>entitySelectorTemplate</code> для отображения карточки только для хостов, использующих определенную операционную систему.

<code>$entityConditions</code> выступает в качестве динамического заполнителя, адаптируясь к контексту, в котором отображается карточка. Например, когда карточка отображается на странице, посвященной конкретному хосту, <code>$entityConditions</code> автоматически подстраивается под условия, применимые к этому хосту.

Например, когда на главной странице отображается карточка со следующей конфигурацией.
{| class="wikitable"
|"entitySelectorTemplate": "type(NETWORK_INTERFACE) AND fromRelationships.isNetworkInterfaceOf($(entityConditions))"
|}
Заполнитель <code>$(entityConditions)</code> будет автоматически заменен, чтобы указывать на конкретный хост-Object.
{| class="wikitable"
|"entitySelectorTemplate": "type(NETWORK_INTERFACE) AND fromRelationships.isNetworkInterfaceOf(type(HOST) AND entityId(HOST-<id>))"
|}
|}
|Необходимо
|-
|<code>displayName</code>
|String
|Название колонки.
|Необходимо
|-
|<code>displayAmount</code>
|String
|Если значение равно <code>false</code>, сущности отображаются в виде списка (до 20 сущностей). Если значение равно <code>true</code>, количество связанных сущностей отображается в виде ссылки на экран списка. Связанный список предварительно фильтруется только в том случае, если он настроен <code>listFilters</code> с соответствующими связями и фильтром <code>entityName</code> (<code>freeText: true</code> и <code>modifier: contains</code>).
|Необходимо
|-
|<code>fallbackMessage</code>
|String
|Отображает дополнительное сообщение, если Object не найден.
|Необязательно
|}

==== <code>ATTRIBUTE</code> ====
Позволяет указать пользовательский столбец атрибутов.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимо
|-
|<code>key</code>
|String
|Используется для ссылки на требуемый атрибут.
|Необходимо
|-
|<code>displayName</code>
|String
|Название атрибута.
|Необходимо
|}

== Карточки событий ==
На карточках событий отображаются события, связанные с указанными сущностями.
{| class="wikitable"
|eventsCards:

      - key: events

        displayName: Events

        entitySelectorTemplates:

        - "$(entityConditions)",

        - "type(CONTAINER_GROUP_INSTANCE),fromRelationships.isInstanceOf($(entityConditions))",

        - "type(PROCESS_GROUP_INSTANCE),fromRelationships.isPgiOfCgi(type(CONTAINER_GROUP_INSTANCE),fromRelationships.isInstanceOf($(entityConditions)))"

        showFiltering: true

        showPagination: true

        pageSize: 10
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>key</code>
|String
|Уникальный ключ карты, используемый для указания желаемой конфигурации карты.
|Необходимо
|-
|<code>displayName</code>
|String
|Название карты. Если не указано, карты называются по-разному <code>Events</code>.
|Необязательно
|-
|<code>entitySelectorTemplates</code>
|Array
|Список шаблонов выбора сущностей. Определяет, откуда собираются события. Если список пуст, события собираются для текущей сущности.
|Необязательно
|-
|<code>showFiltering</code>
|boolean
|Если значение равно нулю <code>true</code>, то над диаграммой событий отобразится панель фильтрации.
|Необходимо
|-
|<code>showPagination</code>
|boolean
|Если это так <code>true</code>, то действие « Показать больше» доступно в списке событий.
|Необходимо
|-
|<code>pageSize</code>
|Integer
|Количество строк, отображаемых при загрузке карты.
|Необходимо
|-
|<code>description</code>
|String
|Описание карты.
|Необязательно
|-
|<code>eventSelectorTemplate</code>
|String
|Селектор событий, используемый для получения событий для связанных сущностей.
|Необязательно
|-
|<code>displayChart</code>
|boolean
|Показать или скрыть диаграмму на карточке.
|Необязательно
|}

== Карточки логов ==
Поле <code>logsCards</code> определяет поведение карточки логов и имеет ту же функциональность, что и [[Программа просмотра логов|средство просмотра логов]]. Оно состоит из столбчатой диаграммы, отображающей различные события в логах за выбранный период времени, и подробной таблицы, где каждая запись в логе содержит дополнительные свойства, такие как: метка времени, статус, содержимое.
{| class="wikitable"
|logsCards:

      - key: logs

        displayName: Logs

        enablePaging: true

        filterQuery: event.type!="k8s" AND ($(logEntityAttributeKey) inEntitySelector "$(entityConditions)" OR dt.entity.container_group_instance inEntitySelector "type(CONTAINER_GROUP_INSTANCE),fromRelationships.isInstanceOf($(entityConditions))" OR dt.entity.process_group_instance inEntitySelector "type(PROCESS_GROUP_INSTANCE),fromRelationships.isPgiOfCgi(type(CONTAINER_GROUP_INSTANCE),fromRelationships.isInstanceOf($(entityConditions)))")

        showFiltering: true

        pageSize: 10
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>key</code>
|String
|Уникальный ключ карточки, используемый для указания желаемой конфигурации карточки.
|Необходимо
|-
|<code>displayName</code>
|String
|Название какарточкирты.
|Необязательно
|-
|<code>enablePaging</code>
|boolean
|Если установлено значение <code>true</code>, это включает постраничную навигацию результатов логов в таблице.
|Необязательно
|-
|<code>filterQuery</code>
|String
|Предварительно заданная фильтрация для таблицы логов. Синтаксис '''LQL''' можно использовать и в более сложных случаях, включающих селекторы сущностей с унифицированными заполнителями анализа в формате: <code>expression {attribute} inEntitySelector "{entitySelector}"</code> для отображения логов связанных сущностей. Например, <code>dt.entity.host inEntitySelector "type(PROCESS_GROUP_INSTANCE) AND fromRelationship.isProcessOf($(entityConditions))"</code>.
|Необязательно
|-
|<code>showFiltering</code>
|boolean
|Управляет видимостью панели фильтров.
|Необязательно
|-
|<code>pageSize</code>
|Integer
|Количество строк, отображаемых на одной странице.
|Необязательно
|-
|<code>description</code>
|String
|Описание карточки.
|Необязательно
|-
|<code>displayChart</code>
|boolean
|Показать или скрыть диаграмму на карточке.
|Необязательно
|}

== Карточки сообщения ==
В поле <code>messageCards</code> задается поведение карточки сообщения, например, параметры визуализации, тема оформления или текст.
{| class="wikitable"
|messageCards:

      - key: message-card

        type: CARD

        card:

          text: internal text

          theme: MAIN

          displayName: Message Card

      - key: message-card2

        type: MESSAGE

        message:

          text: internal text

          theme: INFO
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>key</code>
|String
|Уникальный ключ карточки, используемый для указания желаемой конфигурации карточки.
|Необходимо
|-
|<code>type</code>
|enum
|Определяет тип вашей карточки сообщения. Возможные значения: <code>CARD</code>, <code>MESSAGE</code>.
|Необходимо
|}

=== <code>CARD</code> ===
Отображает сообщение в формате карточки с заголовком, описанием и кнопками.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>text</code>
|String
|Определяет описание карточки.
|Необходимо
|-
|<code>theme</code>
|enum
|Определяет цветовую тему карточки. Возможные значения: <code>WARNING</code>, <code>MAIN</code>, <code>CTA</code>.
|Необходимо
|-
|<code>displayName</code>
|String
|Определяет заголовок карточки.
|Необязательно
|}

=== <code>MESSAGE</code> ===
Отображает сообщение в формате карточки, содержащее только описание.
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>text</code>
|String
|Определяет описание карточки.
|Необходимо
|-
|<code>theme</code>
|enum
|Определяет цветовую тему сообщения. Возможные значения: <code>INFO</code>, <code>WARNING</code>, <code>ERROR</code>.
|Необходимо
|}

== Карточки проблем ==
В поле <code>problemsCard</code> определяется поведение карточки с проблемой.
{| class="wikitable"
|problemsCard:

      entitySelectorTemplates:

        - NOT VALIDATED IN SCHEMA

        - NOT VALIDATED IN SCHEMA1

        - NOT VALIDATED IN SCHEMA2
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>entitySelectorTemplates</code>
|Array
|До 10 селекторов сущностей, используемых для получения данных о связанных сущностях.
|Необязательно
|}

== Действия ==
В поле <code>actions</code> определяются действия, доступные из меню.
{| class="wikitable"
|actions:

      - actionScope: GLOBAL_DETAILS

        actions:

          - actionExpression: actionName|key1=value1

      - actionScope: CHART_GROUP

        key: chart

        actionLocation: CHART

        actions:

          - actionExpression: actionName|key1=value1

      - actionScope: ENTITIES_LIST

        key: entitiesList

        actionLocation: TABLE_ENTRY

        actions:

          - actionExpression: actionName|key1=value1
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>actionScope</code>
|enum
|Заданное действие отображается в настройках выбранного типа карточки. Возможные значения: <code>GLOBAL_DETAILS</code>, <code>GLOBAL_LIST</code>, <code>PROPERTIES</code>, <code>PROBLEMS</code>, <code>CHART_GROUP</code>, <code>ENTITIES_LIST</code>, <code>EVENTS</code>, <code>LOGS</code>, <code>METRIC_TABLE</code>.
|Необходимо
|-
|<code>key</code>
|String
|Вы можете указать <code>key</code>, если хотите, чтобы действие было доступно только в одной конкретной карточке. Чтобы добавить это действие во все карточки этого типа, оставьте это поле пустым.
|Необходимо
|-
|<code>actionExpression</code>
|String
|Определяет выражение действия.
|Необходимо
|-
|<code>actionLocation</code>
|enum
|Определяет местоположение созданного вами действия. Возможные значения: <code>HEADER</code>, <code>CHART</code>, <code>TABLE_ENTRY</code>.
|Необязательно
|}

=== Список доступных действий ===
{| class="wikitable"
|<nowiki>ActionName|param1key=param1value|param2key=param2value</nowiki>
|}

==== Общие действия ====
{| class="wikitable"
!Действие
!Параметры
!Минимальная версия схемы
!Описание
|-
|<code>configuration</code>
|Нет
|221
|Создает ссылку на страницу конфигурации сущности. Например, на страницу настроек хоста.
|-
|<code>relatedEntityConfiguration</code>
|<code>entitySelectorTemplate</code>,<code>name</code>
|234
|Создает ссылку на страницу конфигурации сущности. Например, настройки '''PGI''' со страницы хоста.
|-
|<code>settings</code>
|<code>name</code>, <code>scopeClass</code><sup>1</sup> , <code>scopeIdentifier</code><sup>2</sup> , <code>schemaId</code><sup>3</sup>
|236
|Создает ссылку на указанный пользовательский интерфейс настройки темы '''Settings 2.0'''.
|-
|<code>hubCapability</code>
|<code>text</code><sup>4</sup> ,<code>hubCapability</code> <sup>5</sup>
|243
|Создает ссылку на указанную функцию Ключ-АСТРОМ Расширения.
|-
|<code>hubExtension</code>
|<code>text</code><sup>4</sup> ,<code>extensionId</code> <sup>6</sup>
|243
|Создает ссылку на указанное расширение в Ключ-АСТРОМ Расширения.
|-
|<code>relatedEntityScreen</code>
|<code>entitySelectorTemplate</code>,<code>name</code>
|253
|Создает ссылку на страницу унифицированного анализа связанных сущностей.
|-
|<code>platform.intent</code>
|<code>json</code><sup>7</sup> ,<code>label</code>,<code>appId</code>,<code>intentId</code>
|254
|Действие, запрашиваемое платформой.
|-
|<code>smartscape</code>
|Нет
|255
|Перенаправляет на '''smartscape'''.
|}
<sup>1</sup> Класс области действия настроек

<sup>2</sup> Идентификатор области действия настроек

<sup>3</sup> Идентификатор схемы настроек

<sup>4</sup> Отображаемое имя действия

<sup>5</sup> Часть URL-адреса, описывающая возможности хаба.

<sup>6</sup> Идентификатор расширения используется в качестве части URL.

<sup>7</sup> Полный JSON-Object действия

==== Основные действия ====
{| class="wikitable"
!Действие
!Параметры
!Действительно для данного условия
!Минимальная версия схемы
!Описание
|-
|<code>core.editConfig</code>
|Нет
|<code>UAScreenFeatureFlags.ENABLE_CONFIG_BUTTONS</code>
|218
|Перенаправляет на страницу настроек сущности и создает ссылки для всех ее подтипов.
|-
|<code>core.shareScreenUrl</code>
|Нет
|Область охвата всего экрана
|218
|Предоставляет ссылку для отправки отзывов.
|-
|<code>core.share.feedback</code>
|Нет
|Область охвата всего экрана
|218
|Открывает форму для обратной связи.
|-
|<code>core.dataExplorer</code>
|Нет
|Тип элемента диаграммы
|223
|Перенаправляет диаграммы в обозреватель данных.
|-
|<code>core.alerting</code>
|Нет
|разрешения <code>CONFIG_WRITE</code>, тип элемента диаграммы
|224
|Перенаправляет графики для установки оповещений по выбранному показателю.
|-
|<code>core.pinToDashboard</code>
|Нет
|Область действия экрана «Диаграмма или весь дашборд» с <code>UAScreenFeatureFlags.ENABLE_PIN_TO_DASHBOARD</code>
|224
|Прикрепляет диаграммы или целые сервисы к дашборду.
|-
|<code>core.problems</code>
|Нет
| -
|224
|Переходит в раздел «Проблемы» .
|-
|<code>core.screenType</code>
|Нет
|<code>UAScreenFeatureFlags.ENABLE_CONFIG_BUTTONS</code>
|224
|Создаёт несколько предопределённых действий для разных типов экранов.
|-
|<code>core.singleCard</code>
|Нет
|<code>UAScreenFeatureFlags.ENABLE_SINGLE_CARD_BUTTONS</code>
|232
|Отображает одну карточку.
|-
|<code>core.logs.createMetric</code>
|Нет
|Тип элемента карточки логов
|233
|Перенаправляет на страницу настроек логирования для создания метрики лога.
|-
|<code>core.opt.out</code>
|Нет
|Область охвата всего экрана
|235
|Переход к классическому виду страницы.
|-
|<code>core.useLocalConfig</code>
|Нет
|<code>UAScreenFeatureFlags.ENABLE_USE_LOCAL_CONFIG_BUTTON</code>
|236
|Активирует режим локальной конфигурации.
|-
|<code>core.sidebar</code>
|<code>screenTypeExpression</code><sup>1</sup>
|<code>UAScreenFeatureFlags.ENABLE_SIDE_BAR_BUTTONS</code>
|244
|Открывает боковую панель.
|-
|<code>core.problems.details</code>
|<code>pid</code><sup>2</sup>
|Экран с подробной информацией
|243
|Переходит к подробной информации о конкретной проблеме.
|-
|<code>core.logs.filtered</code>
|Нет
|Тип элемента карточки логов
|246
|Перенаправляет карточки логов в средство просмотра логов.
|-
|<code>core.slos.create</code>
|Нет
|разрешения <code>CONFIG_WRITE</code>, тип элемента '''Slo List'''
|255
|Перенаправляет диаграммы для создания целевого уровня обслуживания (SLO).
|}
<sup>1</sup> Выражение типа экрана, которое будет отображаться в боковой панели.

<sup>2</sup> Идентификатор проблемы

== Карточки с метрическими таблицами ==
Таблица метрик представляет собой графическое отображение данных метрик, относящихся к одному и тому же набору измерений.
{| class="wikitable"
|metricTableCards:

      - key: metricTable

        pageSize: 5

        displayCharts: true

        enableDetailsExpandability: true

        numberOfVisibleCharts: 2

        filtering: {}

        charts:

          - displayName: Chart

            conditions:

              - NOT VALIDATED IN SCHEMA

            visualizationType: GRAPH_CHART

            graphChartConfig:

              visualization:

                themeColor: DEFAULT

                seriesType: LINE

              metrics:

                - metricSelector: NOT VALIDATED IN SCHEMA

                - metricSelector: builtin:process.cpu:splitBy("process.pid","process.parent_pid","process.executable.name","process.executable.path","process.command_line","process.owner", "dt.entity.process_group_instance")

                  visualization:

                    themeColor: DEFAULT

                    seriesType: LINE

        conditions:

          - NOT VALIDATED IN SCHEMA
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>key</code>
|String
|Уникальный ключ карточки, используемый для указания желаемой конфигурации карточки.
|Необходимо
|-
|<code>pageSize</code>
|Integer
|Количество строк, отображаемых на одной странице.
|Необходимо
|-
|<code>displayCharts</code>
|boolean
|Если значение <code>true</code> равно нулю, то над таблицей отобразятся диаграммы с агрегированными данными.
|Необходимо
|-
|<code>enableDetailsExpandability</code>
|boolean
|Если задано значение <code>true</code>, строки можно развернуть диаграммами, связанными со значениями измерений в этой строке.
|Необходимо
|-
|<code>numberOfVisibleCharts</code>
|Integer
|Количество видимых диаграмм.
|Необходимо
|-
|<code>charts</code>
|Object
|Определите диаграммы для отображения данных временных рядов в таблице. Столбцы таблицы основаны на измерениях, полученных из результатов метрик этих диаграмм. Убедитесь, что метрики всех диаграмм имеют одинаковые измерения в результатах.
|Необязательно
|-
|<code>conditions</code>
|Array
|Условия отображения диаграммы.
|Необязательно
|-
|<code>filtering</code>
|Object
|Фильтрация внутри карточки таблицы метрик. Она затрагивает только эту таблицу и группу диаграмм. Фильтры метрических измерений автоматически отображаются, если есть какие-либо разделения измерений. Чтобы отображать только фильтры метрических измерений, определите поле как пустое (<code>detailsFilters: {}</code>).
|Необязательно
|}

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

Плитку '''Здоровье''' можно использовать в качестве кнопки навигации для указания элемента на странице, который предоставит более подробную информацию о соответствующем показателе.
{| class="wikitable"
|healthCards:

  - key: health_card

    tiles:

    - displayName: Uptime

      metricSelector: builtin:host.uptime

      displayMetricValue: 'true'

      foldTransformation: LAST_VALUE

    - displayName: CPU

      metricSelector: builtin:host.cpu.usage:avg

      displayMetricValue: 'true'

      foldTransformation: LAST_VALUE

      anchor:

        cardName: Host performance

        chartName: CPU usage

    - displayName: Available memory

      metricSelector: builtin:host.mem.avail.pct

      displayMetricValue: 'true'

      foldTransformation: LAST_VALUE

      anchor:

        cardName: Host performance

        chartName: Memory usage

    - displayName: Network

      metricSelector: (builtin:host.net.nic.trafficIn:merge("dt.entity.network_interface"):avg)+(builtin:host.net.nic.trafficOut:merge("dt.entity.network_interface"):avg)

      additionalMetricSelectors:

        collection:

        - builtin:host.net.nic.trafficIn:merge("dt.entity.network_interface")

        - builtin:host.net.nic.trafficOut:merge("dt.entity.network_interface")

      displayMetricValue: 'true'

      foldTransformation: LAST_VALUE

      anchor:

        cardName: Host performance

        chartName: Traffic
|}
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>key</code>
|String
|Уникальный ключ, используемый для сопоставления с данной карточкой здоровья в настройках расположения элементов на экране.
|Необходимо
|-
|<code>tiles</code>
|Array
|Набор определений элементов на карточке здоровья. Каждый элемент может отображать определенный показатель. Карточка здоровья может содержать до 6 элементов.
|Необязательно
|}

=== <code>tiles</code> ===
{| class="wikitable"
!Поле
!Тип
!Описание
!Необходимость
|-
|<code>displayName</code>
|String
|Название плитки карточки здоровья.
|Необходимо
|-
|<code>metricSelector</code>
|String
|Используется для сопоставления проблем и указания показателя, отображаемого на плитке.
|Необходимо
|-
|<code>additionalMetricSelectors</code>
|Array
|Используется для сопоставления проблем. Скрыто в пользовательском интерфейсе.
|Необязательно
|-
|<code>displayMetricValue</code>
|boolean
|Определяет, следует ли отображать значение метрики на плитке.
|Необязательно
|-
|<code>foldTransformation</code>
|enum
|Определяет метод преобразования, который сводит данные к одному значению. Возможные значения: <code>AUTO</code>, <code>LAST_VALUE</code>, <code>MAX</code>, <code>MIN</code>, <code>SUM</code>, <code>MEDIAN</code>, <code>VALUE</code>, <code>PERCENTILE_10</code>, <code>PERCENTILE_75</code>, <code>PERCENTILE_90</code>.
|Необходимо
|-
|<code>anchor</code>
|Object
|Определяет элемент, на который будет осуществлено перенаправление при выборе плитки. Это может быть название конкретной карточки или диаграммы.
|Необязательно
|}