Alauda Container Platform
Русский

Управление мониторинговыми панелями

Содержание

Обзор функции

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

Основные возможности

  • Поддержка настройки пользовательских панелей мониторинга как для бизнес-обзоров, так и для обзоров платформы.
  • Возможность просмотра публично общих панелей, настроенных в обзорах платформы, из бизнес-обзоров с изоляцией данных по namespace, к которому принадлежит бизнес.
  • Поддержка управления панелями внутри панели мониторинга: добавление, удаление, изменение панелей, масштабирование панелей и перемещение панелей с помощью drag-and-drop.
  • Возможность установки пользовательских переменных внутри панели для фильтрации данных запросов.
  • Поддержка настройки групп внутри панели для управления панелями. Группы могут отображаться повторно на основе пользовательских переменных.
  • Поддерживаемые типы панелей: trend, step line chart, bar chart, horizontal bar chart, bar gauge chart, gauge chart, table, stat chart, XY chart, pie chart, text.
  • Функция импорта панелей Grafana одним кликом.

Преимущества

  • Поддержка пользовательских сценариев мониторинга без ограничений предопределёнными шаблонами, что позволяет достичь действительно персонализированного мониторинга.
  • Предоставляет богатый набор вариантов визуализации, включая линейные графики, столбчатые диаграммы, круговые диаграммы, а также гибкие варианты компоновки и стилизации.
  • Бесшовная интеграция с ролевыми разрешениями платформы, позволяющая бизнес-обзорам определять собственные панели мониторинга с обеспечением изоляции данных.
  • Глубокая интеграция с различными функциями контейнерной платформы, обеспечивающая мгновенный доступ к данным мониторинга контейнеров, сетей, хранилищ и т.д., предоставляя пользователям всестороннее наблюдение за производительностью и диагностику неисправностей.
  • Полная совместимость с JSON панелей Grafana, что облегчает миграцию с Grafana для продолжения использования.

Сценарии использования

  • Управление IT-операциями: В составе команды IT-операций вы можете использовать панели мониторинга для унификации отображения и управления различными метриками производительности контейнерной платформы, такими как CPU, память, сетевой трафик и др. Настраивая отчёты мониторинга и правила оповещений, вы сможете своевременно выявлять и локализовать проблемы системы, повышая эффективность эксплуатации.
  • Анализ производительности приложений: Для разработчиков и тестировщиков приложений панели мониторинга предлагают разнообразные варианты визуализации для наглядного отображения состояния работы приложений и потребления ресурсов. Вы можете настраивать специализированные виды мониторинга под разные сценарии приложений для глубокого анализа узких мест производительности и предоставления основы для оптимизации.
  • Управление мультикластером: Для пользователей, управляющих несколькими контейнерными кластерами, панели мониторинга могут агрегировать данные мониторинга из разных кластеров, позволяя получить общее представление о состоянии системы.
  • Диагностика неисправностей: При возникновении проблем в системе панели мониторинга предоставляют комплексные данные о производительности и аналитические инструменты для быстрого выявления корневой причины. Вы можете оперативно просматривать колебания соответствующих метрик на основе информации оповещений для углублённого анализа неисправностей.

Предварительные требования

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

  • Убедитесь, что в кластере, для которого вы хотите настроить панель мониторинга, установлены компоненты мониторинга, а именно плагин ACP Monitor с Prometheus или ACP Monitor с VictoriaMetrics.
  • Убедитесь, что данные, которые вы хотите отображать на панели, были собраны компонентами мониторинга.

Взаимосвязь между панелями мониторинга и компонентами мониторинга

  • Ресурсы панелей мониторинга хранятся в Kubernetes-кластере. Вы можете переключать обзоры между разными кластерами с помощью вкладки Cluster в верхней части.
  • Панели мониторинга зависят от компонентов мониторинга в кластере для запроса источников данных. Поэтому перед использованием панелей мониторинга убедитесь, что в текущем кластере успешно установлены компоненты мониторинга и они работают нормально.
  • Панель мониторинга по умолчанию будет запрашивать данные мониторинга из соответствующего кластера. Если вы установите плагин VictoriaMetrics в режиме proxy в кластере, мы автоматически запросим кластер хранения для получения соответствующих данных без необходимости специальной настройки.

Управление панелями

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

Создание панели

  1. Нажмите Create Dashboard, ориентируйтесь на следующие инструкции для настройки соответствующих параметров.
