Package google.api

索引

分布

Distribution には、値の母集団の要約統計量が含まれます。必要に応じて、これらの値の分布をバケットのセット全体で表すヒストグラムが含まれます。

要約統計量は、カウント、平均、平均からの 2 乗偏差の合計、最小値、値の母集団の集合の最大値です。ヒストグラムはバケットの配列に基づいており、各バケットに入る分類値のカウントをもたらします。バケットの境界は、明示的に指定するか、バケットの幅が一定または指数関数的に増加する式で指定します。

禁止されてはいませんが、値の母集団に非有限値（無限大または NaN）を含めると、mean と sum_of_squared_deviation が無意味なフィールドになるため、一般的におすすめできません。

フィールド
count

int64

値の母集団の数。負の値は使用できません。ヒストグラムが指定されている場合、この値は bucket_counts の値の合計と等しくする必要があります。
mean

double

値の母集団の算術平均値。count が 0 の場合は、このフィールドも 0 にする必要があります。
sum_of_squared_deviation

double

値の母集団の平均値からの偏差の平方和。x_i 値では、次になります。

Sum[i=1..n]((x_i - mean)^2)

Knuth の『The Art of Computer Programming』、Vol. 2、232 ページ、第 3 版では、1 回のパスでこの合計値を蓄積するためのウェルフォードの方法を記載しています。

count が 0 の場合は、このフィールドも 0 にする必要があります。
range

Range

指定された場合、値の母集団の範囲が含まれます。count がゼロの場合、フィールドは存在することはできません。
bucket_options

BucketOptions

ヒストグラムのバケットの境界を定義します。分布にヒストグラムが含まれていない場合は、このフィールドを省略します。
bucket_counts[]

int64

ヒストグラムの各バケット内の値の数（bucket_options を参照）。分布にヒストグラムがない場合は、このフィールドを省略します。ヒストグラムがある場合、bucket_counts の値の合計は、分布の count フィールドの値と等しくする必要があります。

存在する場合、bucket_counts には N 個の値が含まれます。ここで、N は bucket_options で指定されたバケット数です。N 個未満の値を指定した場合、残りの値は 0 とみなされます。

bucket_counts の値の順序は、3 つのバケットタイプに定義したバケット番号付けスキームに従います。最初の値は、アンダーフロー バケットのカウント（0）にします。次の N-2 個の値は有限バケットの数（1～N-2）です。bucket_counts の N 番目の値は、オーバーフロー バケット（番号 N-1）のカウントです。
exemplars[]

Exemplar

value フィールドの昇順で並べ替える必要があります。

BucketOptions

BucketOptions は、分布のヒストグラムの作成に使用されるバケット境界を表します。バケットは、線形シーケンスまたは指数シーケンスにできます。また、各バケットを明示的に指定することもできます。BucketOptions には、各バケットの値の数は含まれません。

バケットには、そのバケットにカウントされる値の包括的下限と排他的上限があります。バケットの上限は下限よりも大きくする必要があります。分布の N 個のバケットのシーケンスは、アンダーフロー バケット（番号 0）、ゼロ以上の有限バケット（番号 1 から N - 2 ）、オーバーフロー バケット（番号 N - 1）で構成されています。バケットは連続しています。i バケットの下限 i（i > 0）は、i - 1 バケットの上限と同じです。バケットは有限の値の全範囲に及びます。アンダーフロー バケットの下限は -infinity、オーバーフロー バケットの上限は +infinity です。有限のバケットは両方の境界が有限です。

フィールド
共用体フィールド options。これらの 3 つのフィールドのいずれかを設定する必要があります。options は次のいずれかになります。
linear_buckets

Linear

線形バケット。
exponential_buckets

Exponential

指数関数的バケット。
explicit_buckets

Explicit

明示的なバケット。

明示

任意の幅のバケットのセットを指定します。

size(bounds) + 1（= N）個のバケットがあります。バケット i には次の境界があります。

