Operation

Represents information regarding an operation.

JSON representation
{
  "operationId": string,
  "operationName": string,
  "consumerId": string,
  "startTime": string,
  "endTime": string,
  "labels": {
    string: string,
    ...
  },
  "metricValueSets": [
    {
      object (MetricValueSet)
    }
  ],
  "logEntries": [
    {
      object (LogEntry)
    }
  ],
  "importance": enum (Importance),
  "traceSpans": [
    {
      object (TraceSpan)
    }
  ]
}
Fields
operationId

string

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

string

Fully qualified name of the operation. Reserved for future use.

consumerId

string

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.

  • This can be in one of the following formats:
    • project:PROJECT_ID,
    • project_number:PROJECT_NUMBER,
    • projects/PROJECT_ID or PROJECT_NUMBER,
    • folders/FOLDER_NUMBER,
    • organizations/ORGANIZATION_NUMBER,
    • api_key:API_KEY.
startTime

string (Timestamp format)

Required. Start time of the operation.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Labels describing the operation. Only the following labels are allowed:

  • Labels describing monitored resources as defined in the service configuration.
  • Default labels of metric values. When specified, labels defined in the metric value override these default.
  • The following labels defined by Google Cloud Platform:
    • cloud.googleapis.com/location describing the location where the operation happened,
    • servicecontrol.googleapis.com/userAgent describing the user agent of the API request,
    • servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
    • servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

metricValueSets[]

object (MetricValueSet)

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[]

object (LogEntry)

Represents information to be logged.

importance

enum (Importance)

DO NOT USE. This is an experimental field.

traceSpans[]

object (TraceSpan)

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.

LogEntry

An individual log entry.

JSON representation
{
  "name": string,
  "timestamp": string,
  "severity": enum (LogSeverity),
  "httpRequest": {
    object (HttpRequest)
  },
  "trace": string,
  "insertId": string,
  "labels": {
    string: string,
    ...
  },
  "operation": {
    object (LogEntryOperation)
  },
  "sourceLocation": {
    object (LogEntrySourceLocation)
  },

  // Union field payload can be only one of the following:
  "protoPayload": {
    "@type": string,
    field1: ...,
    ...
  },
  "textPayload": string,
  "structPayload": {
    object
  }
  // End of list of possible types for union field payload.
}
Fields
name

string

Required. The log to which this log entry belongs. Examples: "syslog", "book_log".

timestamp

string (Timestamp format)

The time the event described by the log entry occurred. If omitted, defaults to operation start time.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

severity

enum (LogSeverity)

The severity of the log entry. The default value is LogSeverity.DEFAULT.

httpRequest

object (HttpRequest)

Optional. Information about the HTTP request associated with this log entry, if applicable.

trace

string

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 //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824

insertId

string

A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operationId.

labels

map (key: string, value: string)

A set of user-defined (key, value) data that provides additional information about the log entry.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

operation

object (LogEntryOperation)

Optional. Information about an operation associated with the log entry, if applicable.

sourceLocation

object (LogEntrySourceLocation)

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

object

The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is AuditLog.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

textPayload

string

The log entry payload, represented as a Unicode string (UTF-8).

structPayload

object (Struct format)

The log entry payload, represented as a structure that is expressed as a JSON object.

LogSeverity

The severity of the event described in a log entry, expressed as one of the standard severity levels listed below. For your reference, the levels are assigned the listed numeric values. The effect of using numeric values other than those listed is undefined.

You can filter for log entries by severity. For example, the following filter expression will match log entries with severities INFO, NOTICE, and WARNING:

severity > DEBUG AND severity <= WARNING

If you are writing log entries, you should map other severity encodings to one of these standard levels. For example, you might map all of Java's FINE, FINER, and FINEST levels to LogSeverity.DEBUG. You can preserve the original severity level in the log entry payload if you wish.

Enums
DEFAULT (0) The log entry has no assigned severity level.
DEBUG (100) Debug or trace information.
INFO (200) Routine information, such as ongoing status or performance.
NOTICE (300) Normal but significant events, such as start up, shut down, or a configuration change.
WARNING (400) Warning events might cause problems.
ERROR (500) Error events are likely to cause problems.
CRITICAL (600) Critical events cause more severe problems or outages.
ALERT (700) A person must take an action immediately.
EMERGENCY (800) One or more systems are unusable.

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