ПараметрОписание
FolderПапка, в которой располагается панель; можно ввести или выбрать существующую папку.
LabelМетка панели мониторинга; вы можете быстро находить существующие панели, фильтруя по верхним меткам при переключении.
Set as Main DashboardЕсли включено, текущая панель будет установлена как основная после успешного создания; при повторном входе в функцию мониторинга по умолчанию будет отображаться основная панель.
VariablesДобавьте переменные при создании панели для использования в качестве параметров метрик в добавленных панелях, которые также могут использоваться как фильтры на главной странице панели.
  1. После добавления нажмите Create для завершения создания панели. Далее необходимо добавить переменные, добавить панели и добавить группы для завершения общего дизайна компоновки.

Импорт панели

Платформа поддерживает прямой импорт JSON из Grafana для преобразования его в панель мониторинга для отображения.

  • В настоящее время поддерживается только Grafana JSON версии V8+; более низкие версии запрещены к импорту.
  • Если в импортируемой панели есть типы, не поддерживаемые платформой, они могут отображаться как unsupported panel types, но вы можете изменить настройки панели для нормального отображения.
  • После импорта панели вы можете выполнять любые действия по управлению, как обычно, без отличий от панелей, созданных в платформе.

Добавление переменных

  1. В области формы переменных нажмите Add.

Query

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

ПараметрОписание
Query SettingsПри определении настроек запроса, помимо использования PromQL для запроса временных рядов, платформа также предоставляет некоторые общие переменные и функции. Смотрите Common Functions and Variables.
Regular ExpressionС помощью регулярных выражений можно отфильтровать нужные значения из содержимого, возвращаемого запросами переменных. Это делает каждое имя опции в переменной более ожидаемым. Вы можете предварительно просмотреть, соответствуют ли отфильтрованные значения ожиданиям в Variable Value Preview.
Selection Settings- Multiple Selection: При выборе из верхних фильтров на главной странице панели позволяет выбрать несколько опций одновременно. Необходимо ссылаться на эту переменную в выражении запроса панелей для просмотра данных, соответствующих значению переменной.
- All: Если отмечено, в фильтрах появится опция All для выбора всех данных переменной.

Constant

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

ПараметрОписание
Constant ValueЗначение постоянной переменной.

Custom

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

ПараметрОписание
Custom SettingsВведите значения опций через запятую, используя формат display_name : value для каждой опции (например, Production : prod, Staging : stage, Development : dev), либо просто перечислите значения, если имя отображения совпадает со значением.

Textbox

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

ПараметрОписание
Textbox ValueЗначение по умолчанию для текстового поля.
  1. Нажмите OK для добавления одной или нескольких переменных.

Добавление панелей

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

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

  1. Нажмите Add Panel, ориентируйтесь на следующие инструкции для настройки параметров.

  • Panel Preview: Область динамически отображает данные, соответствующие добавленным метрикам.

  • Add Metric: Настройте заголовок панели и метрики мониторинга в этой области.

  • Способ добавления: Поддерживается использование встроенных метрик или нативных пользовательских метрик. Оба метода объединяются и действуют одновременно.

    • Built-in Metrics: Выберите часто используемые метрики и параметры легенды, встроенные в платформу, для отображения данных в текущей панели.
      • Примечание: Все метрики, добавленные в панель, должны иметь единый единичный формат; нельзя добавлять метрики с разными единицами в одну панель.
    • Native: Настройте единицу метрики, выражение метрики и параметры легенды. Выражение метрики следует синтаксису PromQL; подробности смотрите в PromQL Official Documentation.

  • Legend Parameters: Управляет именами, соответствующими кривым на панелях. Можно использовать текст или шаблоны:

    • Правило: Введённое значение должно быть в формате {{.xxxx}}; например, {{.hostname}} заменится на значение метки hostname, возвращаемой выражением.
    • Совет: При вводе некорректного формата параметра легенды имена кривых будут отображаться в исходном виде.

  • Instant Switch: При включённом переключателе Instant будет выполняться запрос мгновенных значений через интерфейс Query Prometheus и сортировка, как в статистических и gauge диаграммах. Если выключен, используется метод query_range для вычисления серии данных за определённый период.

  • Panel Settings: Поддерживается выбор различных типов панелей для визуализации метрик. Смотрите Manage Panels.

  1. Нажмите Save для завершения добавления панелей.

  2. Можно добавить одну или несколько панелей в рамках панели мониторинга.

  3. После добавления панелей доступны следующие операции для настройки отображения и размера:

    • Кликните по правому нижнему углу панели для настройки размера.
    • Кликните по любой области панели для изменения порядка панелей.
    • Нажмите кнопку Edit для изменения настроек панели.
    • Нажмите кнопку Delete для удаления панели.
    • Нажмите кнопку Copy для копирования панели.

  4. После внесения изменений нажмите кнопку Save на странице панели для сохранения.

