Структура документа Ключ-АСТРОМ — Дашборды: различия между версиями

Материал из Документация Ключ-АСТРОМ
Новая страница: « = Структура документа Ключ-АСТРОМ — Дашборды = Дашборд Ключ-АСТРОМ хранится как документ '''JSON'''. Понимание структуры помогает создавать и изменять дашборды через '''API''' или путём прямого редактирования '''JSON''' в '''Дашбордах'''. == Обзор == Документ дашборда...»
 
Нет описания правки
 
Строка 1: Строка 1:
= Структура документа Ключ-АСТРОМ — Дашборды =


= Структура документа Ключ-АСТРОМ — Дашборды =
Дашборд Ключ-АСТРОМ хранится как документ '''JSON'''. Понимание структуры помогает создавать и изменять дашборды через '''API''' или путём прямого редактирования '''JSON''' в '''Дашбордах'''.
Дашборд Ключ-АСТРОМ хранится как документ '''JSON'''. Понимание структуры помогает создавать и изменять дашборды через '''API''' или путём прямого редактирования '''JSON''' в '''Дашбордах'''.


Строка 13: Строка 13:
   "layouts": {}
   "layouts": {}
}</pre>
}</pre>
{| class="wikitable"
{| class="wikitable"
!Свойство
! Свойство !! Тип !! Описание
!Тип
!Описание
|-
|-
|<code>version</code>
| <code>version</code> || number || Версия схемы. Используйте <code>21</code> для новых дашбордов.
|number
|Версия схемы. Используйте <code>21</code> для новых дашбордов.
|-
|-
|<code>variables</code>
| <code>variables</code> || array || Определения переменных. См. '''Переменные'''.
|array
|Определения переменных. См. '''Переменные'''.
|-
|-
|<code>tiles</code>
| <code>tiles</code> || object || Сопоставление ID плитки с определением плитки. См. '''Плитки'''.
|object
|Сопоставление ID плитки с определением плитки. См. '''Плитки'''.
|-
|-
|<code>layouts</code>
| <code>layouts</code> || object || Сопоставление ID плитки с позицией в макете. См. '''Макет'''.
|object
|Сопоставление ID плитки с позицией в макете. См. '''Макет'''.
|}
|}
Необязательные свойства: <code>settings</code>, <code>annotations</code>.
Необязательные свойства: <code>settings</code>, <code>annotations</code>.


Строка 42: Строка 34:


