appStatsの概要
appStats APIはアプリケーションアナリティクス画面に基づいており、ソース、宛先、アプリケーションなどによる時間範囲の集計ネットワークデータを提供します。
各クエリは、特定の集計関数(合計、最大、平均など)と異なる次元(サイト名、ユーザー、アプリなど)に基づく集計を計算します(バイトアップ、バイトダウン、フローの数など)。
appStatsクエリの使用例:
特定サイトの全体/平均/最大帯域幅を計算する
特定の宛先に生成された最大フロー数
特定のホストによる使用数が多いアプリケーショントップ10
appStatsの引数
これは、クエリによって返されるデータを定義するために渡すことができる引数です(すべてのフィールドは必須です):
accountIDs
measures
フィルタ
dimension
並べ替え
期限
appStats accountIDs 引数
クエリが返すデータのために1つ以上のアカウントIDを入力してください。
このアカウントIDはCato管理アプリケーションには表示されませんが、Cato管理アプリケーションのURLでの番号です。 たとえば、次のURLにおけるアカウントIDは26です:https://cc.catonetworks.com/#!/26/topology
appStatsフィルタ引数
フィルタ引数は、クエリに含まれる特定のデータを定義します。 これは、定義できる引数です:
fieldName - フィルタしたいフィールドのタイプを定義する(詳しくは、以下のappStatsフィールドを参照)
operator - フィルタ値を活性化する方法を定義する(詳しくは、以下のappStats filterOperatorを参照)
values - オペレータと一緒に使用するフィルタ値を定義する
次のフィルタ構文は、特定のアプリケーションにデータを表示するためにフィルタされたクエリの例です:
"フィルタ": [ { "fieldName": "application", "operator": "is", "values": [ "Slack" ] } ]appStats寸法引数
寸法引数を使用して、同じ値を持つフィールドをサマリ行にグループ化します。
次の例は、サイト名に基づいてフィールドをグループ化します:
"寸法": [ { "fieldName": "site_name" } ]appStats測定引数
測定値引数は、クエリが返すフィールドとその集約タイプを定義します。 定義できる引数は次のとおりです:
fieldName -フィルタしたいフィールドのタイプを定義する(詳しくは、以下のappStats Fieldsを参照)
aggType - 集約タイプを定義する(詳しくは、以下のappStats Aggregationを参照)
次の例は、Slackアプリケーションで作成されたフローのサマリを測定するための測定値構文を示しています:
"フィルタ": [ { "fieldName": "application", "operator": "is", "values": [ "Slack" ] } ] "測定値":[ { "fieldName": "flows_created", "aggType": "sum" }, ]
appStats並べ替え引数
並べ替え引数は、データの並び替え方法を定義します。
次の例は、Slackアプリケーションで作成されたフローのサマリを測定するための並べ替え構文を示しています。 その後、作成されたフローの降順でデータを並べ替えます:
"フィルタ": [ { "fieldName": "application", "operator": "is", "values": [ "Slack" ] } ] "測定値": [ { "fieldName": "flows_created", "aggType": "sum" }, ] "並べ替え": [ { "fieldName": "flows_created", "order": "dec" }, ]
appStarts 時間枠引数
クエリの時間枠を定義します。
"timeFrame": "last.P2D"サンプル appStats クエリ
これは、Slackアプリケーションの各サイトにおける過去2日間の期間で作成されたフローの合計を返すためにappStats APIクエリを使用する例です。 データはトップ5サイトの順に降順でソートされます。
サンプルクエリ
query appStats($accountID: ID!, $measures: [Measure], $dimensions: [Dimension], $filters: [AppStatsFilter!], $sort: [AppStatsSort!], $timeFrame: TimeFrame!, $limit: Int, $from: Int) { appStats( accountID: $accountID timeFrame: $timeFrame measures: $measures dimensions: $dimensions filters: $filters sort: $sort ) { id records(limit: $limit, from: $from) { fieldsUnitTypes fieldsMap trends } } }
変数値
{ "accountID": "1234", "dimensions": [ { "fieldName": "site_name" } ], "測定値": [ { "fieldName": "flows_created", "aggType": "sum" }, ], "フィルタ": [ { "fieldName": "application", "operator": "is", "values": [ "Slack" ] } ] "並べ替え": [ { "fieldName": "flows_created", "order": "desc" } ], "timeFrame": "last.P2D", "limit": 5, "from": 0 }
サンプルAppStats出力
{ "data": { "appStats": { "id": "1234", "records": [ { "fieldsMap": { "flows_created": "116660", "site_name": "Sample Socket" } }, { "fieldsMap": { "flows_created": "105655", "site_name": " Sample Socket 2" } } ] } } }appStats フィールド
これは、appStatsクエリ内のフィールドの説明です。
アイテム | 説明 |
|---|---|
アプリケーション | クラウドアプリケーション名 |
new_app | 最新のクラウドアプリケーション識別子 |
discovered_app | 使用されているアプリの総数 |
トラフィック | 上流データと下流データの合計バイト数 |
上り | クラウドアプリケーションへのアップロードデータ |
下り | クラウドアプリケーションからのダウンロードデータ |
risk_score | Catoによって割り当てられたアプリケーションリスクスコア |
risk_level | アプリケーションのリスクレベル |
承認済み | 組織により使用が承認され、管理されているクラウドアプリケーション |
hq_location | 登録アプリケーションの本社が所在する国 |
is_cloud_app | アプリケーションがクラウドアプリ/SaaSアプリとみなされるかどうかを示します |
カテゴリ | クラウドアプリケーションカテゴリ |
説明 | カテゴリの説明 |
IP | ホストまたはSDPクライアントのIP |
サブネット | サブネットの名前 |
ドメイン | SSL SNI、HTTPホスト名、DNS名、または宛先IP |
dest_ip | サーバーIPアドレス(WAN接続の場合のみ関連) |
src_site_id | サイトの内部Cato ID |
src_site_name | ソースサイトまたはSDPユーザー |
site_country | サイトの所在国 |
site_state | サイトの所在州 |
vpn_user_id | SDPユーザーの内部Cato ID |
flows_created | 作成された接続数 |
dest_site | 宛先サイトまたはSDPユーザーID(proto) |
dest_is_site_or_vpn | 宛先サイトまたはSDPユーザー |
dest_site_id | 宛先サイトまたはSDPユーザーID(DB) |
dest_site_name | 宛先サイトまたはSDPユーザ名 |
traffic_direction | トラフィックの方向 |
device_name | PCまたはデバイス名 |
ad_name | Active Directory 名 |
src_ip | ホストまたはSDPクライアントのIP |
ソケットインタフェース | ソケットインタフェースの名前 |
src_is_site_or_vpn | トラフィックはサイトまたはSDPクライアント |
appStats 集計
これはappStats 集計タイプの値です:
合計
数
distinct_count
distinct
平均
最大値
最小
全て
appStats フィルタ演算子
これはappStats フィルタ演算子の値です:
該当
非該当
含む
非含む
存在する
非存在
範囲内
範囲外
gt
gte
lt
lte