Добавление групп

Группы — это логические разделители внутри панели, которые могут группировать панели вместе.

  1. Нажмите выпадающее меню Add Panel > Add Group и настройте параметры согласно инструкции.
  • Group: Название группы.
  • Repeat: Поддерживается отключение повторов или выбор переменных для текущих панелей.
    • Disable Repeat: Не выбирать переменную, использовать созданную по умолчанию группу.
    • Parameter Variables: Выберите переменные, созданные в текущих панелях; панель мониторинга сгенерирует строку идентичных подгрупп для каждого соответствующего значения переменной. Подгруппы не поддерживают изменение, удаление или перемещение панелей.
  1. После добавления группы доступны следующие операции для управления отображением панелей внутри панели:
    • Группы можно сворачивать или разворачивать для скрытия части содержимого. Панели внутри свернутых групп не отправляют запросы.
    • Перемещайте панели в группу, чтобы они управлялись этой группой. Группа управляет всеми панелями между ней и следующей группой.
    • При сворачивании группы можно перемещать все панели, управляемые этой группой, вместе.
    • Сворачивание и разворачивание групп также считается изменением панели. Чтобы сохранить это состояние при следующем открытии, нажмите Save.

Переключение панелей

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

  1. В левом навигационном меню выберите Operations Center > Monitoring > Monitoring Dashboards.

  2. По умолчанию открывается основная панель мониторинга. Нажмите Switch Dashboard.

  3. Можно найти панели, фильтруя по меткам или поиском по имени, и переключать основные панели с помощью переключателя Main Dashboard.

Другие операции

Вы можете нажать кнопку операций справа на странице панели для выполнения нужных действий.

ОперацияОписание
YMALОткрывает фактический код ресурса CR панели, хранящийся в Kubernetes-кластере. Вы можете изменить всё содержимое панели, редактируя параметры в YAML.
Export ExpressionЭкспортирует метрики и соответствующие выражения запросов, используемые в текущей панели, в формате CSV.
CopyКопирует текущую панель; вы можете редактировать панели по необходимости и сохранить как новую панель.
SettingsИзменяет основную информацию текущей панели, например, смену меток и добавление переменных.
DeleteУдаляет текущую панель мониторинга.

Управление панелями

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

Описание панелей

№Название панелиОписаниеРекомендуемые сценарии использования
1Trend ChartОтображает тенденцию данных во времени с помощью одной или нескольких линий.Показывает тренды во времени, например, изменения использования CPU, памяти и т.д.
2Step Line ChartРасширение линейного графика с соединением точек горизонтальными и вертикальными сегментами, образующими ступенчатую структуру.Подходит для отображения временных меток дискретных событий, например, количества оповещений.
3Bar ChartИспользует вертикальные прямоугольные столбцы для представления величины данных, высота столбцов соответствует значению.Столбчатые диаграммы интуитивны для сравнения значений, полезны для выявления закономерностей и аномалий, подходят для сценариев с акцентом на изменение значений, например, количество подов, количество узлов и т.д.
4Horizontal Bar ChartАналогично столбчатой диаграмме, но использует горизонтальные столбцы.При большом количестве размерностей данных горизонтальные столбчатые диаграммы лучше используют пространство и повышают читаемость.
5Gauge ChartИспользует полукруглые или кольцевые формы для отображения текущего значения индикатора и его доли от общего.Интуитивно отражает текущее состояние ключевых индикаторов мониторинга, например, загрузку CPU и использование памяти системы. Рекомендуется использовать пороги с изменением цвета для индикации аномалий.
6Gauge Bar ChartИспользует вертикальные прямоугольные столбцы для отображения текущих значений индикаторов и их доли.Интуитивно отражает текущее состояние ключевых индикаторов, например, прогресс выполнения задачи и нагрузку системы. При наличии нескольких категорий одного индикатора рекомендуется использовать именно этот тип, например, доступное дисковое пространство.
7Pie ChartИспользует сектора для отображения пропорционального соотношения частей и целого.Подходит для демонстрации состава данных по разным размерностям, например, доли ответов 4XX, 3XX, 2XX за период.
8TableОрганизует данные в виде строк и столбцов, облегчая просмотр и сравнение конкретных значений.Подходит для отображения структурированных многомерных данных, например, подробной информации об узлах, подах и т.д.
9Stat ChartОтображает текущее значение одного ключевого индикатора, обычно с текстовым пояснением.Подходит для отображения в реальном времени важных индикаторов мониторинга, например, количества подов, узлов, текущего числа оповещений и т.д.
10Scatter PlotИспользует декартовы координаты для отображения серии точек данных, отражая корреляцию между двумя переменными.Подходит для анализа взаимосвязей между двумя индикаторами, выявления закономерностей, таких как линейная корреляция и кластеризация, через распределение точек, помогая обнаружить связи между метриками.
11Text CardОтображает ключевую текстовую информацию в формате карточки, обычно содержит заголовок и краткое описание.Подходит для представления текстовой информации, например, описаний панелей и пояснений по устранению неполадок.

