Chiebot-Mirror
/
opencensus-proto
mirror of https://github.com/census-instrumentation/opencensus-proto.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add OpenApi doc for trace agent grpc-gateway (#157)

Browse Source
pull/164/head
Dave Raffensperger 6 years ago committed by GitHub
parent db93b729e7
commit ba49f56771
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 668 additions and 0 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 668
      gen-openapi/opencensus/proto/agent/trace/v1/trace_service.swagger.json

668
gen-openapi/opencensus/proto/agent/trace/v1/trace_service.swagger.json
Unescape View File

@ -0,0 +1,668 @@
{
"swagger": "2.0",
"info": {
"title": "opencensus/proto/agent/trace/v1/trace_service.proto",
"version": "version not set"
},
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/v1/trace": {
"post": {
"summary": "For performance reasons, it is recommended to keep this RPC\nalive for the entire life of the application.",
"operationId": "Export",
"responses": {
"200": {
"description": "(streaming responses)",
"schema": {
"$ref": "#/definitions/v1ExportTraceServiceResponse"
}
}
},
"parameters": [
{
"name": "body",
"description": " (streaming inputs)",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ExportTraceServiceRequest"
}
}
],
"tags": [
"TraceService"
]
}
}
},
"definitions": {
"LibraryInfoLanguage": {
"type": "string",
"enum": [
"LANGUAGE_UNSPECIFIED",
"CPP",
"C_SHARP",
"ERLANG",
"GO_LANG",
"JAVA",
"NODE_JS",
"PHP",
"PYTHON",
"RUBY"
],
"default": "LANGUAGE_UNSPECIFIED"
},
"SpanAttributes": {
"type": "object",
"properties": {
"attribute_map": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/v1AttributeValue"
},
"description": "\"/instance_id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/server_latency\": 300\n \"abc.com/myattribute\": true",
"title": "The set of attributes. The value can be a string, an integer, or the\nBoolean values `true` and `false`. For example:"
},
"dropped_attributes_count": {
"type": "integer",
"format": "int32",
"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 no attributes were dropped."
}
},
"description": "A set of attributes, each with a key and a value."
},
"SpanLink": {
"type": "object",
"properties": {
"trace_id": {
"type": "string",
"format": "byte",
"description": "A unique identifier for a trace. All spans from the same trace share\nthe same `trace_id`. The ID is a 16-byte array."
},
"span_id": {
"type": "string",
"format": "byte",
"description": "A unique identifier for a span within a trace, assigned when the span\nis created. The ID is an 8-byte array."
},
"type": {
"$ref": "#/definitions/SpanLinkType",
"description": "The relationship of the current span relative to the linked span."
},
"attributes": {
"$ref": "#/definitions/SpanAttributes",
"description": "A set of attributes on the 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."
},
"SpanLinkType": {
"type": "string",
"enum": [
"TYPE_UNSPECIFIED",
"CHILD_LINKED_SPAN",
"PARENT_LINKED_SPAN"
],
"default": "TYPE_UNSPECIFIED",
"description": "The relationship of the current span relative to the linked span: child,\nparent, or unspecified.\n\n - TYPE_UNSPECIFIED: The relationship of the two spans is unknown, or known but other\nthan parent-child.\n - CHILD_LINKED_SPAN: The linked span is a child of the current span.\n - PARENT_LINKED_SPAN: The linked span is a parent of the current span."
},
"SpanLinks": {
"type": "object",
"properties": {
"link": {
"type": "array",
"items": {
"$ref": "#/definitions/SpanLink"
},
"description": "A collection of links."
},
"dropped_links_count": {
"type": "integer",
"format": "int32",
"description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped."
}
},
"description": "A collection of links, which are references from this span to a span\nin the same or different trace."
},
"SpanSpanKind": {
"type": "string",
"enum": [
"SPAN_KIND_UNSPECIFIED",
"SERVER",
"CLIENT"
],
"default": "SPAN_KIND_UNSPECIFIED",
"description": "Type of span. Can be used to specify additional relationships between spans\nin addition to a parent/child relationship.\n\n - SPAN_KIND_UNSPECIFIED: Unspecified.\n - SERVER: Indicates that the span covers server-side handling of an RPC or other\nremote network request.\n - CLIENT: Indicates that the span covers the client-side wrapper around an RPC or\nother remote request."
},
"SpanTimeEvent": {
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time",
"description": "The time the event occurred."
},
"annotation": {
"$ref": "#/definitions/TimeEventAnnotation",
"description": "A text annotation with a set of attributes."
},
"message_event": {
"$ref": "#/definitions/TimeEventMessageEvent",
"description": "An event describing a message sent/received between Spans."
}
},
"description": "A time-stamped annotation or message event in the Span."
},
"SpanTimeEvents": {
"type": "object",
"properties": {
"time_event": {
"type": "array",
"items": {
"$ref": "#/definitions/SpanTimeEvent"
},
"description": "A collection of `TimeEvent`s."
},
"dropped_annotations_count": {
"type": "integer",
"format": "int32",
"description": "The number of dropped annotations in all the included time events.\nIf the value is 0, then no annotations were dropped."
},
"dropped_message_events_count": {
"type": "integer",
"format": "int32",
"description": "The number of dropped message events in all the included time events.\nIf the value is 0, then no message events were dropped."
}
},
"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."
},
"SpanTracestate": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/definitions/TracestateEntry"
},
"description": "A list of entries that represent the Tracestate."
}
},
"description": "This field conveys information about request position in multiple distributed tracing graphs.\nIt is a list of Tracestate.Entry with a maximum of 32 members in the list.\n\nSee the https://github.com/w3c/distributed-tracing for more details about this field."
},
"StackTraceStackFrame": {
"type": "object",
"properties": {
"function_name": {
"$ref": "#/definitions/v1TruncatableString",
"description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame."
},
"original_function_name": {
"$ref": "#/definitions/v1TruncatableString",
"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."
},
"file_name": {
"$ref": "#/definitions/v1TruncatableString",
"description": "The name of the source file where the function call appears."
},
"line_number": {
"type": "string",
"format": "int64",
"description": "The line number in `file_name` where the function call appears."
},
"column_number": {
"type": "string",
"format": "int64",
"description": "The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions."
},
"load_module": {
"$ref": "#/definitions/v1Module",
"description": "The binary module from where the code was loaded."
},
"source_version": {
"$ref": "#/definitions/v1TruncatableString",
"description": "The version of the deployed source code."
}
},
"description": "A single stack frame in a stack trace."
},
"StackTraceStackFrames": {
"type": "object",
"properties": {
"frame": {
"type": "array",
"items": {
"$ref": "#/definitions/StackTraceStackFrame"
},
"description": "Stack frames in this call stack."
},
"dropped_frames_count": {
"type": "integer",
"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": "A collection of stack frames, which can be truncated."
},
"TimeEventAnnotation": {
"type": "object",
"properties": {
"description": {
"$ref": "#/definitions/v1TruncatableString",
"description": "A user-supplied message describing the event."
},
"attributes": {
"$ref": "#/definitions/SpanAttributes",
"description": "A set of attributes on the annotation."
}
},
"description": "A text annotation with a set of attributes."
},
"TimeEventMessageEvent": {
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/TimeEventMessageEventType",
"description": "The type of MessageEvent. Indicates whether the message was sent or\nreceived."
},
"id": {
"type": "string",
"format": "uint64",
"description": "An identifier for the MessageEvent's message that can be used to match\nSENT and RECEIVED MessageEvents. For example, this field could\nrepresent a sequence ID for a streaming RPC. It is recommended to be\nunique within a Span."
},
"uncompressed_size": {
"type": "string",
"format": "uint64",
"description": "The number of uncompressed bytes sent or received."
},
"compressed_size": {
"type": "string",
"format": "uint64",
"description": "The number of compressed bytes sent or received. If zero, assumed to\nbe the same size as uncompressed."
}
},
"description": "An event describing a message sent/received between Spans."
},
"TimeEventMessageEventType": {
"type": "string",
"enum": [
"TYPE_UNSPECIFIED",
"SENT",
"RECEIVED"
],
"default": "TYPE_UNSPECIFIED",
"description": "Indicates whether the message was sent or received.\n\n - TYPE_UNSPECIFIED: Unknown event type.\n - SENT: Indicates a sent message.\n - RECEIVED: Indicates a received message."
},
"TracestateEntry": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key must begin with a lowercase letter, and can only contain\nlowercase letters 'a'-'z', digits '0'-'9', underscores '_', dashes\n'-', asterisks '*', and forward slashes '/'."
},
"value": {
"type": "string",
"description": "The value is opaque string up to 256 characters printable ASCII\nRFC0020 characters (i.e., the range 0x20 to 0x7E) except ',' and '='.\nNote that this also excludes tabs, newlines, carriage returns, etc."
}
}
},
"v1AttributeValue": {
"type": "object",
"properties": {
"string_value": {
"$ref": "#/definitions/v1TruncatableString",
"description": "A string up to 256 bytes long."
},
"int_value": {
"type": "string",
"format": "int64",
"description": "A 64-bit signed integer."
},
"bool_value": {
"type": "boolean",
"format": "boolean",
"description": "A Boolean value represented by `true` or `false`."
},
"double_value": {
"type": "number",
"format": "double",
"description": "A double value."
}
},
"description": "The value of an Attribute."
},
"v1ConstantSampler": {
"type": "object",
"properties": {
"decision": {
"type": "boolean",
"format": "boolean",
"description": "Whether spans should be always sampled, or never sampled."
}
},
"description": "Sampler that makes a constant decision (either always \"yes\" or always \"no\")\non span sampling."
},
"v1ExportTraceServiceRequest": {
"type": "object",
"properties": {
"node": {
"$ref": "#/definitions/v1Node",
"description": "This is required only in the first message on the stream or if the\nprevious sent ExportTraceServiceRequest message has a different Node (e.g.\nwhen the same RPC is used to send Spans from multiple Applications)."
},
"spans": {
"type": "array",
"items": {
"$ref": "#/definitions/v1Span"
},
"description": "A list of Spans that belong to the last received Node."
},
"resource": {
"$ref": "#/definitions/v1Resource",
"description": "The resource for the spans in this message that do not have an explicit\nresource set.\nIf unset, the most recently set resource in the RPC stream applies. It is\nvalid to never be set within a stream, e.g. when no resource info is known."
}
}
},
"v1ExportTraceServiceResponse": {
"type": "object"
},
"v1LibraryInfo": {
"type": "object",
"properties": {
"language": {
"$ref": "#/definitions/LibraryInfoLanguage",
"description": "Language of OpenCensus Library."
},
"exporter_version": {
"type": "string",
"description": "Version of Agent exporter of Library."
},
"core_library_version": {
"type": "string",
"description": "Version of OpenCensus Library."
}
},
"description": "Information on OpenCensus Library."
},
"v1Module": {
"type": "object",
"properties": {
"module": {
"$ref": "#/definitions/v1TruncatableString",
"description": "TODO: document the meaning of this field.\nFor example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so."
},
"build_id": {
"$ref": "#/definitions/v1TruncatableString",
"description": "A unique identifier for the module, usually a hash of its\ncontents."
}
},
"description": "A description of a binary module."
},
"v1Node": {
"type": "object",
"properties": {
"identifier": {
"$ref": "#/definitions/v1ProcessIdentifier",
"description": "Identifier that uniquely identifies a process within a VM/container."
},
"library_info": {
"$ref": "#/definitions/v1LibraryInfo",
"description": "Information on the OpenCensus Library that initiates the stream."
},
"service_info": {
"$ref": "#/definitions/v1ServiceInfo",
"description": "Additional information on service."
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Additional attributes."
}
},
"title": "Identifier metadata of the Node (Application instrumented with OpenCensus)\nthat connects to OpenCensus Agent.\nIn the future we plan to extend the identifier proto definition to support\nadditional information (e.g cloud id, etc.)"
},
"v1ProbabilitySampler": {
"type": "object",
"properties": {
"samplingProbability": {
"type": "number",
"format": "double",
"description": "The desired probability of sampling. Must be within [0.0, 1.0]."
}
},
"description": "Sampler that tries to uniformly sample traces with a given probability.\nThe probability of sampling a trace is equal to that of the specified probability."
},
"v1ProcessIdentifier": {
"type": "object",
"properties": {
"host_name": {
"type": "string",
"description": "The host name. Usually refers to the machine/container name.\nFor example: os.Hostname() in Go, socket.gethostname() in Python."
},
"pid": {
"type": "integer",
"format": "int64",
"description": "Process id."
},
"start_timestamp": {
"type": "string",
"format": "date-time",
"description": "Start time of this ProcessIdentifier. Represented in epoch time."
}
},
"description": "Identifier that uniquely identifies a process within a VM/container."
},
"v1RateLimitingSampler": {
"type": "object",
"properties": {
"qps": {
"type": "string",
"format": "int64",
"description": "Rate per second."
}
},
"description": "Sampler that tries to sample with a rate per time window."
},
"v1Resource": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type identifier for the resource."
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Set of labels that describe the resource."
}
},
"description": "Resource information."
},
"v1ServiceInfo": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the service."
}
},
"description": "Additional service information."
},
"v1Span": {
"type": "object",
"properties": {
"trace_id": {
"type": "string",
"format": "byte",
"description": "A unique identifier for a trace. All spans from the same trace share\nthe same `trace_id`. The ID is a 16-byte array.\n\nThis field is required."
},
"span_id": {
"type": "string",
"format": "byte",
"description": "A unique identifier for a span within a trace, assigned when the span\nis created. The ID is an 8-byte array.\n\nThis field is required."
},
"tracestate": {
"$ref": "#/definitions/SpanTracestate",
"description": "The Tracestate on the span."
},
"parent_span_id": {
"type": "string",
"format": "byte",
"description": "The `span_id` of this span's parent span. If this is a root span, then this\nfield must be empty. The ID is an 8-byte array."
},
"name": {
"$ref": "#/definitions/v1TruncatableString",
"description": "A description of the span's operation.\n\nFor example, the 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 at the same call point in an application.\nThis makes it easier to correlate spans in different traces.\n\nThis field is required."
},
"kind": {
"$ref": "#/definitions/SpanSpanKind",
"description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `CLIENT`\nand `SERVER` to identify queueing latency associated with the span."
},
"start_time": {
"type": "string",
"format": "date-time",
"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."
},
"end_time": {
"type": "string",
"format": "date-time",
"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."
},
"attributes": {
"$ref": "#/definitions/SpanAttributes",
"description": "A set of attributes on the span."
},
"stack_trace": {
"$ref": "#/definitions/v1StackTrace",
"description": "A stack trace captured at the start of the span."
},
"time_events": {
"$ref": "#/definitions/SpanTimeEvents",
"description": "The included time events."
},
"links": {
"$ref": "#/definitions/SpanLinks",
"description": "The included links."
},
"status": {
"$ref": "#/definitions/v1Status",
"description": "An optional final status for this span."
},
"same_process_as_parent_span": {
"type": "boolean",
"format": "boolean",
"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."
},
"child_span_count": {
"type": "integer",
"format": "int64",
"description": "An optional number of child spans that were generated while this span\nwas active. If set, allows an implementation to detect missing child spans."
}
},
"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.\n\nThe next id is 16.\nTODO(bdrutu): Add an example."
},
"v1StackTrace": {
"type": "object",
"properties": {
"stack_frames": {
"$ref": "#/definitions/StackTraceStackFrames",
"description": "Stack frames in this stack trace."
},
"stack_trace_hash_id": {
"type": "string",
"format": "uint64",
"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\n`stack_frames` and a value in `stack_trace_hash_id`.\n\nSubsequent spans within the same request can refer\nto that stack trace by setting only `stack_trace_hash_id`.\n\nTODO: describe how to deal with the case where stack_trace_hash_id is\nzero because it was not set."
}
},
"description": "The call stack which originated this span."
},
"v1Status": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "The status code."
},
"message": {
"type": "string",
"description": "A developer-facing error message, which should be in English."
}
},
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. This proto's fields\nare a subset of those of\n[google.rpc.Status](https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto),\nwhich is used by [gRPC](https://github.com/grpc)."
},
"v1TraceConfig": {
"type": "object",
"properties": {
"probability_sampler": {
"$ref": "#/definitions/v1ProbabilitySampler"
},
"constant_sampler": {
"$ref": "#/definitions/v1ConstantSampler"
},
"rate_limiting_sampler": {
"$ref": "#/definitions/v1RateLimitingSampler"
},
"max_number_of_attributes": {
"type": "string",
"format": "int64",
"description": "The global default max number of attributes per span."
},
"max_number_of_annotations": {
"type": "string",
"format": "int64",
"description": "The global default max number of annotation events per span."
},
"max_number_of_message_events": {
"type": "string",
"format": "int64",
"description": "The global default max number of message events per span."
},
"max_number_of_links": {
"type": "string",
"format": "int64",
"description": "The global default max number of link entries per span."
}
},
"description": "Global configuration of the trace service."
},
"v1TruncatableString": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The shortened string. For example, if the original string was 500 bytes long and\nthe limit of the string was 128 bytes, then this value contains the first 128\nbytes of the 500-byte string. Note that truncation always happens on a\ncharacter boundary, to ensure that a truncated string is still valid UTF-8.\nBecause it may contain multi-byte characters, the size of the truncated string\nmay be less than the truncation limit."
},
"truncated_byte_count": {
"type": "integer",
"format": "int32",
"description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened."
}
},
"description": "A string that might be shortened to a specified length."
},
"v1UpdatedLibraryConfig": {
"type": "object",
"properties": {
"node": {
"$ref": "#/definitions/v1Node",
"description": "This field is ignored when the RPC is used to configure only one Application.\nThis is required only in the first message on the stream or if the\nprevious sent UpdatedLibraryConfig message has a different Node."
},
"config": {
"$ref": "#/definitions/v1TraceConfig",
"description": "Requested updated configuration."
}
}
}
}
}
Write Preview
Loading…
Cancel
Save