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

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

Платформа предоставляет мощный функционал управления панелями мониторинга, предназначенный для замены традиционных инструментов 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 (встроенная) или 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 для bar chart, points для point chart
               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 # Тип отображения по значению
               - 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 chart; стиль отображения значения метрики; опции: auto, value, value_and_name, name, none (пока не поддерживается в конфигурации страницы, но поддерживается при импорте)
           colorMode: 'value' # Настройка stat chart; режим цвета для отображения значений; опции: 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