Описание параметров панели

Общие параметры

ПараметрОписание
Basic InformationВыберите подходящий тип панели в зависимости от выбранных метрик, добавьте заголовки и описания; можно добавить одну или несколько ссылок для быстрого доступа, выбирая имя ссылки рядом с заголовком.
Standard SettingsЕдиницы измерения для нативных метрик. Кроме того, gauge и bar gauge поддерживают настройку поля Total Value, которое отображается как процент от Current Value/Total Value на диаграмме.
TooltipsВсплывающие подсказки для отображения данных в реальном времени при наведении на панели, поддерживают выбранную сортировку.
Threshold ParametersНастройка порогов для панелей; при включении пороги отображаются выбранными цветами, позволяя визуально оценивать значения относительно порогов.
ValueМетод вычисления значения, например, последнее или минимальное значение. Применимо только к stat и gauge диаграммам.
Value MappingПереопределение заданных значений, диапазонов, регулярных выражений или специальных значений, например, определение 100 как полной загрузки. Применимо к stat, table и gauge диаграммам.

Специальные параметры для панелей

Тип панелиПараметрОписание
Trend ChartGraph StyleМожно выбрать между линейным графиком и графиком с заливкой (area); линейные графики больше отражают тенденции изменений индикаторов, а area-графики акцентируют внимание на изменениях общей и частичной пропорции. Выбирайте в зависимости от потребностей.
Gauge ChartGauge Chart Settings
Show Direction: При необходимости просмотра нескольких метрик на одном графике можно задать горизонтальное или вертикальное расположение.
Unit Redefinition: Можно задать отдельные единицы измерения для каждой метрики; если не задано, используется единица из Standard Settings.
Stat ChartStat Chart Settings
Show Direction: При необходимости просмотра нескольких метрик на одном графике можно задать горизонтальное или вертикальное расположение.
Graph Mode: Можно добавить график в stat chart для отображения тренда метрики во времени.
Pie ChartPie Chart Settings
Maximum Number of Slices: Позволяет уменьшить количество секторов в круговой диаграмме, чтобы снизить влияние категорий с низкой долей, но большим количеством. Избыточные секторы объединяются в Others.
Label Display Fields: Настройка полей, отображаемых в метках круговой диаграммы.
Pie ChartGraph StyleМожно выбрать стиль отображения: pie или donut.
TableTable Settings
Hide Columns: Позволяет уменьшить количество столбцов для фокусировки на основных.
Column Alignment: Настройка выравнивания данных в столбце.
Display Name and Unit: Изменение названий столбцов и единиц измерения.
Text CardGraph Style
Style: Можно выбрать редактирование содержимого текстовой карточки в формате rich-text или HTML.

Создание панелей мониторинга через CLI

  1. Создайте новый YAML-файл конфигурации с именем example-dashboard.yaml.

  2. Добавьте ресурс MonitorDashboard в YAML-файл и отправьте его. Пример создания панели мониторинга с именем demo-v2-dashboard1:

    kind: MonitorDashboard
