- JSON representation
- ReportRequest
- Operation
- MetricValueSet
- MetricValue
- Distribution
- LinearBuckets
- ExponentialBuckets
- ExplicitBuckets
- Exemplar
- Money
- LogEntry
- HttpRequest
- LogEntryOperation
- LogEntrySourceLocation
- QuotaProperties
- ResourceInfo
- TraceSpan
- Attributes
Message for reporting billing requests through Eventstream.
JSON representation | |
---|---|
{
"reportRequests": [
{
object ( |
Fields | |
---|---|
reportRequests[] |
Billing requests to be reported for cloud.eventstream.v2.ResourceEvent Each request contains billing operations to be reported under a service name. See go/billing-view-construction for documentation on constructing billing view report requests. |
ReportRequest
Request message for the services.report method.
JSON representation | |
---|---|
{
"serviceName": string,
"operations": [
{
object ( |
Fields | |
---|---|
serviceName |
The service name as specified in its service configuration. For example, See google.api.Service for the definition of a service name. |
operations[] |
Operations to be reported. Typically the service should report one operation per request. Putting multiple operations into a single request is allowed, but should be used only when multiple operations are natually available at the time of the report. There is no limit on the number of operations in the same ReportRequest, however the ReportRequest size should be no larger than 1MB. See |
serviceConfigId |
Specifies which version of service config should be used to process the request. If unspecified or no matching version can be found, the latest one will be used. |
Operation
Represents information regarding an operation.
JSON representation | |
---|---|
{ "operationId": string, "operationName": string, "consumerId": string, "startTime": string, "endTime": string, "labels": { string: string, ... }, "metricValueSets": [ { object ( |
Fields | |
---|---|
operationId |
Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls services.check() and services.report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details. |
operationName |
Fully qualified name of the operation. Reserved for future use. |
consumerId |
Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer.
|
startTime |
Required. Start time of the operation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
End time of the operation. Required when the operation is used in A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Labels describing the operation. Only the following labels are allowed:
An object containing a list of |
metricValueSets[] |
Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error. |
logEntries[] |
Represents information to be logged. |
quotaProperties |
Represents the properties needed for quota check. Applicable only if this operation is for a quota check request. If this is not specified, no quota check will be performed. |
importance |
DO NOT USE. This is an experimental field. |
userLabels |
User defined labels for the resource that this operation is associated with. Only a combination of 1000 user labels per consumer project are allowed. An object containing a list of |
resources[] |
The resources that are involved in the operation. The maximum supported number of entries in this field is 100. |
traceSpans[] |
Unimplemented. A list of Cloud Trace spans. The span names shall contain the id of the destination project which can be either the produce or the consumer project. |
extensions[] |
Unimplemented. An object containing fields of an arbitrary type. An additional field |
MetricValueSet
Represents a set of metric values in the same metric. Each metric value in the set should have a unique combination of start time, end time, and label values.
JSON representation | |
---|---|
{
"metricName": string,
"metricValues": [
{
object ( |
Fields | |
---|---|
metricName |
The metric name defined in the service configuration. |
metricValues[] |
The values in this metric. |
MetricValue
Represents a single metric value.
JSON representation | |
---|---|
{ "labels": { string: string, ... }, "startTime": string, "endTime": string, // Union field |
Fields | ||
---|---|---|
labels |
The labels describing the metric value. See comments on An object containing a list of |
|
startTime |
The start of the time period over which this metric value's measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details. If not specified, A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
|
endTime |
The end of the time period over which this metric value's measurement applies. If not specified, A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
|
Union field value . The value. The type of value used in the request must agree with the metric definition in the service configuration, otherwise the MetricValue is rejected. value can be only one of the following: |
||
boolValue |
A boolean value. |
|
int64Value |
A signed 64-bit integer value. |
|
doubleValue |
A double precision floating point value. |
|
stringValue |
A text string value. |
|
distributionValue |
A distribution value. |
|
moneyValue |
A money value. |
Distribution
Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information:
- the arithmetic mean of the samples
- the minimum and maximum of the samples
- the sum-squared-deviation of the samples, used to compute variance
- a histogram of the values of the sample points
JSON representation | |
---|---|
{ "count": string, "mean": number, "minimum": number, "maximum": number, "sumOfSquaredDeviation": number, "bucketCounts": [ string ], "exemplars": [ { object ( |
Fields | ||
---|---|---|
count |
The total number of samples in the distribution. Must be >= 0. |
|
mean |
The arithmetic mean of the samples in the distribution. If |
|
minimum |
The minimum of the population of values. Ignored if |
|
maximum |
The maximum of the population of values. Ignored if |
|
sumOfSquaredDeviation |
The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If |
|
bucketCounts[] |
The number of samples in each histogram bucket. The buckets are defined below in Any suffix of trailing zeros may be omitted. |
|
exemplars[] |
Example points. Must be in increasing order of |
|
Union field Buckets are numbered in the range of [0, N], with a total of N+1 buckets. There must be at least two buckets (a single-bucket histogram gives no information that isn't already provided by The first bucket is the underflow bucket which has a lower bound of -inf. The last bucket is the overflow bucket which has an upper bound of +inf. All other buckets (if any) are called "finite" buckets because they have finite lower and upper bounds. As described below, there are three ways to define the finite buckets. (1) Buckets with constant width. (2) Buckets with exponentially growing widths. (3) Buckets with arbitrary user-provided widths. In all cases, the buckets cover the entire real number line (-inf, +inf). Bucket upper bounds are exclusive and lower bounds are inclusive. The upper bound of the underflow bucket is equal to the lower bound of the smallest finite bucket; the lower bound of the overflow bucket is equal to the upper bound of the largest finite bucket. |
||
linearBuckets |
Buckets with constant width. |
|
exponentialBuckets |
Buckets with exponentially growing width. |
|
explicitBuckets |
Buckets with arbitrary user-provided width. |
LinearBuckets
Describing buckets with constant width.
JSON representation | |
---|---|
{ "numFiniteBuckets": integer, "width": number, "offset": number } |
Fields | |
---|---|
numFiniteBuckets |
The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is |
width |
The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to numFiniteBuckets, inclusive. Must be strictly positive. |
offset |
The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to numFiniteBuckets, inclusive. |
ExponentialBuckets
Describing buckets with exponentially growing width.
JSON representation | |
---|---|
{ "numFiniteBuckets": integer, "growthFactor": number, "scale": number } |
Fields | |
---|---|
numFiniteBuckets |
The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is |
growthFactor |
The i'th exponential bucket covers the interval [scale * growthFactor^(i-1), scale * growthFactor^i) where i ranges from 1 to numFiniteBuckets inclusive. Must be larger than 1.0. |
scale |
The i'th exponential bucket covers the interval [scale * growthFactor^(i-1), scale * growthFactor^i) where i ranges from 1 to numFiniteBuckets inclusive. Must be > 0. |
ExplicitBuckets
Describing buckets with arbitrary user-provided width.
JSON representation | |
---|---|
{ "bounds": [ number ] } |
Fields | |
---|---|
bounds[] |
'bound' is a list of strictly increasing boundaries between buckets. Note that a list of length N-1 defines N buckets because of fenceposting. See comments on The i'th finite bucket covers the interval [bound[i-1], bound[i]) where i ranges from 1 to bound_size() - 1. Note that there are no finite buckets at all if 'bound' only contains a single element; in that special case the single bound defines the boundary between the underflow and overflow buckets. bucket number lower bound upper bound i == 0 (underflow) -inf bound[i] 0 < i < bound_size() bound[i-1] bound[i] i == bound_size() (overflow) bound[i-1] +inf |
Exemplar
Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
JSON representation | |
---|---|
{ "value": number, "timestamp": string, "attachments": [ { "@type": string, field1: ..., ... } ] } |
Fields | |
---|---|
value |
Value of the exemplar point. This value determines to which bucket the exemplar belongs. |
timestamp |
The observation (sampling) time of the above value. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
attachments[] |
Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. An object containing fields of an arbitrary type. An additional field |
Money
Represents an amount of money with its currency type.
JSON representation | |
---|---|
{ "currencyCode": string, "units": string, "nanos": integer } |
Fields | |
---|---|
currencyCode |
The three-letter currency code defined in ISO 4217. |
units |
The whole units of the amount. For example if |
nanos |
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If |
LogEntry
An individual log entry.
JSON representation | |
---|---|
{ "name": string, "timestamp": string, "severity": enum ( |
Fields | ||
---|---|---|
name |
Required. The log to which this log entry belongs. Examples: |
|
timestamp |
The time the event described by the log entry occurred. If omitted, defaults to operation start time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
|
severity |
The severity of the log entry. The default value is |
|
httpRequest |
Optional. Information about the HTTP request associated with this log entry, if applicable. |
|
trace |
Optional. Resource name of the trace associated with the log entry, if any. If this field contains a relative resource name, you can assume the name is relative to |
|
insertId |
A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operationId. |
|
labels |
A set of user-defined (key, value) data that provides additional information about the log entry. An object containing a list of |
|
operation |
Optional. Information about an operation associated with the log entry, if applicable. |
|
sourceLocation |
Optional. Source code location information associated with the log entry, if any. |
|
Union field payload . The log entry payload, which can be one of multiple types. payload can be only one of the following: |
||
protoPayload |
The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is [AuditLog][google.cloud.audit.AuditLog]. An object containing fields of an arbitrary type. An additional field |
|
textPayload |
The log entry payload, represented as a Unicode string (UTF-8). |
|
structPayload |
The log entry payload, represented as a structure that is expressed as a JSON object. |
HttpRequest
A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.
JSON representation | |
---|---|
{ "requestMethod": string, "requestUrl": string, "requestSize": string, "status": integer, "responseSize": string, "userAgent": string, "remoteIp": string, "serverIp": string, "referer": string, "latency": string, "cacheLookup": boolean, "cacheHit": boolean, "cacheValidatedWithOriginServer": boolean, "cacheFillBytes": string, "protocol": string } |
Fields | |
---|---|
requestMethod |
The request method. Examples: |
requestUrl |
The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: |
requestSize |
The size of the HTTP request message in bytes, including the request headers and the request body. |
status |
The response code indicating the status of the response. Examples: 200, 404. |
responseSize |
The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body. |
userAgent |
The user agent sent by the client. Example: |
remoteIp |
The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: |
serverIp |
The IP address (IPv4 or IPv6) of the origin server that the request was sent to. |
referer |
The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions. |
latency |
The request processing latency on the server, from the time the request was received until the response was sent. A duration in seconds with up to nine fractional digits, terminated by ' |
cacheLookup |
Whether or not a cache lookup was attempted. |
cacheHit |
Whether or not an entity was served from cache (with or without validation). |
cacheValidatedWithOriginServer |
Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if |
cacheFillBytes |
The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted. |
protocol |
Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket" |
LogEntryOperation
Additional information about a potentially long-running operation with which a log entry is associated.
JSON representation | |
---|---|
{ "id": string, "producer": string, "first": boolean, "last": boolean } |
Fields | |
---|---|
id |
Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation. |
producer |
Optional. An arbitrary producer identifier. The combination of |
first |
Optional. Set this to True if this is the first log entry in the operation. |
last |
Optional. Set this to True if this is the last log entry in the operation. |
LogEntrySourceLocation
Additional information about the source code location that produced the log entry.
JSON representation | |
---|---|
{ "file": string, "line": string, "function": string } |
Fields | |
---|---|
file |
Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name. |
line |
Optional. Line within the source file. 1-based; 0 indicates no line number available. |
function |
Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: |
QuotaProperties
Represents the properties needed for quota operations.
JSON representation | |
---|---|
{
"quotaMode": enum ( |
Fields | |
---|---|
quotaMode |
Quota mode for this operation. |
ResourceInfo
Describes a resource associated with this operation.
JSON representation | |
---|---|
{ "resourceContainer": string, "resourceName": string, "resourceLocation": string } |
Fields | |
---|---|
resourceContainer |
The identifier of the parent of this resource instance. Must be in one of the following formats: - |
resourceName |
Name of the resource. This is used for auditing purposes. |
resourceLocation |
The location of the resource. If not empty, the resource will be checked against location policy. The value must be a valid zone, region or multiregion. For example: "europe-west4" or "northamerica-northeast1-a" |
TraceSpan
A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous—there may be gaps or overlaps between spans in a trace.
JSON representation | |
---|---|
{ "name": string, "spanId": string, "parentSpanId": string, "displayName": { object ( |
Fields | |
---|---|
name |
The resource name of the span in the following format:
[TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. |
spanId |
The [SPAN_ID] portion of the span's resource name. |
parentSpanId |
The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty. |
displayName |
A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces. |
startTime |
The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
attributes |
A set of attributes on the span. You can have up to 32 attributes per span. |
status |
An optional final status for this span. |
sameProcessAsParentSpan |
(Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information. |
childSpanCount |
An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. |
spanKind |
Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using |
Attributes
A set of attributes, each in the format [KEY]:[VALUE]
.
JSON representation | |
---|---|
{
"attributeMap": {
string: {
object ( |
Fields | |
---|---|
attributeMap |
The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values
An object containing a list of |
droppedAttributesCount |
The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. |