"description":"Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.\n",
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location":"query",
"type":"string"
},
"callback":{
"description":"JSONP",
"location":"query",
"type":"string"
},
"fields":{
"description":"Selector specifying which fields to include in a partial response.",
"location":"query",
"type":"string"
},
"key":{
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location":"query",
"type":"string"
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"location":"query",
"type":"string"
},
"prettyPrint":{
"default":"true",
"description":"Returns response with indentations and line breaks.",
"location":"query",
"type":"boolean"
},
"quotaUser":{
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location":"query",
"type":"string"
},
"uploadType":{
"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location":"query",
"type":"string"
},
"upload_protocol":{
"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location":"query",
"type":"string"
}
},
"protocol":"rest",
"resources":{
"projects":{
"resources":{
"traces":{
"methods":{
"batchWrite":{
"description":"Sends new spans to new or existing traces. You cannot update\nexisting spans.",
"description":"The resource name of the span in the following format:\n\n projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;\nit is a 32-character hexadecimal encoding of a 16-byte array.\n\n[SPAN_ID] is a unique identifier for a span within a trace; it\nis a 16-character hexadecimal encoding of an 8-byte array.",
"description":"The set of attributes. Each attribute's key can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, a signed 64-bit integer,\nor the Boolean values `true` and `false`. For example:\n\n \"/instance_id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes\": 300\n \"abc.com/myattribute\": true",
"description":"The number of attributes that were discarded. Attributes can be discarded\nbecause their keys are too long or because there are too many attributes.\nIf this value is 0 then all attributes are valid.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"BatchWriteSpansRequest":{
"description":"The request message for the `BatchWriteSpans` method.",
"id":"BatchWriteSpansRequest",
"properties":{
"spans":{
"description":"A list of new spans. The span names must not match existing\nspans, or the results are undefined.",
"items":{
"$ref":"Span"
},
"type":"array"
}
},
"type":"object"
},
"Empty":{
"description":"A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id":"Empty",
"properties":{},
"type":"object"
},
"Link":{
"description":"A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project.",
"id":"Link",
"properties":{
"attributes":{
"$ref":"Attributes",
"description":"A set of attributes on the link. You have have up to 32 attributes per\nlink."
},
"spanId":{
"description":"The [SPAN_ID] for a span within a trace.",
"type":"string"
},
"traceId":{
"description":"The [TRACE_ID] for a trace within a project.",
"type":"string"
},
"type":{
"description":"The relationship of the current span relative to the linked span.",
"enum":[
"TYPE_UNSPECIFIED",
"CHILD_LINKED_SPAN",
"PARENT_LINKED_SPAN"
],
"enumDescriptions":[
"The relationship of the two spans is unknown.",
"The linked span is a child of the current span.",
"The linked span is a parent of the current span."
],
"type":"string"
}
},
"type":"object"
},
"Links":{
"description":"A collection of links, which are references from this span to a span\nin the same or different trace.",
"id":"Links",
"properties":{
"droppedLinksCount":{
"description":"The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
"format":"int32",
"type":"integer"
},
"link":{
"description":"A collection of links.",
"items":{
"$ref":"Link"
},
"type":"array"
}
},
"type":"object"
},
"MessageEvent":{
"description":"An event describing a message sent/received between Spans.",
"id":"MessageEvent",
"properties":{
"compressedSizeBytes":{
"description":"The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.",
"format":"int64",
"type":"string"
},
"id":{
"description":"An identifier for the MessageEvent's message that can be used to match\nSENT and RECEIVED MessageEvents. It is recommended to be unique within\na Span.",
"format":"int64",
"type":"string"
},
"type":{
"description":"Type of MessageEvent. Indicates whether the message was sent or\nreceived.",
"enum":[
"TYPE_UNSPECIFIED",
"SENT",
"RECEIVED"
],
"enumDescriptions":[
"Unknown event type.",
"Indicates a sent message.",
"Indicates a received message."
],
"type":"string"
},
"uncompressedSizeBytes":{
"description":"The number of uncompressed bytes sent or received.",
"format":"int64",
"type":"string"
}
},
"type":"object"
},
"Module":{
"description":"Binary module.",
"id":"Module",
"properties":{
"buildId":{
"$ref":"TruncatableString",
"description":"A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)."
},
"module":{
"$ref":"TruncatableString",
"description":"For example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes)."
}
},
"type":"object"
},
"Span":{
"description":"A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\nthat describes the end-to-end latency, and one or more subspans for\nits sub-operations. A trace can also contain multiple root spans,\nor none at all. Spans do not need to be contiguous\u0026mdash;there may be\ngaps or overlaps between spans in a trace.",
"id":"Span",
"properties":{
"attributes":{
"$ref":"Attributes",
"description":"A set of attributes on the span. You can have up to 32 attributes per\nspan."
},
"childSpanCount":{
"description":"An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect missing child spans.",
"description":"A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\nGoogle Cloud Platform Console.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces."
"description":"The end time of the span. On the client side, this is the time kept by\nthe local machine where the span execution ends. On the server side, this\nis the time when the server application handler stops running.",
"format":"google-datetime",
"type":"string"
},
"links":{
"$ref":"Links",
"description":"Links associated with the span. You can have up to 128 links per Span."
},
"name":{
"description":"The resource name of the span in the following format:\n\n projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;\nit is a 32-character hexadecimal encoding of a 16-byte array.\n\n[SPAN_ID] is a unique identifier for a span within a trace; it\nis a 16-character hexadecimal encoding of an 8-byte array.",
"type":"string"
},
"parentSpanId":{
"description":"The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty.",
"type":"string"
},
"sameProcessAsParentSpan":{
"description":"(Optional) Set this parameter to indicate whether this span is in\nthe same process as its parent. If you do not set this parameter,\nStackdriver Trace is unable to take advantage of this helpful\ninformation.",
"type":"boolean"
},
"spanId":{
"description":"The [SPAN_ID] portion of the span's resource name.",
"type":"string"
},
"stackTrace":{
"$ref":"StackTrace",
"description":"Stack trace captured at the start of the span."
},
"startTime":{
"description":"The start time of the span. On the client side, this is the time kept by\nthe local machine where the span execution starts. On the server side, this\nis the time when the server's application handler starts running.",
"format":"google-datetime",
"type":"string"
},
"status":{
"$ref":"Status",
"description":"An optional final status for this span."
},
"timeEvents":{
"$ref":"TimeEvents",
"description":"A set of time events. You can have up to 32 annotations and 128 message\nevents per span."
}
},
"type":"object"
},
"StackFrame":{
"description":"Represents a single stack frame in a stack trace.",
"id":"StackFrame",
"properties":{
"columnNumber":{
"description":"The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions.",
"format":"int64",
"type":"string"
},
"fileName":{
"$ref":"TruncatableString",
"description":"The name of the source file where the function call appears (up to 256\nbytes)."
},
"functionName":{
"$ref":"TruncatableString",
"description":"The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes)."
},
"lineNumber":{
"description":"The line number in `file_name` where the function call appears.",
"format":"int64",
"type":"string"
},
"loadModule":{
"$ref":"Module",
"description":"The binary module from where the code was loaded."
},
"originalFunctionName":{
"$ref":"TruncatableString",
"description":"An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes)."
},
"sourceVersion":{
"$ref":"TruncatableString",
"description":"The version of the deployed source code (up to 128 bytes)."
}
},
"type":"object"
},
"StackFrames":{
"description":"A collection of stack frames, which can be truncated.",
"id":"StackFrames",
"properties":{
"droppedFramesCount":{
"description":"The number of stack frames that were dropped because there\nwere too many stack frames.\nIf this value is 0, then no stack frames were dropped.",
"format":"int32",
"type":"integer"
},
"frame":{
"description":"Stack frames in this call stack.",
"items":{
"$ref":"StackFrame"
},
"type":"array"
}
},
"type":"object"
},
"StackTrace":{
"description":"A call stack appearing in a trace.",
"id":"StackTrace",
"properties":{
"stackFrames":{
"$ref":"StackFrames",
"description":"Stack frames in this stack trace. A maximum of 128 frames are allowed."
},
"stackTraceHashId":{
"description":"The hash ID is used to conserve network bandwidth for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurrence of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSubsequent spans within the same request can refer\nto that stack trace by only setting `stackTraceHashId`.",
"format":"int64",
"type":"string"
}
},
"type":"object"
},
"Status":{
"description":"The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"id":"Status",
"properties":{
"code":{
"description":"The status code, which should be an enum value of google.rpc.Code.",
"format":"int32",
"type":"integer"
},
"details":{
"description":"A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items":{
"additionalProperties":{
"description":"Properties of the object. Contains field @type with type URL.",
"type":"any"
},
"type":"object"
},
"type":"array"
},
"message":{
"description":"A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type":"string"
}
},
"type":"object"
},
"TimeEvent":{
"description":"A time-stamped annotation or message event in the Span.",
"id":"TimeEvent",
"properties":{
"annotation":{
"$ref":"Annotation",
"description":"Text annotation with a set of attributes."
},
"messageEvent":{
"$ref":"MessageEvent",
"description":"An event describing a message sent/received between Spans."
},
"time":{
"description":"The timestamp indicating the time the event occurred.",
"format":"google-datetime",
"type":"string"
}
},
"type":"object"
},
"TimeEvents":{
"description":"A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation\non the span, consisting of either user-supplied key:value pairs, or\ndetails of a message sent/received between Spans.",
"id":"TimeEvents",
"properties":{
"droppedAnnotationsCount":{
"description":"The number of dropped annotations in all the included time events.\nIf the value is 0, then no annotations were dropped.",
"format":"int32",
"type":"integer"
},
"droppedMessageEventsCount":{
"description":"The number of dropped message events in all the included time events.\nIf the value is 0, then no message events were dropped.",
"format":"int32",
"type":"integer"
},
"timeEvent":{
"description":"A collection of `TimeEvent`s.",
"items":{
"$ref":"TimeEvent"
},
"type":"array"
}
},
"type":"object"
},
"TruncatableString":{
"description":"Represents a string that might be shortened to a specified length.",
"id":"TruncatableString",
"properties":{
"truncatedByteCount":{
"description":"The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.",
"format":"int32",
"type":"integer"
},
"value":{
"description":"The shortened string. For example, if the original string is 500\nbytes long and the limit of the string is 128 bytes, then\n`value` contains the first 128 bytes of the 500-byte string.\n\nTruncation always happens on a UTF8 character boundary. If there\nare multi-byte characters in the string, then the length of the\nshortened string might be less than the size limit.",