上限（0 <= i < N-1）: 境界 [i] 下限（1 <= i < N）; 境界 [i - 1]

bounds フィールドには、少なくとも 1 つの要素を含める必要があります。bounds に要素が 1 つしかない場合、有限バケットはなく、その要素がオーバーフロー バケットとアンダーフロー バケットの共通の境界になります。

フィールド
bounds[]

double

値は単調に増加しなければなりません。

指数

下限の値に比例する幅を持つ指数関数的なバケット シーケンスを指定します。各バケットは、バケット内の特定の値に一定の相対的な不確実性を表します。

num_finite_buckets + 2（= N）個のバケットがあります。バケット i には次の境界があります。

上限（0 <= i < N-1）: スケール × (growth_factor ^ i)。

下限（1 <= i < N）: スケール × (growth_factor ^ (i - 1))。

フィールド
num_finite_buckets

int32

0 より大きくする必要があります。
growth_factor

double

1 より大きくする必要があります。
scale

double

0 より大きくする必要があります。

線形

すべて同じ幅（オーバーフローおよびアンダーフローを除く）のバケットの線形シーケンスを指定します。各バケットは、バケット内の特定の値で一定の絶対的な不確実性を表します。

num_finite_buckets + 2（= N）個のバケットがあります。バケット i には次の境界があります。

上限（0 <= i < N-1）: オフセット + (幅 × i)。

下限（1 <= i < N）: オフセット + (幅 × (i - 1))。

フィールド
num_finite_buckets

int32

0 より大きくする必要があります。
width

double

0 より大きくする必要があります。
offset

double

最初のバケットの下限。

エグザンプラ

エグザンプラは、集計された分布値にアノテーションを付けるために使用できるサンプル ポイントです。これらは、値が追加されたときにアクティブだったトレース ID など、分布バケットに追加された特定の値に関する情報を提供するメタデータです。サンプル値、タイムスタンプ、送信元などの追加情報が含まれる場合があります。

フィールド
value

double

エグザンプラ ポイントの値。この値は、エグザンプラがどのバケットに属するかを決定します。
timestamp

Timestamp

上記の値の観測（サンプリング）時間。
attachments[]

Any

サンプル値に関するコンテキスト情報。例:

トレース: type.googleapis.com/google.monitoring.v3.SpanContext

リテラル文字列: type.googleapis.com/google.protobuf.StringValue

集計中にドロップされたラベル: type.googleapis.com/google.monitoring.v3.DroppedLabels

1 つのメッセージの種類につき、1 つのエグザンプラに 1 つのアタッチメントしか存在できません。これはシステムによって強制されます。

範囲

値の母集団の範囲。

フィールド
min

double

値の母集団の最小値。
max

double

値の母集団の最大値。

HttpBody

任意の HTTP 本文を表すメッセージ。RAW バイナリや HTML ページなど、JSON として表現できないペイロード形式にのみ使用する必要があります。

このメッセージは、リクエストとレスポンスのストリーミングと非ストリーミング両方の API メソッドで使用できます。

最上位レベルのリクエスト フィールドとして使用でき、URL または HTTP テンプレートからリクエスト フィールドにパラメータを抽出する場合や、RAW HTTP 本文にアクセスする場合にも便利です。

例:

