"description":"The shortened string. For example, if the original string was 500\nbytes long and the limit of the string was 128 bytes, then this\nvalue contains the first 128 bytes of the 500-byte string. Note that\ntruncation always happens on the character boundary, to ensure that\ntruncated string is still valid UTF8. In case of multi-byte characters,\nsize of truncated string can be less than truncation limit.",
"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`.",
"description":"If defined, indicates that there might be more spans that match the\nrequest. Pass this as the value of `pageToken` in a subsequent request to\nretrieve additional spans.",
"type":"string"
},
"spans":{
"description":"The requested spans, if there are any in the specified trace.",
"description":"For sent messages, this is the time at which the first bit was sent.\nFor received messages, this is the time at which the last bit was\nreceived.",
"description":"The version of the deployed source code (up to 128 bytes)."
},
"originalFunctionName":{
"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).",
"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.",
"description":"Text annotation with a set of attributes.",
"type":"object"
},
"StackFrames":{
"properties":{
"droppedFramesCount":{
"format":"int32",
"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.",
"description":"The resource name of the trace in the following format:\n\n projects/[PROJECT_ID]/traces/TRACE_ID is a unique identifier for a trace within a project.\nThe ID is assigned when the trace is created.",
"description":"A trace describes how long it takes for an application to perform some\noperations. It consists of a set of spans, each representing\nan operation and including time information and operation details.",
"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 an RPC message sent/received on the network.",
"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.",
"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.",
"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 `{}`.",
"description":"The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty.",
"type":"string"
},
"endTime":{
"format":"google-datetime",
"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.",
"type":"string"
},
"startTime":{
"format":"google-datetime",
"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.",
"type":"string"
},
"displayName":{
"$ref":"TruncatableString",
"description":"A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic print site_values.console_name %}.\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 [SPAN_ID] portion of the span's resource name.",
"type":"string"
},
"childSpanCount":{
"format":"uint32",
"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 highly recommended but not required flag that identifies when a trace\ncrosses a process boundary. True when the parent_span belongs to the\nsame process as the current span.",
"type":"boolean"
},
"status":{
"description":"An optional final status for this span.",
"$ref":"Status"
},
"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.\n[SPAN_ID] is a unique identifier for a span within a trace,\nassigned when the span is created.",
"type":"string"
},
"stackTrace":{
"description":"Stack trace captured at the start of the 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—there may be\ngaps or overlaps between spans in a trace.",
"description":"If there might be more results than those appearing in this response, then\n`next_page_token` is included. To get the next set of results, call this\nmethod again using the value of `next_page_token` as `page_token`.",
"description":"A set of attributes, each in the format `[KEY]:[VALUE]`.",
"type":"object",
"properties":{
"attributeMap":{
"additionalProperties":{
"$ref":"AttributeValue"
},
"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, an integer, or the\nBoolean 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.",
"description":"Returns of a list of traces that match the specified filter conditions.",
"response":{
"$ref":"ListTracesResponse"
},
"httpMethod":"GET",
"parameterOrder":[
"parent"
],
"scopes":[
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly"
],
"parameters":{
"parent":{
"pattern":"^projects/[^/]+$",
"location":"path",
"description":"Required. The project where the trace data is stored. The format\nis `projects/PROJECT_ID`.",
"type":"string",
"required":true
},
"orderBy":{
"location":"query",
"description":"Optional. A single field used to sort the returned traces.\nOnly the following field names can be used:\n\n* `trace_id`: the trace's ID field\n* `name`: the root span's resource name\n* `duration`: the difference between the root span's start time and end time\n* `start`: the start time of the root span\n\nSorting is in ascending order unless `desc` is appended to the sort field name.\nExample: `\"name desc\"`).",
"type":"string"
},
"filter":{
"location":"query",
"description":"Opional. Return only traces that match this\n[trace filter](/trace/docs/trace-filters). Example:\n\n \"label:/http/url root:/_ah/background my_label:17\"",
"type":"string"
},
"endTime":{
"location":"query",
"format":"google-datetime",
"description":"Optional. Do not return traces whose start time is later than this time.",
"type":"string"
},
"pageToken":{
"description":"Optional. If present, then retrieve the next batch of results from the\npreceding call to this method. `page_token` must be the value of\n`next_page_token` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
"type":"string",
"location":"query"
},
"startTime":{
"format":"google-datetime",
"description":"Optional. Do not return traces whose end time is earlier than this time.",
"type":"string",
"location":"query"
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Optional. The maximum number of results to return from this request.\nNon-positive values are ignored. The presence of `next_page_token` in the\nresponse indicates that more results might be available, even if fewer than\nthe maximum number of results is returned by this request.",
"type":"integer"
}
},
"flatPath":"v2/projects/{projectsId}/traces",
"id":"cloudtrace.projects.traces.list",
"path":"v2/{+parent}/traces"
},
"batchWrite":{
"path":"v2/{+name}/traces:batchWrite",
"id":"cloudtrace.projects.traces.batchWrite",
"description":"Sends new spans to Stackdriver Trace or updates existing traces. If the\nname of a trace that you send matches that of an existing trace, new spans\nare added to the existing trace. Attempt to update existing spans results\nundefined behavior. If the name does not match, a new trace is created\nwith given set of spans.",
"request":{
"$ref":"BatchWriteSpansRequest"
},
"httpMethod":"POST",
"parameterOrder":[
"name"
],
"response":{
"$ref":"Empty"
},
"parameters":{
"name":{
"pattern":"^projects/[^/]+$",
"location":"path",
"description":"Required. Name of the project where the spans belong. The format is\n`projects/PROJECT_ID`.",
"description":"Optional. If present, then retrieve the next batch of results from the\npreceding call to this method. `page_token` must be the value of\n`next_page_token` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
"type":"string"
},
"parent":{
"pattern":"^projects/[^/]+/traces/[^/]+$",
"location":"path",
"description":"Required: The resource name of the trace containing the spans to list.\nThe format is `projects/PROJECT_ID/traces/TRACE_ID`.",
"description":"Returns a list of spans within a trace."
}
},
"resources":{
"spans":{
"methods":{
"create":{
"response":{
"$ref":"Span"
},
"parameterOrder":[
"name"
],
"httpMethod":"PUT",
"scopes":[
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
],
"parameters":{
"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.\n[SPAN_ID] is a unique identifier for a span within a trace,\nassigned when the span is created.",
"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.",
"type":"string",
"location":"query"
},
"pp":{
"description":"Pretty-print response.",
"default":"true",
"type":"boolean",
"location":"query"
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"type":"string",
"location":"query"
},
"bearer_token":{
"location":"query",
"description":"OAuth bearer token.",
"type":"string"
},
"upload_protocol":{
"location":"query",
"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type":"string"
},
"prettyPrint":{
"description":"Returns response with indentations and line breaks.",
"default":"true",
"type":"boolean",
"location":"query"
},
"uploadType":{
"location":"query",
"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type":"string"
},
"fields":{
"description":"Selector specifying which fields to include in a partial response.",
"type":"string",
"location":"query"
},
"callback":{
"location":"query",
"description":"JSONP",
"type":"string"
},
"$.xgafv":{
"enumDescriptions":[
"v1 error format",
"v2 error format"
],
"location":"query",
"enum":[
"1",
"2"
],
"description":"V1 error format.",
"type":"string"
},
"alt":{
"description":"Data format for response.",
"default":"json",
"enum":[
"json",
"media",
"proto"
],
"type":"string",
"enumDescriptions":[
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location":"query"
},
"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.",
"type":"string",
"location":"query"
},
"access_token":{
"location":"query",
"description":"OAuth access token.",
"type":"string"
}
},
"version":"v2",
"baseUrl":"https://cloudtrace.googleapis.com/",
"description":"Send and retrieve trace data from Stackdriver Trace. Data is generated and available by default for all App Engine applications. Data from other applications can be written to Stackdriver Trace for display, reporting, and analysis.\n",
