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

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

Платформа предоставляет мощный функционал управления панелями мониторинга, предназначенный для замены традиционных инструментов 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, руководствуясь следующими инструкциями для настройки соответствующих параметров.

2. После добавления нажмите Create для завершения создания панели. Далее необходимо добавить переменные, добавить панели и добавить группы для завершения общей компоновки.

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

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

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

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

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

Query

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

Constant

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

Custom

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

Textbox

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

2. Нажмите 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.

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

3. Вы можете добавить одну или несколько панелей в дашборд.

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

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

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

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

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

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

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

2. После добавления группы вы можете выполнять следующие операции для управления отображением панелей в дашборде:
   • Группы можно сворачивать или разворачивать для скрытия части содержимого дашборда. Панели в свернутых группах не отправляют запросы.
   • Перемещайте панели в группу, чтобы они управлялись этой группой. Группа управляет всеми панелями между ней и следующей группой.
   • При сворачивании группы можно перемещать все панели, управляемые этой группой, вместе.
   • Сворачивание и разворачивание групп также считается изменением дашборда. Чтобы сохранить это состояние при следующем открытии, нажмите Save.

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

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

1. В левой навигационной панели нажмите Operations Center > Monitoring > Monitoring Dashboards.

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

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

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

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

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

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

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

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

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

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

#Создание панелей мониторинга через 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; в настоящее время поддерживаются только встроенные (custom) и query (импорт Grafana поддерживает constant custom interval (после импорта меняется на custom и не поддерживает авто))
           - 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 для bar chart, points для point chart
               fillOpacity: 20 # Существует при drawStyle area (в настоящее время не поддерживается настройка, 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 # Тип отображения по значению
               - options: # Правила отображения по диапазону
                   from: 2 # Начало диапазона
                   to: 3 # Конец диапазона
                   result: # Результат отображения
                     index: 1
                     text: 'Error' # Значения от 2 до 3 отображаются как Error
                 type: 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 chart
           textMode: 'value' # Конфигурация stat; определяет стиль отображения значения метрики; опции: auto, value, value_and_name, name, none (в настройках страницы не поддерживается, но поддерживается при импорте)
           colorMode: 'value' # Конфигурация stat; определяет режим цвета для отображения значений метрик; опции: none, value, background (по умолчанию value; в настройках не поддерживается, но адаптируется при импорте)
           displayLabels: ['name', 'value', 'percent'] # Поля, отображаемые в подписях pie chart
           pieType: 'pie' # Тип pie chart; опции: pie и donut
           mode: 'html' # Режим text chart; опции: html и richText
           content: '<div>xxx</div>' # Содержимое text chart
           footer:
             enablePagination: true # Включение пагинации в таблице

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

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

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

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

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

#Пример использования переменной №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. После добавления панелей и сохранения вы сможете просматривать соответствующую информацию на главной странице панели.

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

• 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