apmmetric.get

説明

integer/array apmmetric.get(object parameters)

このメソッドを使用すると、指定したパラメータに従ってメトリクスのデータポイントを取得できます。

このメソッドは、すべてのタイプのユーザーが利用できます。 メソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。 詳細については、ユーザーロールを参照してください。

パラメータ

(object) 目的の出力を定義するパラメータ。

このメソッドでは、以下のパラメータをサポートしています。

パラメータ タイプ 説明
time_from timestamp 指定した時刻以降の時刻を持つデータポイントのみを返します。

パラメータの動作:
- 必須
time_till timestamp 指定した時刻より前の時刻を持つデータポイントのみを返します。

パラメータの動作:
- 必須
types integer/array 指定したタイプのデータポイントのみを返します。

サポートされているメトリクスタイプの一覧については、APMメトリクスオブジェクトのページを参照してください。
with_flags_on integer 指定したフラグがすべて設定されているデータポイントのみを返します。
複数のフラグを指定するには、それらの値の合計を使用します。
with_flags_off integer 指定したフラグがいずれも設定されていないデータポイントのみを返します。
複数のフラグを指定するには、それらの値の合計を使用します。
resource_attributes object/array 指定したリソース属性を持つデータポイントのみを返します。
形式: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...]。
空の配列を指定すると、すべてのデータポイントを返します。

指定可能な演算子の値:
0 - (デフォルト) 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。
resource_attributes_evaltype integer resource_attributes の条件に対する評価方法。

指定可能な値:
0 - (デフォルト) And/Or;
2 - Or。
scope_attributes object/array 指定したスコープ属性を持つデータポイントのみを返します。
形式: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...]。
空の配列を指定すると、すべてのデータポイントを返します。

指定可能な演算子の値:
0 - (デフォルト) 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。
scope_attributes_evaltype integer scope_attributes の条件に対する評価方法。

指定可能な値:
0 - (デフォルト) And/Or;
2 - Or。
attributes object/array 指定した属性を持つデータポイントのみを返します。
形式: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...]。
空の配列を指定すると、すべてのデータポイントを返します。

指定可能な演算子の値:
0 - (デフォルト) 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。
attributes_evaltype integer attributes の条件に対する評価方法。

指定可能な値:
0 - (デフォルト) And/Or;
2 - Or。
filter object 指定したフィルターに完全に一致する結果のみを返します。

プロパティ名をキーとし、一致させる単一の値または値の配列を値とするオブジェクトを受け取ります。

サポートされているプロパティ: resource_schema_url、scope_schema_url、scope_name、scope_version、service_name、metric_name、metric_unit、flags。
search object 指定したパターンに一致する結果を返します（大文字と小文字を区別しません）。

プロパティ名をキーとし、検索対象の文字列を値とするオブジェクトを受け取ります。追加のオプションを指定しない場合、LIKE "%…%" 検索を実行します。

サポートされているプロパティ: resource_schema_url、scope_schema_url、scope_name、scope_version、service_name、metric_name、metric_description、metric_unit。
sortfield string/array 指定したプロパティで結果をソートします。

指定可能な値: type、resource_schema_url、scope_schema_url、scope_name、scope_version、service_name、metric_name、metric_unit、start_time_unix、time_unix。
offset integer 結果を返す前にスキップするレコード数。
countOutput boolean これらのパラメータについては、リファレンスコメントで説明しています。
excludeSearch boolean
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

戻り値

(integer/array) 次のいずれかを返します。

  • オブジェクトの配列
  • countOutput パラメータが使用されている場合は、取得したオブジェクトの数

例

ヒストグラムデータポイントの取得

zabbix-frontend サービスの http.server.request.duration ヒストグラムメトリクスの最新のデータポイントを取得します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "apmmetric.get",
    "params": {
        "output": ["metric_name", "metric_unit", "time_unix", "count", "sum", "min", "max", "explicit_bounds", "bucket_counts", "exemplars"],
        "time_from": 1790848800,
        "time_till": 1790852400,
        "types": 2,
        "filter": {
            "service_name": "zabbix-frontend",
            "metric_name": "http.server.request.duration"
        },
        "sortfield": "time_unix",
        "sortorder": "DESC",
        "limit": 1
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "metric_name": "http.server.request.duration",
            "metric_unit": "s",
            "time_unix": "1790852390000000000",
            "count": "1842",
            "sum": "412.773",
            "min": "0.0061",
            "max": "1.098",
            "explicit_bounds": ["0.005", "0.05", "0.1", "0.25", "0.5", "1"],
            "bucket_counts": ["0", "211", "904", "512", "167", "41", "7"],
            "exemplars": [
                {
                    "traceid": "dee625f33cb0994e86c5cd4640e3b09c",
                    "spanid": "3f8b2c6d1e9a7054",
                    "value": "1.098",
                    "time_unix": "1790850513439147623",
                    "filtered_attributes": {}
                }
            ]
        }
    ],
    "id": 1
}

関連項目

ソース

ui/include/classes/api/services/CApmMetric.php の CApmMetric::get()。