8 Graph

説明

これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの可能なプロパティ値により、dashboard.createおよびdashboard.updateメソッドでグラフウィジェットを設定できます。

ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新するリスクも生じます。 グラフウィジェットの作成または更新を確実に行うには、以下の表に記載されているパラメーターの動作を参照してください。

パラメーター

グラフウィジェットでは、以下のパラメーターがサポートされています。

パラメーター type name value
リフレッシュ間隔 0 rf_rate 0 - 更新なし
10 - 10秒
30 - 30秒
60 - (デフォルト) 1分
120 - 2分
600 - 10分
900 - 15分
参照 1 reference 5文字で構成される文字列値(例: ABCDEまたはJBPNL)。この値は、ウィジェットが属するダッシュボード内で一意でなければなりません。

パラメーターの動作:
- 必須

データセット

以下のパラメータは、データセット の設定でサポートされています。

プロパティ名の最初の数字(例: ds.0.hosts.0、ds.0.items.0)は特定のデータセットを表し、2番目の数字がある場合は、設定されたホストまたはアイテムを表します。

Parameter type name value
データセットタイプ 0 ds.0.dataset_type 0 - アイテムリスト;
1 - (デフォルト) アイテムパターン。
アイテム 4 ds.0.itemids.0 アイテム ID。

テンプレートダッシュボード でウィジェットを設定する場合は、テンプレートで設定されたアイテムのみを設定してください。

注: 複数のアイテムを設定するには、プロパティ名の番号を増やして、アイテムごとに dashboard widget field オブジェクトを作成します。

パラメータの動作:
- 必須 データセットタイプ が "アイテムリスト" に設定され、かつ アイテム (ウィジェット) が設定されていない場合
アイテム (ウィジェット) 1 ds.0.itemids.0._reference アイテム ID の代わりに:
ABCDE._itemid - 互換ウィジェットReference パラメータが "ABCDE" に設定されているもの)をアイテムのデータソースとして設定します。

注: 複数のウィジェットを設定するには、プロパティ名の番号を増やして、ウィジェットごとに dashboard widget field オブジェクトを作成します。

パラメータの動作:
- 必須 データセットタイプ が "アイテムリスト" に設定され、かつ アイテム が設定されていない場合
1 ds.0.color.0 16進数のカラーコード(例: FF0000)。

パラメータの動作:
- 必須 データセットタイプ が "アイテムリスト" に設定されている場合
ホストパターン 1 ds.0.hosts.0 ホスト 名またはパターン(例: "Zabbix*")。

パラメータの動作:
- 必須 データセットタイプ が "アイテムパターン" に設定されている場合

このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。
アイテムパターン 1 ds.0.items.0 アイテム 名またはパターン(例: "*: Number of processed *values per second")。

テンプレートダッシュボード でウィジェットを設定する場合は、テンプレートで設定されたアイテムのパターンのみを設定してください。

パラメータの動作:
- 必須 データセットタイプ が "アイテムパターン" に設定されている場合
1 ds.0.color 16進数のカラーコード(例: FF0000)。

パラメータの動作:
- サポートされる データセットタイプ が "アイテムパターン" に設定され、かつ カラーパレット が設定されていない場合
カラーパレット 0 ds.0.color_palette カラーパレットのインデックス。

有効な値の範囲は 0-11 です。

デフォルト: 0。

パラメータの動作:
- サポートされる データセットタイプ が "アイテムパターン" に設定され、かつ が設定されていない場合
描画 0 ds.0.type 0 - (デフォルト) ライン;
1 - ポイント;
2 - 階段;
3 - バー。
積み上げ 0 ds.0.stacked 0 - (デフォルト) 無効;
1 - 有効。

パラメータの動作:
- サポートされる 描画 が "Line"、"Staircase"、または "Bar" に設定されている場合
0 ds.0.width 有効な値の範囲は 1-10 です。

デフォルト: 1。

パラメータの動作:
- サポートされる 描画 が "Line" または "Staircase" に設定されている場合
ポイントサイズ 0 ds.0.pointsize 有効な値の範囲は 1-10 です。

