11. Прототип графика

Описание

Эти параметры и возможные значения свойств для соответствующих объектов полей виджета панели мониторинга позволяют настраивать виджет Graph prototype в методах dashboard.create и dashboard.update.

Свойства fields виджета не проверяются при создании или обновлении панели мониторинга. Это позволяет пользователям изменять встроенные виджеты и создавать пользовательские виджеты, но также создает риск некорректного создания или обновления виджетов. Чтобы обеспечить успешное создание или обновление виджета Graph prototype, обратитесь к поведению параметров, описанному в таблицах ниже.

Параметры

Следующие параметры поддерживаются для виджета Graph prototype.

Parameter type name value
Refresh interval 0 rf_rate 0 - Без обновления;
10 - 10 секунд;
30 - 30 секунд;
60 - (по умолчанию) 1 минута;
120 - 2 минуты;
600 - 10 минут;
900 - 15 минут.
Source 0 source_type 2 - (по умолчанию) Graph prototype;
3 - Simple graph prototype.
Graph prototype 7 graphid.0 ID Graph prototype.

Поведение параметра:
- required if Source is set to "Graph prototype"
Item prototype 5 itemid.0 ID Item prototype.

Поведение параметра:
- required if Source is set to "Simple graph prototype"
Time period 1 time_period._reference DASHBOARD._timeperiod - задает селектор Time period в качестве источника данных;
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 и т. д.).

Поведение параметра:
- supported if Time period is not set
- required if time_period.to is set
To 1 time_period.to Допустимая строка времени в абсолютном формате (YYYY-MM-DD hh:mm:ss) или относительном синтаксисе времени (now, now/d, now/w-1w и т. д.).

Поведение параметра:
- supported if Time period is not set
- required if time_period.from is set
Show legend 0 show_legend 0 - Отключено;
1 - (по умолчанию) Включено.
Override host 1 override_hostid._reference ABCDE._hostid - задает совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для узлов сети;
DASHBOARD._hostid - задает селектор Host на панели в качестве источника данных для узлов сети.

Этот параметр не поддерживается при настройке виджета на шаблонной панели.
Columns 0 columns Допустимые значения: от 1 до 24.

По умолчанию: 2.
Rows 0 rows Допустимые значения: от 1 до 16.

По умолчанию: 1.
Reference 1 reference Любое строковое значение, состоящее из 5 символов (например, ABCDE или JBPNL). Это значение должно быть уникальным в пределах панели, к которой принадлежит виджет.

Поведение параметра:
- required

Примеры

Следующие примеры предназначены только для описания конфигурации объектов полей виджета панели мониторинга для виджета Graph prototype. Дополнительную информацию о настройке панели мониторинга см. в dashboard.create.

Настройка виджета Graph prototype

Настройте виджет Graph prototype, который отображает сетку из 3 графиков (3 столбца, 1 строка), созданных из прототипа элемента данных (ID: "42316") с помощью низкоуровневого обнаружения.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "graphprototype",
                        "name": "Graph prototype",
                        "x": 0,
                        "y": 0,
                        "width": 48,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 0,
                                "name": "source_type",
                                "value": 3
                            },
                            {
                                "type": 5,
                                "name": "itemid.0",
                                "value": 42316
                            },
                            {
                                "type": 0,
                                "name": "columns",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "OPQWX"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

Смотрите также