=== Плитка Markdown ===
=== Плитка Markdown ===
Плитка Markdown отображает статическое текстовое содержимое, отформатированное с помощью Markdown.<pre>{
Плитка Markdown отображает статическое текстовое содержимое, отформатированное с помощью Markdown.
 
<pre>{
   "type": "markdown",
   "type": "markdown",
   "content": "# Section Header\n\nSome text here."
   "content": "# Section Header\n\nSome text here."
Строка 48: Строка 42:


=== Плитка данных ===
=== Плитка данных ===
Плитка данных выполняет запрос '''DQL''' и отображает результаты в виде визуализации.<pre>{
Плитка данных отображает данные в виде визуализации.
 
<pre>{
   "type": "data",
   "type": "data",
   "title": "Tile Name",
   "title": "Tile Name",
  "query": "timeseries avg(dt.host.cpu.usage), by:{host.name}",
   "visualization": "lineChart",
   "visualization": "lineChart",
   "visualizationSettings": {},
   "visualizationSettings": {}
  "querySettings": {}
}</pre>
}</pre>
{| class="wikitable"
{| class="wikitable"
!Свойство
! Свойство !! Обязательно !! Описание
!Обязательно
!Описание
|-
|<code>title</code>
|Да
|Отображается в верхней части плитки.
|-
|-
|<code>query</code>
| <code>title</code> || Да || Отображается в верхней части плитки.
|Да
|Запрос '''DQL'''.
|-
|-
|<code>visualization</code>
| <code>visualization</code> || Да || Тип визуализации. См. '''Типы визуализаций'''.
|Да
|Тип визуализации. См. '''Типы визуализаций'''.
|-
|-
|<code>visualizationSettings</code>
| <code>visualizationSettings</code> || Да || Объект настроек, специфичных для визуализации. Может быть пустым.
|Да
|Объект настроек, специфичных для визуализации. Может быть пустым.
|-
|-
|<code>querySettings</code>
| <code>description</code> || Нет || Дополнительное описание плитки.
|Да
|Объект настроек, специфичных для запроса. Может быть пустым.
|-
|-
|<code>description</code>
| <code>timeframe</code> || Нет || Переопределение временного диапазона для конкретной плитки. Должно быть объектом, а не строкой.
|Нет
|Дополнительное описание плитки.
|-
|-
|<code>timeframe</code>
| <code>segments</code> || Нет || Фильтр сегментов для конкретной плитки.
|Нет
|Переопределение временного диапазона для конкретной плитки. Должно быть объектом, а не строкой.
|-
|<code>segments</code>
|Нет
|Фильтр сегментов для конкретной плитки.
|}
|}
Необязательные свойства <code>queryConfig</code> и <code>davisCopilot</code> можно дополнительно использовать для создания специализированных плиток данных:


* если присутствует допустимое свойство <code>queryConfig</code>, плитка интерпретируется как плитка Explore;
=== Код-плитка ===
* если присутствует допустимое свойство <code>davisCopilot</code>, плитка интерпретируется как плитка Prompt.
Код-плитка выполняет '''JavaScript''' и при необходимости отображает результаты в виде визуализации.


=== Код-плитка ===
<pre>{
Код-плитка выполняет '''JavaScript''' и при необходимости отображает результаты в виде визуализации.<pre>{
   "type": "code",
   "type": "code",
   "title": "Custom",
   "title": "Custom",
Строка 108: Строка 79:


=== Плитка SLO ===
=== Плитка SLO ===
Плитка SLO отображает цель уровня обслуживания по её ID.<pre>{
Плитка SLO отображает цель уровня обслуживания по её ID.
 
<pre>{
   "type": "slo",
   "type": "slo",
   "title": "SLO Name",
   "title": "SLO Name",
Строка 115: Строка 88:


== Типы визуализаций ==
== Типы визуализаций ==
Свойство <code>visualization</code> плитки данных определяет, как отображаются результаты запроса. Каждая визуализация требует определённых типов полей в результате запроса. Если запрос возвращает неправильные типы, плитка отображается пустой или показывает ошибку.
Свойство <code>visualization</code> плитки данных определяет, как отображаются данные. Каждая визуализация требует определённых типов полей в наборе данных. Если данные имеют неправильные типы, плитка отображается пустой или показывает ошибку.


Типы полей: <code>timestamp</code>, <code>timeframe</code>, <code>long</code>, <code>double</code>, <code>duration</code>, <code>string</code>, <code>numericArray</code>
Типы полей: <code>timestamp</code>, <code>timeframe</code>, <code>long</code>, <code>double</code>, <code>duration</code>, <code>string</code>, <code>numericArray</code>
Строка 123: Строка 96:
=== Графики временных рядов ===
=== Графики временных рядов ===
<code>lineChart</code>, <code>areaChart</code>, <code>barChart</code> отображают данные метрик во времени.
<code>lineChart</code>, <code>areaChart</code>, <code>barChart</code> отображают данные метрик во времени.
{| class="wikitable"
{| class="wikitable"
!Слот
! Слот !! Принимаемые типы !! Количество !! Обязательность
!Принимаемые типы
!Количество
!Обязательность
|-
|-
|Time
| Time || <code>timestamp</code>, <code>timeframe</code> || 1 || R
|<code>timestamp</code>, <code>timeframe</code>
|1
|R
|-
|-
|Interval
| Interval || <code>duration</code> || 1 || C — обязательно, когда Values имеет тип <code>numericArray</code>
|<code>duration</code>
|1
|C — обязательно, когда Values имеет тип <code>numericArray</code>
|-
|-
|Values
| Values || <code>long</code>, <code>double</code>, <code>duration</code>, <code>numericArray</code> || 1+ || R
|<code>long</code>, <code>double</code>, <code>duration</code>, <code>numericArray</code>
|1+
|R
|-
|-
|Names
| Names || любой || 1+ || O
|любой
|1+
|O
|}
|}
При использовании <code>timeseries</code> или <code>makeTimeseries</code> значения имеют тип <code>numericArray</code>, и в результате запроса должно присутствовать поле интервала.


<code>bandChart</code> имеет те же требования плюс два дополнительных обязательных слота <code>numericArray</code> для минимального и максимального значений полосы.
<code>bandChart</code> имеет те же требования плюс два дополнительных обязательных слота <code>numericArray</code> для минимального и максимального значений полосы.


=== Категориальные графики ===
=== Категориальные графики ===
<code>categoricalBarChart</code>, <code>pieChart</code>, <code>donutChart</code> показывают значения, сгруппированные по категориям. Типичный шаблон запроса: <code>summarize <aggregation>, by:{category}</code>.
<code>categoricalBarChart</code>, <code>pieChart</code>, <code>donutChart</code> показывают значения, сгруппированные по категориям.
 
{| class="wikitable"
{| class="wikitable"
!Слот
! Слот !! Принимаемые типы !! Количество !! Обязательность
!Принимаемые типы
!Количество
!Обязательность
|-
|-
|Values
| Values || <code>long</code>, <code>double</code>, <code>duration</code> || 1+ || R
|<code>long</code>, <code>double</code>, <code>duration</code>
|1+
|R
|-
|-
|Categories
| Categories || любой || 1+ || R
|любой
|1+
|R
|}
|}


=== Одно значение и датчик ===
=== Одно значение и датчик ===
<code>singleValue</code> отображает одно значение метрики.
<code>singleValue</code> отображает одно значение метрики.
{| class="wikitable"
{| class="wikitable"
!Слот
! Слот !! Принимаемые типы !! Количество !! Обязательность
!Принимаемые типы
!Количество
!Обязательность
|-
|-
|Single value
| Single value || любой || 1 || R
|любой
|1
|R
|-
|-
|Sparkline
| Sparkline || <code>numericArray</code> || 1 || O
|<code>numericArray</code>
|1
|O
|}
|}
<code>meterBar</code> и <code>gauge</code> отображают числовое значение на шкале.
<code>meterBar</code> и <code>gauge</code> отображают числовое значение на шкале.
{| class="wikitable"
{| class="wikitable"
!Слот
! Слот !! Принимаемые типы !! Количество !! Обязательность
!Принимаемые типы
!Количество
!Обязательность
|-
|-
|Meter/Gauge value
| Meter/Gauge value || <code>long</code>, <code>double</code>, <code>duration</code> || 1 || R
|<code>long</code>, <code>double</code>, <code>duration</code>
|1
|R
|}
|}


Строка 210: Строка 148:


== Макет ==
== Макет ==
Позиции плиток хранятся в <code>layouts</code> как объект, ключи которого совпадают с ID плиток в <code>tiles</code>. Каждая плитка в <code>tiles</code> должна иметь соответствующую запись в <code>layouts</code>.<pre>"layouts": {
Позиции плиток хранятся в <code>layouts</code> как объект, ключи которого совпадают с ID плиток в <code>tiles</code>. Каждая плитка в <code>tiles</code> должна иметь соответствующую запись в <code>layouts</code>.
 
<pre>"layouts": {
   "1": { "x": 0, "y": 0, "w": 24, "h": 1 },
   "1": { "x": 0, "y": 0, "w": 24, "h": 1 },
   "2": { "x": 0, "y": 1, "w": 12, "h": 8 },
   "2": { "x": 0, "y": 1, "w": 12, "h": 8 },
Строка 216: Строка 156:
   "4": { "x": 0, "y": 9, "w": 24, "h": 8 }
   "4": { "x": 0, "y": 9, "w": 24, "h": 8 }
}</pre>
}</pre>
{| class="wikitable"
{| class="wikitable"
!Свойство
! Свойство !! Описание
!Описание
|-
|-
|<code>x</code>
| <code>x</code> || Горизонтальная позиция (столбец), с индексом от нуля.
|Горизонтальная позиция (столбец), с индексом от нуля.
|-
|-
|<code>y</code>
| <code>y</code> || Вертикальная позиция (строка), с индексом от нуля.
|Вертикальная позиция (строка), с индексом от нуля.
|-
|-
|<code>w</code>
| <code>w</code> || Ширина в единицах сетки.
|Ширина в единицах сетки.
|-
|-
|<code>h</code>
| <code>h</code> || Высота в единицах сетки.
|Высота в единицах сетки.
|}
|}
Сетка имеет ширину 24 столбца. Распространённые значения ширины:
Сетка имеет ширину 24 столбца. Распространённые значения ширины:
* 24 — полная ширина
* 24 — полная ширина
* 12 — половина ширины
* 12 — половина ширины
Строка 239: Строка 175:


Распространённые значения высоты:
Распространённые значения высоты:
* 1 — строка заголовка или метки
* 1 — строка заголовка или метки
* от 6 до 8 — стандартный график
* от 6 до 8 — стандартный график
Строка 247: Строка 182:


== Переменные ==
== Переменные ==
Переменные обеспечивают динамическую фильтрацию по плиткам. Определяются в <code>variables</code> как массив и используются в запросах '''DQL''' через <code>$key</code>.
Переменные обеспечивают динамическую фильтрацию по плиткам. Определяются в <code>variables</code> как массив и используются через <code>$key</code>.


Все типы переменных имеют следующие общие свойства:
Все типы переменных имеют следующие общие свойства:
{| class="wikitable"
{| class="wikitable"
!Свойство
! Свойство !! Тип !! Описание
!Тип
!Описание
|-
|-
|<code>key</code>
| <code>key</code> || string || Идентификатор, используемый как <code>$key</code>.
|string
|Идентификатор, используемый как <code>$key</code> в запросах '''DQL'''.
|-
|-
|<code>type</code>
| <code>type</code> || string || <code>"text"</code> или <code>"csv"</code>.
|string
|<code>"query"</code>, <code>"text"</code> или <code>"csv"</code>.
|-
|-
|<code>visible</code>
| <code>visible</code> || boolean || Показывать селектор переменной в интерфейсе дашборда.
|boolean
|Показывать селектор переменной в интерфейсе дашборда.
|-
|-
|<code>editable</code>
| <code>editable</code> || boolean || Разрешить пользователям изменять выбранное значение.
|boolean
|Разрешить пользователям изменять выбранное значение.
|}
|}


=== Переменные запроса ===
=== Текстовые переменные ===
Переменные запроса заполняют свои параметры путём выполнения запроса '''DQL'''. Запрос должен возвращать ровно одно поле.<pre>{
Текстовые переменные принимают свободный ввод пользователя.
  "version": 2,
  "key": "Service",
  "type": "query",
  "visible": true,
  "editable": true,
  "input": "smartscapeNodes SERVICE | fields name | sort name asc",
  "multiple": false
}</pre>Для множественного выбора со всеми значениями, выбранными по умолчанию, установите <code>"multiple": true</code> и используйте токен выбора всех значений по умолчанию:<pre>{
  "version": 2,
  "key": "Services",
  "type": "query",
  "visible": true,
  "editable": true,
  "input": "smartscapeNodes SERVICE | fields name | sort name asc",
  "multiple": true,
  "defaultValue": ["3420b2ac-f1cf-4b24-b62d-61ba1ba8ed05*"]
}</pre>Используйте полный токен вида UUID-плюс-<code>*</code>, как показано выше, в качестве подстановочного значения, а не литеральную строку <code>"*"</code>. Ключ-АСТРОМ сохраняет подстановочный знак как '''UUID''', чтобы избежать конфликтов с допустимыми значениями переменных, поскольку <code>*</code> сам по себе может быть одним из них. Литеральное значение по умолчанию <code>"*"</code> вызывает непредвиденное поведение — например, при клонировании дашборда предварительно выбирается дополнительная незаполненная опция, которую затем нужно вручную заменить подстановочным знаком в редакторе переменных.


=== Текстовые переменные ===
<pre>{
Текстовые переменные принимают свободный ввод пользователя.<pre>{
   "version": 2,
   "version": 2,
   "key": "Threshold",
   "key": "Threshold",
Строка 303: Строка 211:


=== CSV-переменные ===
=== CSV-переменные ===
CSV-переменные предоставляют статический предопределённый список значений.<pre>{
CSV-переменные предоставляют статический предопределённый список значений.
 
<pre>{
   "version": 2,
   "version": 2,
   "key": "Status",
   "key": "Status",
Строка 312: Строка 222:
   "multiple": true,
   "multiple": true,
   "defaultValue": ["3420b2ac-f1cf-4b24-b62d-61ba1ba8ed05*"]
   "defaultValue": ["3420b2ac-f1cf-4b24-b62d-61ba1ba8ed05*"]
}</pre>Подстановочный токен в <code>defaultValue</code> работает так же, как для переменных запроса: используйте токен вида UUID-плюс-<code>*</code>, а не литеральную строку <code>"*"</code>.
}</pre>


=== Синтаксис ссылок на переменные ===
Подстановочный токен в <code>defaultValue</code> использует полный токен вида UUID-плюс-<code>*</code>, а не литеральную строку <code>"*"</code>. Ключ-АСТРОМ сохраняет подстановочный знак как '''UUID''', чтобы избежать конфликтов с допустимыми значениями переменных, поскольку <code>*</code> сам по себе может быть одним из них. Литеральное значение по умолчанию <code>"*"</code> вызывает непредвиденное поведение — например, при клонировании дашборда предварительно выбирается дополнительная незаполненная опция, которую затем нужно вручную заменить подстановочным знаком в редакторе переменных.
Ссылайтесь на переменную в '''DQL''' с помощью <code>$key</code>.
{| class="wikitable"
!Конфигурация переменной
!Шаблон запроса
|-
|Одиночный выбор (<code>multiple: false</code>)
|<code>filter field == $Variable</code>
|-
|Множественный выбор (<code>multiple: true</code>)
|<code>filter in(field, array($Variable))</code>
|}
Используйте модификаторы, когда подстановка строки по умолчанию не подходит:
{| class="wikitable"
!Модификатор
!Для чего
!Пример
|-
|<code>:noquote</code>
|Числовые параметры или параметры длительности
|<code>limit $N:noquote</code>
|-
|<code>:backtick</code>
|Имя поля в <code>by:{}</code> или <code>sort</code>
|<code>by: {$GroupBy:backtick}</code>
|-
|<code>:triplequote</code>
|Строковые константы в <code>matchesPhrase()</code> или <code>contains()</code>
|<code>matchesPhrase(content, $Search:triplequote)</code>
|}
Переменные могут ссылаться на другие переменные. Зависимая переменная пересчитывается при изменении переменной, от которой она зависит. Циклические зависимости не допускаются.


== Настройки ==
== Настройки ==
<code>settings</code> — необязательный объект. Если он присутствует, он может быть пустым (<code>{}</code>) или содержать конфигурацию уровня дашборда.<pre>"settings": {
<code>settings</code> — необязательный объект. Если он присутствует, он может быть пустым (<code>{}</code>) или содержать конфигурацию уровня дашборда.
 
<pre>"settings": {
   "defaultTimeframe": {
   "defaultTimeframe": {
     "value": {
     "value": {
Строка 355: Строка 237:
     "enabled": true
     "enabled": true
   }
   }
}</pre><code>defaultTimeframe</code> задаёт временной диапазон, отображаемый на плитках, которые не переопределяют временной диапазон. Он также определяет окно, для которого оцениваются аннотации.
}</pre>
 
<code>defaultTimeframe</code> задаёт временной диапазон, отображаемый на плитках, которые не переопределяют временной диапазон. Он также определяет окно, для которого оцениваются аннотации.


== Валидация дашборда ==
== Валидация дашборда ==
Строка 363: Строка 247:


Когда вы открываете дашборд с ошибками валидации, в левом нижнем углу появляется уведомление. Доступные действия зависят от ваших разрешений:
Когда вы открываете дашборд с ошибками валидации, в левом нижнем углу появляется уведомление. Доступные действия зависят от ваших разрешений:
* Разрешения на редактирование: выберите '''Редактировать JSON''', чтобы открыть редактор '''JSON''' и исправить ошибки напрямую.
* Разрешения на редактирование: выберите '''Редактировать JSON''', чтобы открыть редактор '''JSON''' и исправить ошибки напрямую.
* Разрешения на просмотр: вы не можете исправить дашборд. Это должен сделать владелец дашборда.
* Разрешения на просмотр: вы не можете исправить дашборд. Это должен сделать владелец дашборда.


=== Отсутствует обязательное свойство 'type' ===
=== Отсутствует обязательное свойство 'type' ===
'''Ошибка'''<pre>Missing required property 'type' of tile id '10'. Expected one of: 'data', 'code', 'markdown', 'slo'</pre>'''Причина:''' у плитки отсутствует обязательное свойство <code>type</code>. Частая причина — загрузка классического дашборда в '''Дашборды''', который использует другую схему '''JSON'''.
'''Ошибка'''
<pre>Missing required property 'type' of tile id '10'. Expected one of: 'data', 'code', 'markdown', 'slo'</pre>
 
'''Причина:''' у плитки отсутствует обязательное свойство <code>type</code>. Частая причина — загрузка классического дашборда в '''Дашборды''', который использует другую схему '''JSON'''.


'''Исправление:''' добавьте допустимое свойство <code>type</code> к плитке. Поддерживаемые значения: <code>data</code>, <code>code</code>, <code>markdown</code> и <code>slo</code>.
'''Исправление:''' добавьте допустимое свойство <code>type</code> к плитке. Поддерживаемые значения: <code>data</code>, <code>code</code>, <code>markdown</code> и <code>slo</code>.


=== Недопустимый тип для 'timeframe' ===
=== Недопустимый тип для 'timeframe' ===
'''Ошибка'''<pre>Invalid type for property 'timeframe' of tile id '10' (expected object, received string)</pre>'''Причина:''' свойство <code>timeframe</code> является строкой (например, <code>"timeframe": "last 24h"</code>) вместо объекта.
'''Ошибка'''
<pre>Invalid type for property 'timeframe' of tile id '10' (expected object, received string)</pre>
 
'''Причина:''' свойство <code>timeframe</code> является строкой (например, <code>"timeframe": "last 24h"</code>) вместо объекта.
 
'''Исправление:''' замените строковое значение правильным форматом объекта:


'''Исправление:''' замените строковое значение правильным форматом объекта:<pre>"timeframe": {
<pre>"timeframe": {
   "tileTimeframeEnabled": true,
   "tileTimeframeEnabled": true,
   "tileTimeframe": {
   "tileTimeframe": {

Текущая версия от 22:12, 16 ноября 2026

Структура документа Ключ-АСТРОМ — Дашборды

Дашборд Ключ-АСТРОМ хранится как документ JSON. Понимание структуры помогает создавать и изменять дашборды через API или путём прямого редактирования JSON в Дашбордах.

Обзор

Документ дашборда состоит из четырёх обязательных свойств — version, variables, tiles и layouts — плюс необязательные свойства, такие как settings и annotations. Плитки определяют содержимое, отображаемое на дашборде, а макеты управляют их положением на сетке.

Структура верхнего уровня

{
  "version": 21,
  "variables": [],
  "tiles": {},
  "layouts": {}
}
Свойство Тип Описание
version number Версия схемы. Используйте 21 для новых дашбордов.
variables array Определения переменных. См. Переменные.
tiles object Сопоставление ID плитки с определением плитки. См. Плитки.
layouts object Сопоставление ID плитки с позицией в макете. См. Макет.

Необязательные свойства: settings, annotations.

ID плиток в tiles должны совпадать с ID в layouts. ID — это строки (обычно числовые строки, например "1", "2").

Плитки

Плитки хранятся в tiles как объект, ключами которого являются ID плиток. Существует четыре типа плиток.

Плитка Markdown

Плитка Markdown отображает статическое текстовое содержимое, отформатированное с помощью Markdown.

{
  "type": "markdown",
  "content": "# Section Header\n\nSome text here."
}

Плитка данных

Плитка данных отображает данные в виде визуализации.

{
  "type": "data",
  "title": "Tile Name",
  "visualization": "lineChart",
  "visualizationSettings": {}
}
Свойство Обязательно Описание
title Да Отображается в верхней части плитки.
visualization Да Тип визуализации. См. Типы визуализаций.
visualizationSettings Да Объект настроек, специфичных для визуализации. Может быть пустым.
description Нет Дополнительное описание плитки.
timeframe Нет Переопределение временного диапазона для конкретной плитки. Должно быть объектом, а не строкой.
segments Нет Фильтр сегментов для конкретной плитки.

Код-плитка

Код-плитка выполняет JavaScript и при необходимости отображает результаты в виде визуализации.

{
  "type": "code",
  "title": "Custom",
  "input": "// JavaScript code here",
  "visualization": "lineChart",
  "visualizationSettings": {}
}

Плитка SLO

Плитка SLO отображает цель уровня обслуживания по её ID.

{
  "type": "slo",
  "title": "SLO Name",
  "input": "slo-id"
}

Типы визуализаций

Свойство visualization плитки данных определяет, как отображаются данные. Каждая визуализация требует определённых типов полей в наборе данных. Если данные имеют неправильные типы, плитка отображается пустой или показывает ошибку.

Типы полей: timestamp, timeframe, long, double, duration, string, numericArray

Легенда: R = обязательно, O = необязательно, C = условно.

Графики временных рядов

lineChart, areaChart, barChart отображают данные метрик во времени.

Слот Принимаемые типы Количество Обязательность
Time timestamp, timeframe 1 R
Interval duration 1 C — обязательно, когда Values имеет тип numericArray
Values long, double, duration, numericArray 1+ R
Names любой 1+ O

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

Категориальные графики

categoricalBarChart, pieChart, donutChart показывают значения, сгруппированные по категориям.

Слот Принимаемые типы Количество Обязательность
Values long, double, duration 1+ R
Categories любой 1+ R

Одно значение и датчик

singleValue отображает одно значение метрики.

Слот Принимаемые типы Количество Обязательность
Single value любой 1 R
Sparkline numericArray 1 O

meterBar и gauge отображают числовое значение на шкале.

Слот Принимаемые типы Количество Обязательность
Meter/Gauge value long, double, duration 1 R

Табличные

table, raw и recordList принимают любую форму данных без требований к типам полей.

Другие визуализации

Также доступны davis, histogram, honeycomb, choropleth, dotMap, connectionMap, bubbleMap, heatmap, scatterplot и treemap, каждая со своими требованиями к слотам.

Макет

Позиции плиток хранятся в layouts как объект, ключи которого совпадают с ID плиток в tiles. Каждая плитка в tiles должна иметь соответствующую запись в layouts.

"layouts": {
  "1": { "x": 0, "y": 0, "w": 24, "h": 1 },
  "2": { "x": 0, "y": 1, "w": 12, "h": 8 },
  "3": { "x": 12, "y": 1, "w": 12, "h": 8 },
  "4": { "x": 0, "y": 9, "w": 24, "h": 8 }
}
Свойство Описание
x Горизонтальная позиция (столбец), с индексом от нуля.
y Вертикальная позиция (строка), с индексом от нуля.
w Ширина в единицах сетки.
h Высота в единицах сетки.

Сетка имеет ширину 24 столбца. Распространённые значения ширины:

  • 24 — полная ширина
  • 12 — половина ширины
  • 6 — четверть ширины

Распространённые значения высоты:

  • 1 — строка заголовка или метки
  • от 6 до 8 — стандартный график
  • от 12 до 16 — детальный вид

Плитки, у которых x + w > 24, переносятся на следующую строку.

Переменные

Переменные обеспечивают динамическую фильтрацию по плиткам. Определяются в variables как массив и используются через $key.

Все типы переменных имеют следующие общие свойства:

Свойство Тип Описание
key string Идентификатор, используемый как $key.
type string "text" или "csv".
visible boolean Показывать селектор переменной в интерфейсе дашборда.
editable boolean Разрешить пользователям изменять выбранное значение.

Текстовые переменные

Текстовые переменные принимают свободный ввод пользователя.

{
  "version": 2,
  "key": "Threshold",
  "type": "text",
  "visible": true,
  "defaultValue": "",
  "editable": true
}

CSV-переменные

CSV-переменные предоставляют статический предопределённый список значений.

{
  "version": 2,
  "key": "Status",
  "type": "csv",
  "visible": true,
  "editable": true,
  "input": "WARN,ERROR,INFO,NONE",
  "multiple": true,
  "defaultValue": ["3420b2ac-f1cf-4b24-b62d-61ba1ba8ed05*"]
}

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

Настройки

settings — необязательный объект. Если он присутствует, он может быть пустым ({}) или содержать конфигурацию уровня дашборда.

"settings": {
  "defaultTimeframe": {
    "value": {
      "from": "now()-2h",
      "to": "now()"
    },
    "enabled": true
  }
}

defaultTimeframe задаёт временной диапазон, отображаемый на плитках, которые не переопределяют временной диапазон. Он также определяет окно, для которого оцениваются аннотации.

Валидация дашборда

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

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

Когда вы открываете дашборд с ошибками валидации, в левом нижнем углу появляется уведомление. Доступные действия зависят от ваших разрешений:

  • Разрешения на редактирование: выберите Редактировать JSON, чтобы открыть редактор JSON и исправить ошибки напрямую.
  • Разрешения на просмотр: вы не можете исправить дашборд. Это должен сделать владелец дашборда.

Отсутствует обязательное свойство 'type'

Ошибка

Missing required property 'type' of tile id '10'. Expected one of: 'data', 'code', 'markdown', 'slo'

Причина: у плитки отсутствует обязательное свойство type. Частая причина — загрузка классического дашборда в Дашборды, который использует другую схему JSON.

Исправление: добавьте допустимое свойство type к плитке. Поддерживаемые значения: data, code, markdown и slo.

Недопустимый тип для 'timeframe'

Ошибка

Invalid type for property 'timeframe' of tile id '10' (expected object, received string)

Причина: свойство timeframe является строкой (например, "timeframe": "last 24h") вместо объекта.

Исправление: замените строковое значение правильным форматом объекта:

"timeframe": {
  "tileTimeframeEnabled": true,
  "tileTimeframe": {
    "from": "now()-24h",
    "to": "now()"
  }
}