デフォルト: 3。

パラメータの動作:
- サポートされる 描画 が "Points" に設定されている場合
透明度 0 ds.0.transparency 有効な値の範囲は 1-10 です。

デフォルト: 5。
塗りつぶし 0 ds.0.fill 有効な値の範囲は 1-10 です。

デフォルト: 3。

パラメータの動作:
- サポートされる 描画 が "Line" または "Staircase" に設定されている場合
欠損データ 0 ds.0.missingdatafunc 0 - (デフォルト) なし;
1 - 接続済み;
2 - 0 として扱う;
3 - 最後に取得した値。

パラメータの動作:
- サポートされる 描画 が "Line" または "Staircase" に設定されている場合
ホストを上書き 1 ds.0.override_hostid._reference ABCDE._hostid- ホストのデータソースとして、互換ウィジェット("Reference" パラメータが "ABCDE" に設定されているもの)を設定します;
DASHBOARD._hostid - ホストのデータソースとして、ダッシュボードのホストセレクターを設定します。

このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。
Y軸 0 ds.0.axisy 0 - (デフォルト) 左;
1 - 右。
時間シフト 1 ds.0.timeshift 有効な時間文字列(例: 36001h など)。
時間サフィックス を使用できます。負の値も指定できます。

デフォルト: ""(空)。
集計関数 0 ds.0.aggregate_function 0 - (デフォルト) 使用しない;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last。
集計間隔 1 ds.0.aggregate_interval 有効な時間文字列(例: 36001h など)。
時間サフィックス を使用できます。

デフォルト: 1h
集計 0 ds.0.aggregate_grouping 0 - (デフォルト) 各アイテム;
1 - データセット。

パラメータの動作:
- サポートされる 集計関数 が "min"、"max"、"avg"、"count"、"sum"、"first"、または "last" に設定されている場合
近似 0 ds.0.approximation 1 - min;
2 - (デフォルト) avg;
4 - max;
7 - all。
データセットラベル 1 ds.0.data_set_label 任意の文字列値。

デフォルト: ""(空)。

表示オプション

以下のパラメータは、表示オプション の設定に使用できます。

Parameter type name value
履歴データの選択 0 source 0 - (default) 自動;
1 - 履歴;
2 - トレンド。
シンプルトリガー 0 simple_triggers 0 - (default) 無効;
1 - 有効。
稼働時間 0 working_time 0 - (default) 無効;
1 - 有効。
パーセンタイル線(左)
状態 0 percentile_left 0 - (default) 無効;
1 - 有効。

パラメータの動作:
- supported if Y-axis (in Data set configuration) is set to "Left"
0 percentile_left_value 指定可能な値の範囲は 1-100 です。

パラメータの動作:
- supported if Y-axis (in Data set configuration) is set to "Left"
パーセンタイル線(右)
状態 0 percentile_right 0 - (default) 無効;
1 - 有効。

パラメータの動作:
- supported if Y-axis (in Data set configuration) is set to "Right"
0 percentile_right_value 指定可能な値の範囲は 1-100 です。

パラメータの動作:
- supported if Y-axis (in Data set configuration) is set to "Right"

時間期間

以下のパラメータは、時間期間 の設定に使用できます。

Parameter type name value
時間期間 1 time_period._reference DASHBOARD._timeperiod - 時間期間 セレクター をデータソースとして設定します;
ABCDE._timeperiod - 互換性のあるウィジェットReference パラメータが "ABCDE" に設定されているもの)をデータソースとして設定します。

デフォルト: DASHBOARD._timeperiod

または、FromTo パラメータのみで時間期間を設定することもできます。
From 1 time_period.from 絶対時間 (YYYY-MM-DD hh:mm:ss) または 相対 時刻構文 (nownow/dnow/w-1w など) の有効な時間文字列。

パラメータの動作:
- Time period が設定されていない場合は supported
- time_period.to が設定されている場合は required
To 1 time_period.to 絶対時間 (YYYY-MM-DD hh:mm:ss) または 相対 時刻構文 (nownow/dnow/w-1w など) の有効な時間文字列。