message GetResourceRequest {
  // A unique request id.
  string request_id = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

ストリーミング メソッドの例:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

このタイプを使用すると、リクエストとレスポンスの本文の処理方法のみ変更され、他のすべての機能は未変更のまま動作を継続します。

フィールド
content_type

string

本文のコンテンツ タイプを指定する HTTP Content-Type ヘッダー値。
data

bytes

未加工のバイナリとしての HTTP リクエスト / レスポンスの本文。
extensions[]

Any

アプリケーション固有のレスポンス メタデータ。ストリーミング API の最初のレスポンスで設定する必要があります。

指標

MetricDescriptor のすべてのラベルの値を指定して識別される特定の指標。

フィールド
type

string

既存の指標タイプ。google.api.MetricDescriptor をご覧ください。例: custom.googleapis.com/invoice/paid/amount
labels

map<string, string>

この指標を一意に識別するラベル値のセット。MetricDescriptor にリストされているすべてのラベルに値を割り当てる必要があります。

MetricDescriptor

この型にはフィールドがありません。

指標タイプとそのスキーマを定義します。作成された指標記述子を削除または変更すると、データ収集が停止し、その指標タイプの既存のデータが使用できなくなります。

MetricKind

測定の種類。データの報告方法について説明します。MetricKind に基づいて開始時間と終了時間を設定する方法については、TimeInterval をご覧ください。

列挙型
METRIC_KIND_UNSPECIFIED このデフォルト値は使用しないでください。
GAUGE 値の瞬時測定。
DELTA 時間間隔における値の変化。
CUMULATIVE 時間間隔にわたって累積された値。時系列内の累積測定は開始時刻が同じで、終了時間が増大します。その後、イベントにより累積値がゼロにリセットされ、次のポイントに新しい開始時間が設定されます。

ValueType

指標の値の型。

列挙値
VALUE_TYPE_UNSPECIFIED このデフォルト値は使用しないでください。
BOOL この値はブール値です。この値の型は、指標の種類が GAUGE の場合に限り、使用できます。
INT64 値は符号付き 64 ビット整数です。
DOUBLE 値は倍精度浮動小数点数です。
STRING 値はテキスト文字列です。この値の型は、指標の種類が GAUGE の場合に限り、使用できます。
DISTRIBUTION 値は Distribution です。
MONEY 値は金銭です。

MonitoredResource

モニタリング、ログ、課金、または他の目的で使用可能なリソースを表すオブジェクト。例として、仮想マシン インスタンス、データベース、およびディスクなどのストレージ デバイスがあります。type フィールドは、リソースのスキーマを記述する MonitoredResourceDescriptor オブジェクトを識別します。labels フィールドの情報は、スキーマに従って実際のリソースとその属性を識別します。たとえば、"gce_instance" の MonitoredResourceDescriptor に "project_id"、"instance_id"、"zone" のラベルがあるため、特定の Compute Engine VM インスタンスは次のオブジェクトで表すことができます。

{ "type": "gce_instance",
  "labels": { "project_id": "my-project",
              "instance_id": "12345678901234",
              "zone": "us-central1-a" }}
フィールド
type

string

必須。モニタリング対象リソースタイプ。このフィールドは、MonitoredResourceDescriptor オブジェクトの type フィールドと一致する必要があります。たとえば、Compute Engine VM インスタンスのタイプは gce_instance です。一部の記述子には、型にサービス名が含まれています。たとえば、Datastream ストリームの型は datastream.googleapis.com/Stream です。
labels

map<string, string>

必須。関連付けられたモニタリング対象リソース記述子に示されているすべてのラベルの値。たとえば、Compute Engine VM インスタンスはラベル "project_id"、"instance_id"、"zone" を使用します。

MonitoredResourceMetadata

MonitoredResource オブジェクトの補助メタデータ。MonitoredResource オブジェクトには、モニタリング対象リソース インスタンスを一意に識別するための最小限の情報が含まれています。他にも、有用な補助的メタデータがいくつかあります。モニタリングおよびロギングは、取り込みパイプラインを使用してあらゆるタイプのクラウド リソースのメタデータを抽出し、このメッセージにメタデータを保存します。

フィールド
system_labels

Struct

出力のみ。事前定義されたシステム メタデータ ラベルの値。システムラベルは、「machine_image」、「vpc」、「subnet_id」、「security_group」、「name」など、Google によって抽出されるメタデータです。システムラベルの値では、文字列、ブール値、または文字列のリストのみを使用できます。次に例を示します。

{ "name": "my-test-instance",
  "security_group": ["a", "b", "c"],
  "spot_instance": false }
user_labels

map<string, string>

出力のみ。ユーザー定義のメタデータ ラベルのマップ。