Расширение возможностей встроенных унифицированных страниц анализа

Материал из Документация Ключ-АСТРОМ

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

Определение внедрения карточки

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

detailsInjections:

      - type: CHART_GROUP

        key: my-host-feature-windows-only-chart

        conditions:

          - entityAttribute|osType=WINDOWS

      - type: CHART_GROUP

        key: my-host-feature-chart1

      - type: CHART_GROUP

        key: my-host-feature-chart2

      - type: CHART_GROUP

        key: my-host-feature-process-chart

        entitySelectorTemplate: type(PROCESS_GROUP_INSTANCE), fromRelationships.isProcessOf($(entityConditions))

        width: HALF_SIZE


Для карты, предоставленной вашим добавочным номером, доступны следующие варианты:

  • type - доступные типы карточек для отображения на единой странице анализа. Поддерживаются следующие типы : CHART_GROUP, ENTITIES_LIST, EVENTS, LOGS, и MESSAGE.
  • key - уникальный ключ карточки используется для ссылки на желаемую конфигурацию карточки. Используйте четко указанный префикс ключа, чтобы обеспечить правильное размещение связанных карточек на странице. Карточки сортируются в алфавитном порядке по ключу.
  • entitySelectorTemplate - селектор сущности, используемый для ссылки на карточки другого отслеживаемого типа сущности. Для получения дополнительной информации см. Environment API v2 — Селектор сущности.
  • width - определяет ширину карточки относительно ширины страницы. Поддерживаемые значения: HALF_SIZE и FULL_SIZE.
  • conditions - список условий, которые должны быть выполнены для того, чтобы карточка стала видимой.

Введение справочной карты

В качестве заключительного шага необходимо добавить ссылку на карточку, которая будет внедрена на встроенную страницу унифицированного анализа, с помощью пакета Расширения 2.0 и поместить её в свой файл extension.yaml в соответствующем разделе screens. В этом примере мы расширяем встроенную страницу обзора хоста (entityType: HOST).

name: custom:com.ua.example.extension

version: 1.0.0

minastromkeyVersion: 1.233.0

author:

  name: StackEnterprise

# Here comes your usual extension YAML content: data source, declarative metrics, topology, etc.

screens:

  - entityType: HOST

    detailsInjections:

      - type: CHART_GROUP

        key: my-host-feature-windows-only-chart

        conditions:

          - entityAttribute|osType=WINDOWS

      - type: CHART_GROUP

        key: my-host-feature-chart1

      - type: CHART_GROUP

        key: my-host-feature-chart2

      - type: CHART_GROUP

        key: my-host-feature-process-chart

        entitySelectorTemplate: type(PROCESS_GROUP_INSTANCE), fromRelationships.isProcessOf($(entityConditions))

        width: HALF_SIZE

    chartsCards:

      - key: my-host-feature-windows-only-chart

        ...

      - key: my-host-feature-chart1

        ...

      - key: my-host-feature-chart2

        ...

  - entityType: PROCESS_GROUP_INSTANCE

    chartsCards:

      - key: my-host-feature-process-chart

        ...