string

The request method. Examples: "GET", "HEAD", "PUT", "POST".

requestUrl

string

The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: "http://example.com/some/info?color=red".

requestSize

string (int64 format)

The size of the HTTP request message in bytes, including the request headers and the request body.

status

integer

The response code indicating the status of the response. Examples: 200, 404.

responseSize

string (int64 format)

The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.

userAgent

string

The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)".

remoteIp

string

The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329".

serverIp

string

The IP address (IPv4 or IPv6) of the origin server that the request was sent to.

referer

string

The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.

latency

string (Duration format)

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 's'. Example: "3.5s".

cacheLookup

boolean

Whether or not a cache lookup was attempted.

cacheHit

boolean

Whether or not an entity was served from cache (with or without validation).

cacheValidatedWithOriginServer

boolean

Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cacheHit is True.

cacheFillBytes

string (int64 format)

The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.

protocol

string

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

string

Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.

producer

string

Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", "github.com/MyProject/MyApplication".

first

boolean

Optional. Set this to True if this is the first log entry in the operation.

last

boolean

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

string

Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.

line

string (int64 format)

Optional. Line within the source file. 1-based; 0 indicates no line number available.

function

string

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: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).

Importance

Defines the importance of the data contained in the operation.

Enums
LOW The API implementation may cache and aggregate the data. The data may be lost when rare and unexpected system failures occur.
HIGH The API implementation doesn't cache and aggregate the data. If the method returns successfully, it's guaranteed that the data has been persisted in durable storage.

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 (TruncatableString)
  },
  "startTime": string,
  "endTime": string,
  "attributes": {
    object (Attributes)
  },
  "status": {
    object (Status)
  },
  "sameProcessAsParentSpan": boolean,
  "childSpanCount": integer,
  "spanKind": enum (SpanKind)
}
Fields
name

string

The resource name of the span in the following format:

projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]

[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

string

The [SPAN_ID] portion of the span's resource name.

parentSpanId

string

The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.

displayName

object (TruncatableString)

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

string (Timestamp format)

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, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

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, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

attributes

object (Attributes)

A set of attributes on the span. You can have up to 32 attributes per span.

status

object (Status)

An optional final status for this span.

sameProcessAsParentSpan

boolean

(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

integer

An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.

spanKind

enum (SpanKind)

Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using CLIENT (caller) and SERVER (callee) to identify an RPC call.

TruncatableString

Represents a string that might be shortened to a specified length.

JSON representation
{
  "value": string,
  "truncatedByteCount": integer
}
Fields
value

string

The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then value contains the first 128 bytes of the 500-byte string.

Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.

truncatedByteCount

integer

The number of bytes removed from the original string. If this value is 0, then the string was not shortened.

Attributes

A set of attributes, each in the format [KEY]:[VALUE].

JSON representation
{
  "attributeMap": {
    string: {
      object(AttributeValue)
    },
    ...
  },
  "droppedAttributesCount": integer
}
Fields
attributeMap

map (key: string, value: object (AttributeValue))

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 true and false. For example:

"/instance_id": "my-instance"
"/http/userAgent": ""
"/http/request_bytes": 300
"abc.com/myattribute": true

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

droppedAttributesCount

integer

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.

SpanKind

Type of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship.

Enums
SPAN_KIND_UNSPECIFIED Unspecified. Do NOT use as default. Implementations MAY assume SpanKind.INTERNAL to be default.
INTERNAL Indicates that the span is used internally. Default value.
SERVER Indicates that the span covers server-side handling of an RPC or other remote network request.
CLIENT Indicates that the span covers the client-side wrapper around an RPC or other remote request.
PRODUCER Indicates that the span describes producer sending a message to a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans (e.g. publishing a message to a pubsub service).
CONSUMER Indicates that the span describes consumer receiving a message from a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans (e.g. receiving a message from a pubsub service subscription).