パラメータの動作:
- Time period が設定されていない場合は supported
- time_period.from が設定されている場合は required

Axes

の設定には、以下のパラメーターがサポートされています。

パラメーター type name value
左Y軸 0 lefty 0 - 無効
1 - (デフォルト) 有効

パラメーターの動作:
- Y軸 (データセット 設定内) が"左"に設定されている場合に サポート されます。
右 Y 0 righty 0 - (デフォルト) 無効;
1 - 有効

パラメータの動作:
- Y 軸 (データセット 設定内) が"右"に設定されている場合に サポートされます。
スケール 0 lefty_scale 0 - (デフォルト) 線形;
1 - 対数
righty_scale
最小値 1 lefty_min 任意の数値

デフォルト: "" (空)
righty_min
最大値 1 lefty_max 任意の数値

デフォルト: "" (空)
righty_max
単位 (タイプ) 0 lefty_units 0 - (デフォルト) 自動;
1 - 静的
righty_units
単位 (値) 1 lefty_static_units 任意の文字列値。

デフォルト: "" (空)
righty_static_units
X軸 0 xaxis 0 - 無効;
1 - (デフォルト) 有効

凡例

以下のパラメータは、凡例 の設定に使用できます。

Parameter type name value
凡例を表示 0 legend 0 - 無効;
1 - (default) 有効.

Parameter behavior:
- supported if 凡例を表示 is set to "Enabled"
最小/平均/最大を表示 0 legend_statistic 0 - (default) 無効;
1 - 有効.

Parameter behavior:
- supported if 凡例を表示 is set to "Enabled"
集計関数を表示 0 legend_aggregation 0 - (default) 無効;
1 - 有効.

Parameter behavior:
- supported if 凡例を表示 is set to "Enabled"
行数 0 legend_lines_mode 0 - (default) 固定;
1 - 可変.

Parameter behavior:
- supported if 凡例を表示 is set to "Enabled"
行数/
最大行数
0 legend_lines 指定可能な値の範囲は 1-10 です。

デフォルト: 1.

Parameter behavior:
- supported if 凡例を表示 is set to "Enabled"
列数 0 legend_columns 指定可能な値の範囲は 1-4 です。

デフォルト: 4.

Parameter behavior:
- supported if 凡例を表示 is set to "Enabled", and 最小/平均/最大を表示 is set to "Disabled"

Problems

問題の設定には、以下のパラメータがサポートされています。

パラメータ type name value
問題を表示 0 show_problems 0 - (デフォルト) 無効;
1 - (デフォルト) 有効
選択された項目のみ 0 graph_item_problems 0 - (デフォルト) 有効
問題のあるホスト 1 problemhosts.0 ホスト

注: プロパティ名の数字は、設定されたホストを参照します。
複数のホストを設定するには、プロパティ名に増分番号を付けたダッシュボード ウィジェット フィールド オブジェクトをホストごとに作成します。

このパラメーターは、テンプレート ダッシュボード でウィジェットを設定する場合、サポートされません。
重大度 0 severities.0 0 - 分類なし
1 - 情報
2 - 警告
3 - 平均
4 - 高
5 - 災害

デフォルト: 空 (すべて有効)

注: 複数の値を設定するには、プロパティ名に増分番号を付けたダッシュボード ウィジェット フィールド オブジェクトを値ごとに作成します。
問題 1 problem_name 問題イベント名 (大文字と小文字は区別されません。完全な名前またはその一部)
問題タグ
評価タイプ 0 evaltype 0 - (デフォルト) And/Or;
2 - Or
タグ名 1 tags.0.tag 任意の文字列値

注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。

パラメータの動作:
- 問題タグ を構成する場合は 必須
演算子 0 tags.0.operator 0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない

注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。

パラメーターの動作:
- 問題のあるタグを構成する場合は必須
タグ値 1 tags.0.value 任意の文字列値

注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。

パラメーターの動作:
- 問題のあるタグを構成する場合は必須

Overrides

以下のパラメータは Overrides の設定に使用できます。

