This repository has been archived by the owner on Feb 15, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #612 from wrijeff/docs
Added trace-analytics schema documentation.
- Loading branch information
Showing
3 changed files
with
410 additions
and
0 deletions.
There are no files selected for viewing
125 changes: 125 additions & 0 deletions
125
docs/schemas/trace-analytics/otel-v1-apm-service-map-index-template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| # otel-v1-apm-service-map-index-template | ||
|
|
||
| ## Description | ||
| Documents in this index correspond to edges in a service map. Edges are created when a request crosses service boundaries. Documents will exclusively contain either a _destination_ or a _target_: | ||
| * Destination: corresponds to a client span calling another service. The _destination_ is the other service being called. | ||
| * Target: corresponds to a server span. The _target_ is the operation or API being called by the client. | ||
|
|
||
| ```json | ||
| { | ||
| "version": 0, | ||
| "mappings": { | ||
| "date_detection": false, | ||
| "dynamic_templates": [ | ||
| { | ||
| "strings_as_keyword": { | ||
| "mapping": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| }, | ||
| "match_mapping_type": "string" | ||
| } | ||
| } | ||
| ], | ||
| "_source": { | ||
| "enabled": true | ||
| }, | ||
| "properties": { | ||
| "hashId": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| }, | ||
| "serviceName": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| }, | ||
| "kind": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| }, | ||
| "destination": { | ||
| "properties": { | ||
| "domain": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| }, | ||
| "resource": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| } | ||
| } | ||
| }, | ||
| "target": { | ||
| "properties": { | ||
| "domain": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| }, | ||
| "resource": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| } | ||
| } | ||
| }, | ||
| "traceGroupName": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Fields | ||
| * hashId - A deterministic hash of this relationship. | ||
| * kind - The span kind, corresponding to the source of the relationship. See [OpenTelemetry - SpanKind](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#spankind). | ||
| * serviceName - The name of the service which emitted the span. Currently derived from the `opentelemetry.proto.resource.v1.Resource` associated with the span. | ||
| * destination.domain - The serviceName of the service being called by this client. | ||
| * destination.resource - The span name (API, operation, etc.) being called by this client. | ||
| * target.domain - The serviceName of the service being called by a client. | ||
| * target.resource - The span name (API, operation, etc.) being called by a client. | ||
| * traceGroupName - The top-level span name which started the request chain. | ||
|
|
||
| ## Example Documents | ||
| The two example documents below illustrate the "inventory" service calling the "database" service's `updateItem` API. | ||
| ```json | ||
| { | ||
| "_index": "otel-v1-apm-service-map", | ||
| "_type": "_doc", | ||
| "_id": "7/jRp2VF7544pBN6+mK2vw==", | ||
| "_score": 1, | ||
| "_source": { | ||
| "serviceName": "inventory", | ||
| "kind": "SPAN_KIND_CLIENT", | ||
| "destination": { | ||
| "resource": "updateItem", | ||
| "domain": "database" | ||
| }, | ||
| "target": null, | ||
| "traceGroupName": "client_checkout", | ||
| "hashId": "7/jRp2VF7544pBN6+mK2vw==" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ```json | ||
| { | ||
| "_index": "otel-v1-apm-service-map", | ||
| "_type": "_doc", | ||
| "_id": "lZcUyuhGYfnaQqt+r73njA==", | ||
| "_version": 3, | ||
| "_score": 0, | ||
| "_source": { | ||
| "serviceName": "database", | ||
| "kind": "SPAN_KIND_SERVER", | ||
| "destination": null, | ||
| "target": { | ||
| "resource": "updateItem", | ||
| "domain": "database" | ||
| }, | ||
| "traceGroupName": "client_checkout", | ||
| "hashId": "lZcUyuhGYfnaQqt+r73njA==" | ||
| } | ||
| } | ||
| ``` | ||
|
|
182 changes: 182 additions & 0 deletions
182
docs/schemas/trace-analytics/otel-v1-apm-span-index-template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| # otel-v1-apm-span-index-template | ||
|
|
||
| ## Description | ||
| Documents in this index correspond to spans following the [OpenTelemetry tracing specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md). Many fields are directly copied from the span, however some fields are derived and not present in the original span. | ||
|
|
||
| ```json | ||
| { | ||
| "version": 0, | ||
| "mappings": { | ||
| "date_detection": false, | ||
| "dynamic_templates": [ | ||
| { | ||
| "resource_attributes_map": { | ||
| "mapping": { | ||
| "type":"keyword" | ||
| }, | ||
| "path_match":"resource.attributes.*" | ||
| } | ||
| }, | ||
| { | ||
| "attributes_map": { | ||
| "mapping": { | ||
| "type":"keyword" | ||
| }, | ||
| "path_match":"attributes.*" | ||
| } | ||
| } | ||
| ], | ||
| "_source": { | ||
| "enabled": true | ||
| }, | ||
| "properties": { | ||
| "traceId": { | ||
| "ignore_above": 256, | ||
| "type": "keyword" | ||
| }, | ||
| "spanId": { | ||
| "ignore_above": 256, | ||
| "type": "keyword" | ||
| }, | ||
| "parentSpanId": { | ||
| "ignore_above": 256, | ||
| "type": "keyword" | ||
| }, | ||
| "name": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| }, | ||
| "traceGroup": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| }, | ||
| "traceGroupFields": { | ||
| "properties": { | ||
| "endTime": { | ||
| "type": "date_nanos" | ||
| }, | ||
| "durationInNanos": { | ||
| "type": "long" | ||
| }, | ||
| "statusCode": { | ||
| "type": "integer" | ||
| } | ||
| } | ||
| }, | ||
| "kind": { | ||
| "ignore_above": 128, | ||
| "type": "keyword" | ||
| }, | ||
| "startTime": { | ||
| "type": "date_nanos" | ||
| }, | ||
| "endTime": { | ||
| "type": "date_nanos" | ||
| }, | ||
| "status": { | ||
| "properties": { | ||
| "code": { | ||
| "type": "integer" | ||
| }, | ||
| "message": { | ||
| "type": "keyword" | ||
| } | ||
| } | ||
| }, | ||
| "serviceName": { | ||
| "type": "keyword" | ||
| }, | ||
| "durationInNanos": { | ||
| "type": "long" | ||
| }, | ||
| "events": { | ||
| "type": "nested", | ||
| "properties": { | ||
| "time": { | ||
| "type": "date_nanos" | ||
| } | ||
| } | ||
| }, | ||
| "links": { | ||
| "type": "nested" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Fields | ||
| Many fields are either copied or derived from the [trace specification protobuf](https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/trace/v1/trace.proto) format. | ||
|
|
||
| * traceId - A unique identifier for a trace. All spans from the same trace share the same traceId. | ||
| * spanId - A unique identifier for a span within a trace, assigned when the span is created. | ||
| * traceState - Conveys information about request position in multiple distributed tracing graphs. | ||
| * parentSpanId - The `spanId` of this span's parent span. If this is a root span, then this field must be empty. | ||
| * name - A description of the span's operation. | ||
| * kind - The type of span. See [OpenTelemetry - SpanKind](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#spankind). | ||
| * startTime - The start time of the span. | ||
| * endTime - The end time of the span. | ||
| * durationInNanos - Difference in nanoseconds between `startTime` and `endTime`. | ||
| * serviceName - Currently derived from the `opentelemetry.proto.resource.v1.Resource` associated with the span, the resource from the span originates. | ||
| * events - A list of events. See [OpenTelemetry - Events](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#add-events). | ||
| * links - A list of linked spans. See [OpenTelemetry - Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#specifying-links). | ||
| * droppedAttributesCount - The number of attributes that were discarded. | ||
| * droppedEventsCount - The number of events that were discarded. | ||
| * droppedLinksCount - The number of links that were dropped. | ||
| * traceGroup - A derived field, the `name` of the trace's root span. | ||
| * traceGroupFields.endTime - A derived field, the `endTime` of the trace's root span. | ||
| * traceGroupFields.statusCode - A derived field, the `status.code` of the trace's root span. | ||
| * traceGroupFields.durationInNanos - A derived field, the `durationInNanos` of the trace's root span. | ||
| * span.attributes.* - All span attributes are split into a list of keywords. | ||
| * resource.attributes.* - All resource attributes are split into a list of keywords. | ||
| * status.code - The status of the span. See [OpenTelemetry - Status](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status). | ||
|
|
||
|
|
||
| ## Example Documents | ||
|
|
||
| ```json | ||
| { | ||
| "_index": "otel-v1-apm-span-000006", | ||
| "_type": "_doc", | ||
| "_id": "fe0e3811627189df", | ||
| "_score": 1, | ||
| "_source": { | ||
| "traceId": "0000000000000000856bfa5aeba5ec77", | ||
| "spanId": "fe0e3811627189df", | ||
| "traceState": "", | ||
| "parentSpanId": "856bfa5aeba5ec77", | ||
| "name": "/getcart", | ||
| "kind": "SPAN_KIND_UNSPECIFIED", | ||
| "startTime": "2021-05-18T18:58:44.695Z", | ||
| "endTime": "2021-05-18T18:58:44.760Z", | ||
| "durationInNanos": 65000000, | ||
| "serviceName": "cartservice", | ||
| "events": [], | ||
| "links": [], | ||
| "droppedAttributesCount": 0, | ||
| "droppedEventsCount": 0, | ||
| "droppedLinksCount": 0, | ||
| "traceGroup": "/cart", | ||
| "traceGroupFields.endTime": "2021-05-18T18:58:44.983Z", | ||
| "traceGroupFields.statusCode": 0, | ||
| "traceGroupFields.durationInNanos": 387000000, | ||
| "span.attributes.http@method": "GET", | ||
| "span.attributes.http@url": "http://cartservice/GetCart", | ||
| "span.attributes.instance": "cartservice-d847fdcf5-j6s2f", | ||
| "span.attributes.version": "v5", | ||
| "span.attributes.region": "us-east-1", | ||
| "resource.attributes.service@name": "cartservice", | ||
| "span.attributes.net@host@ip": "172.22.0.8", | ||
| "status.code": 0 | ||
| }, | ||
| "fields": { | ||
| "startTime": [ | ||
| "2021-05-18T18:58:44.695Z" | ||
| ], | ||
| "endTime": [ | ||
| "2021-05-18T18:58:44.760Z" | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
Oops, something went wrong.