16 История элемента данных
Описание
Эти параметры и возможные значения свойств для соответствующих объектов полей виджета панели позволяют настроить виджет Item history в методах dashboard.create и dashboard.update.
Свойства fields виджета не проверяются при создании или обновлении панели.
Это позволяет пользователям изменять встроенные виджеты и создавать пользовательские виджеты, но также создает риск некорректного создания или обновления виджетов.
Чтобы обеспечить успешное создание или обновление виджета Item history, см. описание поведения параметров в таблицах ниже.
Параметры
Следующие параметры поддерживаются для виджета Item history.
| Parameter | type | name | value |
|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - Без обновления; 10 - 10 секунд; 30 - 30 секунд; 60 - (по умолчанию) 1 минута; 120 - 2 минуты; 600 - 10 минут; 900 - 15 минут. |
| Layout | 0 | layout | 0 - (по умолчанию) Горизонтально; 1 - Вертикально. |
| Columns (see below) | |||
| Show lines | 0 | show_lines | Допустимые значения: от 1 до 100. По умолчанию: 25. |
| Override host | 1 | override_hostid._reference | ABCDE._hostid - задайте совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для узлов сети;DASHBOARD._hostid - задайте селектор Host на панели в качестве источника данных для узлов сети.Этот параметр не поддерживается при настройке виджета на шаблонной панели. |
| Advanced configuration (see below) | |||
| Reference | 1 | reference | Любое строковое значение, состоящее из 5 символов (например, ABCDE или JBPNL). Это значение должно быть уникальным в пределах панели, которой принадлежит виджет.Поведение параметра: - required |
Столбцы
Столбцы имеют общие параметры и дополнительные параметры в зависимости от настройки параметра Item.
Для всех параметров, связанных со столбцами, число в имени свойства (например, columns.0.name) указывает на столбец, для которого настроен параметр.
Следующие параметры поддерживаются для всех столбцов.
| Parameter | type | name | value |
|---|---|---|---|
| Name | 1 | columns.0.name | Любое строковое значение. Поведение параметра: - required |
| Item | 4 | columns.0.itemid | ID элемента данных. При настройке виджета на шаблонной панели следует указывать только элементы данных, настроенные на шаблоне. Поведение параметра: - required |
| Base color | 1 | columns.0.base_color | Шестнадцатеричный код цвета (например, FF0000).По умолчанию: "" (пусто). |
Следующие параметры столбца поддерживаются, если настроенный элемент данных является элементом числового типа.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Display | 0 | columns.0.display | 1 - (по умолчанию) Как есть; 2 - Bar; 3 - Indicators. |
|
| Min | 1 | columns.0.min | Любое числовое значение. Поведение параметра: - supported если Display установлено в "Bar" или "Indicators" |
|
| Max | 1 | columns.0.max | Любое числовое значение. Поведение параметра: - supported если Display установлено в "Bar" или "Indicators" |
|
| Thresholds | ||||
| Color | 1 | columns.0.thresholds.0.color | Шестнадцатеричный код цвета (например, FF0000). |
|
| Threshold | 1 | columns.0.thresholds.0.threshold | Любое числовое значение. Поддерживаются суффиксы (например, "1d", "2w", "4K", "8G"). | |
| History data | 0 | columns.0.history | 0 - (по умолчанию) Авто; 1 - История; 2 - Тренды. |
|
Поддерживаются следующие параметры столбца, если настроенный элемент данных имеет тип character, text или log.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Highlights | ||||
| Highlight | 1 | columns.0.highlights.0.color | Шестнадцатеричный код цвета (например, FF0000). |
|
| Threshold | 1 | columns.0.highlights.0.pattern | Любое регулярное выражение. | |
| Display | 0 | columns.0.display | 1 - (по умолчанию) Как есть; 4 - HTML; 5 - Одна строка. |
|
| Single line | 0 | columns.0.max_length | Возможные значения: от 1 до 500. По умолчанию: 100. Поведение параметра: - supported, если для Display установлено значение "Single line" |
|
| Use monospace font | 0 | columns.0.monospace_font | 0 - (по умолчанию) Использовать шрифт по умолчанию; 1 - Использовать моноширинный шрифт. |
|
| Display local time | 0 | columns.0.local_time | 0 - (по умолчанию) Отображать метку времени; 1 - Отображать местное время. Поведение параметра: - supported, если для Item установлено значение элемента данных типа log, а для Show timestamp установлено значение "Enabled" |
|
Поддерживаются следующие параметры столбца, если настроенный элемент данных является элементом данных двоичного типа.
| Parameter | type | name | value |
|---|---|---|---|
| Show thumbnail | 1 | columns.0.show_thumbnail | 0 - (default) Disabled; 1 - Enabled. |
Расширенная настройка
Следующие параметры расширенной настройки поддерживаются для виджета Item history.
| Parameter | type | name | value | |
|---|---|---|---|---|
| New values | 0 | sortorder | 0 - (по умолчанию) Сверху; 1 - Снизу. |
|
| Show timestamp | 0 | show_timestamp | 0 - (по умолчанию) Отключено; 1 - Включено. |
|
| Show column header | 0 | show_column_header | 0 - Выкл.; 1 - Горизонтально; 2 - (по умолчанию) Вертикально. |
|
| Time period | 1 | time_period._reference | DASHBOARD._timeperiod - задает селектор периода времени в качестве источника данных;ABCDE._timeperiod - задает совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных.По умолчанию: DASHBOARD._timeperiodКроме того, вы можете задать период времени только в параметрах From и To. |
|
| From | 1 | time_period.from | Допустимая строка времени в абсолютном формате (YYYY-MM-DD hh:mm:ss) или относительном синтаксисе времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - поддерживается, если Time period не задан - обязателен, если задан time_period.to |
|
| To | 1 | time_period.to | Допустимая строка времени в абсолютном формате (YYYY-MM-DD hh:mm:ss) или относительном синтаксисе времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - поддерживается, если Time period не задан - обязателен, если задан time_period.from |
|
Примеры
Следующие примеры предназначены только для описания конфигурации объектов полей виджета панели мониторинга для виджета Item history.
Дополнительную информацию о настройке панели мониторинга см. в dashboard.create.
Настройка виджета Item history
Настройте виджет Item history, который отображает последние данные для двух числовых элементов данных "42269" и "42270". Кроме того, настройте отображение столбцов элементов данных по вертикали, а имен столбцов — по горизонтали; ограничьте отображение 15 строками данных и добавьте отдельный столбец с временной меткой.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "itemhistory",
"name": "Item history",
"x": "0",
"y": "0",
"width": "18",
"height": "6",
"view_mode": "0",
"fields": [
{
"type": "0",
"name": "layout",
"value": "1"
},
{
"type": "1",
"name": "columns.0.name",
"value": "CPU utilization"
},
{
"type": "4",
"name": "columns.0.itemid",
"value": "42269"
},
{
"type": "1",
"name": "columns.1.name",
"value": "Memory utilization"
},
{
"type": "4",
"name": "columns.1.itemid",
"value": "42270"
},
{
"type": "0",
"name": "show_lines",
"value": "15"
},
{
"type": "0",
"name": "show_timestamp",
"value": "1"
},
{
"type": "0",
"name": "show_column_header",
"value": "1"
},
{
"type": "1",
"name": "reference",
"value": "KIVKD"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}