プロパティ名の最初の数字(例: or.0.hosts.0、or.0.items.0)は特定のデータセットを表し、 2番目の数字がある場合は、設定されたホストまたはアイテムを表します。

Parameter type name value
ホストパターン 1 or.0.hosts.0 ホスト名またはパターン(例: Zabbix*)。

このパラメータは、ウィジェットをテンプレートダッシュボードで設定する場合はサポートされません。

パラメータの動作:
- Overrides を設定する場合は 必須
アイテムパターン 1 or.0.items.0 アイテム名またはパターン(例: *: Number of processed *values per second)。
ウィジェットをテンプレートダッシュボードで設定する場合は、テンプレートで設定されたアイテムのパターンのみを設定してください。

パラメータの動作:
- Overrides を設定する場合は 必須
ベースカラー 1 or.0.color 16進数のカラーコード(例: FF0000)。
0 or.0.width 指定可能な値の範囲は 1-10 です。
描画 0 or.0.type 0 - 線;
1 - 点;
2 - 階段;
3 - 棒。
透明度 0 or.0.transparency 指定可能な値の範囲は 1-10 です。
塗りつぶし 0 or.0.fill 指定可能な値の範囲は 1-10 です。
ポイントサイズ 0 or.0.pointsize 指定可能な値の範囲は 1-10 です。
欠損データ 0 or.0.missingdatafunc 0 - なし;
1 - 接続する;
2 - 0 として扱う;
3 - 最後に取得した値。
Y軸 0 or.0.axisy 0 - 左;
1 - 右。
タイムシフト 1 or.0.timeshift 有効な時間文字列(例: 36001h など)。
時間サフィックスを使用できます。負の値も指定可能です。

次の例は、グラフウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。

グラフウィジェットの設定

グラフウィジェットは、以下のように設定します。

  • 1つのホストに合計9つのアイテムを持つ2つのデータセット。
  • 最初のデータセットは「アイテムリスト」タイプで、3つのアイテムで構成され、それぞれ異なる色の線で表されますが、幅、透明度、塗りつぶしは同じです。
  • 2番目のデータセットは「アイテムパターン」タイプで、6つのアイテムで構成され、集計が設定されており、カスタムの色、幅、透明度、塗りつぶしの線で表されます。
  • 2番目のデータセットにはカスタムのデータセットラベルもあります。
  • グラフのデータは直近3時間の期間で表示されます。
  • グラフの問題は、設定されたアイテムに対してのみ表示されます。
  • グラフには2つのY軸があり、右側のY軸は2番目のデータセットの値のみを表示します。
  • グラフの凡例には、4行で設定されたアイテムと、データセットの最小値、最大値、平均値が表示されます。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "svggraph",
                        "name": "Graph",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 0,
                                "name": "ds.0.dataset_type",
                                "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.0",
                                "value": 23264
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.0",
                                "value": "FF0000"
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.1",
                                "value": 23269
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.1",
                                "value": "BF00FF"
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.2",
                                "value": 23257
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.2",
                                "value": "0040FF"
                            },
                            {
                                "type": 0,
                                "name": "ds.0.width",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "ds.0.transparency",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "ds.0.fill",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "ds.1.hosts.0",
                                "value": "Zabbix server"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.items.0",
                                "value": "*: Number of processed *values per second"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.color",
                                "value": "000000"
                            },
                            {
                                "type": 0,
                                "name": "ds.1.transparency",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "ds.1.fill",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "ds.1.axisy",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "ds.1.aggregate_function",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "ds.1.aggregate_interval",
                                "value": "1m"
                            },
                            {
                                "type": 0,
                                "name": "ds.1.aggregate_grouping",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "ds.1.data_set_label",
                                "value": "Number of processed values per second"
                            },
                            {
                                "type": 0,
                                "name": "graph_time",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "time_period.from",
                                "value": "now-3h"
                            },
                            {
                                "type": 1,
                                "name": "time_period.to",
                                "value": "now"
                            },
                            {
                                "type": 0,
                                "name": "legend_statistic",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "legend_lines",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "show_problems",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "YZABC"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照