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番目の番号がある場合は、設定されたホストまたはアイテムを表します。

パラメータ タイプ 名前
データセットタイプ 0 ds.0.dataset_type 0 - アイテムリスト;
1 - (デフォルト) アイテムパターン。
アイテム 4 ds.0.itemids.0 アイテム ID。

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

注: 複数のアイテムを設定するには、プロパティ名の番号を増分したダッシュボードウィジェットフィールドオブジェクトをアイテムごとに作成します。

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

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

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

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

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

テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。
アイテムパターン 1 ds.0.items.0 アイテム名またはパターン(例: "*: 1秒あたりの処理済み*値の数")。

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

パラメータの動作:
- データセットタイプが「アイテムパターン」に設定されている場合は必須
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 - 有効。

パラメータの動作:
- 描画が「線」、「階段状」、または「棒」に設定されている場合にサポート
0 ds.0.width 指定可能な値は1~10です。

デフォルト: 1。

パラメータの動作:
- 描画が「線」または「階段状」に設定されている場合にサポート
点のサイズ 0 ds.0.pointsize 指定可能な値は1~10です。

デフォルト: 3。

パラメータの動作:
- 描画が「点」に設定されている場合にサポート
透明度 0 ds.0.transparency 指定可能な値は1~10です。

デフォルト: 5。
塗りつぶし 0 ds.0.fill 指定可能な値は1~10です。

デフォルト: 3。

パラメータの動作:
- 描画が「線」または「階段状」に設定されている場合にサポート
欠損データ 0 ds.0.missingdatafunc 0 - (デフォルト) なし;
1 - 接続;
2 - 0として扱う;
3 - 最後の既知の値。

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

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

デフォルト: ""(空)。
集計関数 0 ds.0.aggregate_function 0 - (デフォルト) 使用しない;
1 - 最小;
2 - 最大;
3 - 平均;
4 - 件数;
5 - 合計;
6 - 最初;
7 - 最後。
集計間隔 1 ds.0.aggregate_interval 有効な時間文字列(例: 36001hなど)。
時間サフィックスを使用できます。

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

パラメータの動作:
- 集計関数が「最小」、「最大」、「平均」、「件数」、「合計」、「最初」、または「最後」に設定されている場合にサポート
近似 0 ds.0.approximation 1 - 最小;
2 - (デフォルト) 平均;
4 - 最大;
7 - すべて。
データセットラベル 1 ds.0.data_set_label 任意の文字列値。

デフォルト: ""(空)。
アイテムタグ
評価タイプ 0 ds.0.item_tags_evaltype 0 - (デフォルト) And/Or;
2 - Or。
タグ名 1 ds.0.item_tags.0.tag 任意の文字列値。

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

パラメータの動作:
- アイテムタグを設定する場合は必須
演算子 0 ds.0.item_tags.0.operator 0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。

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

パラメータの動作:
- アイテムタグを設定する場合は必須
タグ値 1 ds.0.item_tags.0.value 任意の文字列値。

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

パラメータの動作:
- アイテムタグを設定する場合は必須

表示オプション

表示オプションの設定では、次のパラメータがサポートされています。

パラメータ タイプ 名前
履歴データの選択 0 source 0 - (デフォルト) 自動;
1 - 履歴;
2 - トレンド。
シンプルなトリガー 0 simple_triggers 0 - (デフォルト) 無効;
1 - 有効。
稼働時間 0 working_time 0 - (デフォルト) 無効;
1 - 有効。
ラベル内のホスト名 0 show_hostnames 0 - (デフォルト) 自動;
1 - 表示;
2 - 非表示。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
パーセンタイルライン(左)
ステータス 0 percentile_left 0 - (デフォルト) 無効;
1 - 有効。

パラメータの動作:
- データセットの設定でY軸が「左」に設定されている場合にサポート
0 percentile_left_value 指定可能な値の範囲は1~100です。

パラメータの動作:
- データセットの設定でY軸が「左」に設定されている場合にサポート
パーセンタイルライン(右)
ステータス 0 percentile_right 0 - (デフォルト) 無効;
1 - 有効。

パラメータの動作:
- データセットの設定でY軸が「右」に設定されている場合にサポート
0 percentile_right_value 指定可能な値の範囲は1~100です。

パラメータの動作:
- データセットの設定でY軸が「右」に設定されている場合にサポート

期間

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

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

デフォルト: DASHBOARD._timeperiod

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

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

パラメータの動作:
- 期間が設定されていない場合はサポート
- time_period.fromが設定されている場合は必須

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 - (デフォルト) 有効

凡例

凡例の設定では、次のパラメータがサポートされています。

パラメータ type name value
凡例を表示 0 legend 0 - 無効;
1 - (デフォルト) 有効。
最小値/平均値/最大値を表示 0 legend_statistic 0 - (デフォルト) 無効;
1 - 有効。

パラメータの動作:
- 凡例を表示が「有効」に設定されている場合にサポート
集計関数を表示 0 legend_aggregation 0 - (デフォルト) 無効;
1 - 有効。

パラメータの動作:
- 凡例を表示が「有効」に設定されている場合にサポート
0 legend_lines_mode 0 - (デフォルト) 固定;
1 - 可変。

パラメータの動作:
- 凡例を表示が「有効」に設定されている場合にサポート
行数/
最大行数
0 legend_lines 指定可能な値の範囲は1~10です。

デフォルト: 1。

パラメータの動作:
- 凡例を表示が「有効」に設定されている場合にサポート
列数 0 legend_columns 指定可能な値の範囲は1~4です。

デフォルト: 4。

パラメータの動作:
- 凡例を表示が「有効」に設定され、最小値/平均値/最大値を表示が「無効」に設定されている場合にサポート

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 任意の文字列値

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

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

オーバーライド

オーバーライドの設定では、以下のパラメータがサポートされています。

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

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

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

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

パラメータの動作:
- オーバーライドを設定する場合は必須
基本色 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 - 右。
値を反転 0 or.0.invert_values 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
}

参照