apiVersion: ait.alauda.io/v1alpha2
metadata:
  annotations:
    cpaas.io/dashboard.version: '3'
    cpaas.io/description: '{"zh":"描述信息","en":""}' # Поле описания
    cpaas.io/operator: admin
  labels:
    cpaas.io/dashboard.folder: demo-v2-folder1 # Папка
    cpaas.io/dashboard.is.home.dashboard: 'False' # Является ли основной панелью?
  name: demo-v2-dashboard1 # Имя
  namespace: cpaas-system # Namespace (все создания в области управления происходят в этом ns)
spec:
  body: # Все информационные поля
    titleZh: 更新显示名称 # Встроенное поле для отображения названия на китайском (создаётся под китайский язык)
    title: english_display_name # Встроенное поле для отображения названия на английском (создаётся под английский язык) Встроенные панели могут иметь двуязычный перевод.
    templating: # Пользовательские переменные
      list:
        - hide: 0 # 0 — не скрывать; 1 — скрывать только метку; 2 — скрывать метку и значение
          label: 集群 # Отображаемое имя встроенной переменной (метка задаётся в зависимости от языка, например, cluster на английском)
          name: cluster # Имя встроенной переменной (уникальное)
          options: # Определение опций выпадающего списка; если запрос возвращает данные, используется он, иначе — options. Можно задать значение по умолчанию (обычно для установки дефолта)
            - selected: false # Выбрана ли по умолчанию
              text: global
              value: global
          type: custom # Тип переменной: custom (встроенная) или query (запрос). Импорт Grafana поддерживает constant, custom, interval (после импорта будет преобразовано в custom, auto не поддерживается)

        - allValue: '' # Выбрать все, передаётся в формате xxx|xxx|xxx; можно задать allValue для преобразования (Grafana возвращает все данные текущей переменной в формате xxx|xxx|xxx, корректировка для согласованности)
          current: null # Текущее значение переменной; если не задано, по умолчанию первое в списке
          definition: query_result(kube_namespace_labels) # Выражение запроса для получения данных
          hide: 0 # 0 — не скрывать; 1 — скрывать только метку; 2 — скрывать метку и значение
          includeAll: true # Включать опцию "все"
          label: ns # Отображаемое имя переменной
          multi: true # Разрешить множественный выбор
          name: ns # Имя переменной (уникальное)
          options: []
          query: ''
          regex: /.*namespace=\"(.*?)\".*/ # Регулярное выражение для извлечения значений переменной
          sort: 2 # Сортировка: 1 — по алфавиту по возрастанию; 2 — по алфавиту по убыванию (поддерживаются только эти два); 3 — по числу по возрастанию; 4 — по числу по убыванию
          type: query # Тип переменной
    time: # Временной диапазон панели
      from: now-30m # Начало
      to: now # Конец
    repeat: '' # Конфигурация повторения строк; выбирается пользовательская переменная
    collapsed: 'false' # Конфигурация свернутости строк
    description: '123' # Описание (всплывающая подсказка после заголовка)
    targets: # Источники данных
      - indicator: cluster.node.ready # Метрика
        expr: sum (cpaas_pod_number{cluster=\"\"}>0) # Выражение PromQL
        instant: false # Режим запроса: true — мгновенное значение
        legendFormat: '' # Легенда
        range: true # По умолчанию запрашивать диапазон
        refId: 指标1 # Уникальный идентификатор для отображения имени источника данных
    gridPos: # Позиция и размер на панели
      h: 8 # Высота
      w: 12 # Ширина (из 24 сеточных единиц)
      x: 0 # Горизонтальная позиция
      y: 0 # Вертикальная позиция
    panels: # Данные панелей
      title: 图表标题tab # Название панели
      type: table # Тип панели; поддерживаются timeseries, barchart, stat, gauge, table, bargauge, row, text, pie (step chart, scatter plot, bar chart настраиваются через drawStyle)
      id: a2239830-492f-4d27-98f3-cb7ecb77c56f # Уникальный идентификатор
      links: # Ссылки
        - targetBlank: true # Открывать в новой вкладке
          title: '1' # Имя
          url: '1' # URL
      transformations: # Трансформации данных
        - id: 'organize' # Тип organize; используется для сортировки, перестановки, отображения полей
          options:
            excludeByName: # Скрытые поля
              cluster_cpu_utilization: true
            indexByName: # Сортировка
              cluster_cpu_utilization: 0,
              Time: 1
            renameByName: # Переименование
              Time: ''
              cluster_cpu_utilization: '222'
        - id: 'merge' # Слияние данных
          options:
      fieldConfig: # Настройка свойств и внешнего вида панели
        defaults: # Настройки по умолчанию
          custom: # Пользовательские графические атрибуты
            align: 'left' # Выравнивание таблицы: left, center, right
            cellOptions: # Настройка порогов таблицы
              type: color-text # Поддерживается только текст для цветовой настройки порогов
            spanNulls: false # true — соединять null значения; false — не соединять; число == 0 — соединять null как 0
            drawStyle: line # Типы панелей: line, bars для столбчатых, points для точечных
            fillOpacity: 20 # Присутствует при drawStyle area (пока не поддерживается настройка, по умолчанию 20)
            thresholdsStyle: # Настройка отображения порогов (пока поддерживается только линия)
              mode: line # Формат отображения порогов (area пока не поддерживается)
            lineInterpolation: 'stepBefore' # Настройка step chart; по умолчанию поддерживается только stepBefore (stepAfter будет добавлен позже)
          decimals: 3 # Количество знаков после запятой
          min: 0 # Минимальное значение (пока не поддерживается в конфигурации страницы, поддерживается в адаптированных импортах)
          max: 1 # Максимальное значение (конфигурация страницы применяется только к stat, gauge, barGauge, pie)
          unit: '%' # Единица измерения
          mappings: # Настройка отображения значений (поддерживаются value и range; специальные типы на данных)
            - options: # Правила отображения значений
                '1': # Значение
                  index: 0
                  text: 'Running' # Отображается как Running при значении 1
              type: value # Тип отображения value
            - options: # Правила отображения диапазонов
                from: 2 # Начало диапазона
                to: 3 # Конец диапазона
                result: # Результат отображения
                  index: 1
                  text: 'Error' # Значения от 2 до 3 отображаются как Error
              type: range # Тип отображения range
            - type: special # Специальный тип отображения
              options:
                match: null # nan null null+nan empty true false
                result:
                  text: xxx
                  index: 2
          thresholds: # Настройка порогов
            mode: absolute # Режим порогов, абсолютные значения (пока поддерживаются только абсолютные и процентные; процентные пока не поддерживаются)
            steps: # Шаги порогов
              - color: '#a7772f' # Цвет порога
                value: '2' # Значение порога
              - color: '#007AF5' # Цвет по умолчанию, базовый
        overrides: # Переопределения
          - matcher:
              id: byName # Совпадение по имени поля
              options: node # Имя поля
            properties: # Переопределяемые свойства; id поддерживает displayName, unit
              - id: displayName # Переопределение имени отображения
                value: '1' # Новое имя
              - id: unit # Переопределение единицы
                value: GB/s # Новая единица
              - id: noValue # Отображение при отсутствии значения
                value: No value display
      options:
        orientation: horizontal # Направление компоновки панелей; применяется к gauge и barGauge (stat будет поддерживаться позже)
        legend: # Настройки легенды
          calcs: # Методы вычисления (отображаются при положении легенды справа)
            - latest # Поддерживается только последнее значение
          placement: right # Положение легенды (right или bottom; по умолчанию bottom)
          placementRightTop: '' # Настройка верхнего правого угла
          showLegend: true # Отображать легенду
        tooltip: # Всплывающие подсказки
          mode: multi # Режим мультивыбора (поддерживается только multi) Отображает все данные при наведении мыши
          sort: asc # Сортировка: asc или desc
        reduceOptions: # Метод вычисления значения (для агрегирования данных)
          calcs: # Методы вычисления (latest, minimum, maximum, average, sum)
            - latest
          limit: 3 # Ограничение количества секторов в pie
        textMode: 'value' # Настройка stat; определяет стиль отображения значения метрики; варианты: auto, value, value_and_name, name, none (пока не поддерживается в конфигурации страницы, но поддерживается в импорте)
        colorMode: 'value' # Настройка stat; определяет цветовой режим отображения значений; варианты: none, value, background (по умолчанию value; не поддерживается в конфигурации, но адаптировано в импорте)
        displayLabels: ['name', 'value', 'percent'] # Поля, отображаемые в метках pie
        pieType: 'pie' # Тип pie диаграммы; варианты pie и donut
        mode: 'html' # Режим текстовой диаграммы; варианты html и richText
        content: '<div>xxx</div>' # Содержимое текстовой диаграммы
        footer:
          enablePagination: true # Включение пагинации в таблице

Общие функции и переменные

Общие функции

При определении настроек запросов, помимо использования PromQL, платформа предоставляет следующие общие функции для удобства настройки:

ФункцияНазначение
label_names()Возвращает все метки в Prometheus, например, label_names().
label_values(label)Возвращает все доступные значения для имени метки во всех метриках Prometheus, например, label_values(job).
label_values(metric, label)Возвращает все доступные значения для имени метки в указанной метрике, например, label_values(up, job).
metrics(metric)Возвращает все имена метрик, удовлетворяющих заданному регулярному выражению, например, metrics(cpaas_active).
query_result(query)Возвращает результат запроса для указанного запроса Prometheus, например, query_result(up).

Общие переменные

При определении настроек запросов можно комбинировать общие функции в переменные для быстрого определения пользовательских переменных. Ниже приведены распространённые определения переменных для справки:

Имя переменнойФункция запросаРегулярное выражение
clusterlabel_values(cpaas_cluster_info,cluster)-
nodelabel_values(node_load1, instance)/(.*?):.*/
namespacequery_result(kube_namespace_labels)/.*namespace=\"(.*?)\".*/
deploymentlabel_values(kube_deployment_spec_replicas{namespace="$namespace"}, deployment)-
daemonsetlabel_values(kube_daemonset_status_number_ready{namespace="$namespace"}, daemonset)-
statefulsetlabel_values(kube_statefulset_replicas{namespace="$namespace"}, statefulset)-
podlabel_values(kube_pod_info{namespace=~"$namespace"}, pod)-
vmclusterlabel_values(up, vmcluster)-
daemonsetlabel_values(kube_daemonset_status_number_ready{namespace="$namespace"}, daemonset)-

Пример использования переменной 1

Использование функции query_result(query) для запроса значения: node_load5 и извлечения IP.

  1. В Query Settings заполните query_result(node_load5).

  2. В области Variable Value Preview пример предварительного просмотра: node_load5{container="node-exporter",endpoint="metrics",host_ip="192.168.178.182",instance="192.168.178.182:9100"}.

  3. В Regular Expression заполните /.*instance="(.*?):.*/ для фильтрации значения.

  4. В области Variable Value Preview пример предварительного просмотра: 192.168.176.163.

Пример использования переменной 2

  1. Добавьте первую переменную: namespace, используя функцию query_result(query) для запроса значения: kube_namespace_labels и извлечения namespace.

    • Query Settings: query_result(kube_namespace_labels).

    • Variable Value Preview: kube_namespace_labels{container="exporter-kube-state", endpoint="kube-state-metrics", instance="12.3.188.121:8080", job="kube-state", label_cpaas_io_project="cpaas-system", namespace="cert-manager", pod="kube-prometheus-exporter-kube-state-55bb6bc67f-lpgtx", project="cpaas-system", service="kube-prometheus-exporter-kube-state"}.

    • Regular Expression: /.+namespace=\"(.*?)\".*/.

    • В области Variable Value Preview пример предварительного просмотра включает несколько namespace, таких как argocd, cpaas-system и другие.

  2. Добавьте вторую переменную: deployment, ссылаясь на ранее созданную переменную:

    • Query Settings: kube_deployment_spec_replicas{namespace=~"$namespace"}.

    • Regular Expression: /.+deployment="(.*?)",.*/.

  3. Добавьте панель в текущую панель и ссылайтесь на ранее добавленные переменные, например:

    • Имя метрики: pod Memory Usage under Compute Components.

    • Пара ключ-значение: kind: Deployment, name: $deployment, namespace: $namespace.

  4. После добавления панелей и их сохранения вы сможете просматривать соответствующую информацию на главной странице панели.

Примечания при использовании встроенных метрик

WARNING

Следующие метрики используют пользовательские переменные namespace, name и kind, которые не поддерживают множественный выбор и выбор всех.

  • namespace поддерживает выбор только одного конкретного namespace;
  • name поддерживает только три типа вычислительных компонентов: deployment, daemonset, statefulset;
  • kind поддерживает указание только одного из типов: Deployment, DaemonSet, StatefulSet.

  • workload.cpu.utilization

  • workload.memory.utilization

  • workload.network.receive.bytes.rate

  • workload.network.transmit.bytes.rate

  • workload.gpu.utilization

  • workload.gpu.memory.utilization

  • workload.vgpu.utilization

  • workload.vgpu.memory.utilization

Просмотреть полную документацию в формате PDF