Skip to content

Commit

Permalink
Update documentation for new composite span fields in ES
Browse files Browse the repository at this point in the history
  • Loading branch information
estolfo committed Jul 21, 2021
1 parent d0310d1 commit 93332d2
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 1 deletion.
12 changes: 12 additions & 0 deletions apmpackage/apm/data_stream/traces/fields/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,18 @@
type: keyword
description: |
The specific kind of event within the sub-type represented by the span (e.g. query, connect)
- name: span.composite.compression_strategy
type: keyword
description: |
The compression strategy that was used.
- name: span.composite.count
type: long
description: |
Number of compressed spans the composite span represents.
- name: span.composite.sum.us
type: long
description: |
Sum of the durations of the compression spans, in microseconds.
- name: span.db.link
type: keyword
description: |
Expand Down
3 changes: 3 additions & 0 deletions apmpackage/apm/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,9 @@ Traces are written to `traces-apm.*` indices.
|source.ip|IP address of the source of a recorded event. This is typically obtained from a request's X-Forwarded-For or the X-Real-IP header or falls back to a given configuration for remote address.|ip| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png) |
|source.port|Port of the source.|long| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png) |
|span.action|The specific kind of event within the sub-type represented by the span (e.g. query, connect)|keyword| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png) |
|span.composite.compression\_strategy|The compression strategy that was used.|keyword| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png) |
|span.composite.count|Number of compressed spans the composite span represents.|long| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png) |
|span.composite.sum.us|Sum of the durations of the compression spans, in microseconds.|long| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png) |
|span.db.link|Database link.|keyword| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png) |
|span.db.rows\_affected|Number of rows affected by the database statement.|long| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png) |
|span.destination.service.name|Identifier for the destination service (e.g. 'http://elastic.co', 'elasticsearch', 'rabbitmq') DEPRECATED: this field will be removed in a future release|keyword| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png) |
Expand Down
32 changes: 32 additions & 0 deletions docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3927,6 +3927,38 @@ type: long
--
*`span.composite.count`*::
+
--
Number of compressed spans the composite span represents.
type: long
--
*`span.composite.sum.us`*::
+
--
Sum of the durations of the compression spans, in microseconds.
type: long
--
*`span.composite.compression_strategy`*::
+
--
The compression strategy that was used.
type: keyword
--
[[exported-fields-apm-span-metrics-xpack]]
== APM Span Metrics fields
Expand Down
2 changes: 1 addition & 1 deletion include/fields.go

Large diffs are not rendered by default.

25 changes: 25 additions & 0 deletions model/span/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -865,3 +865,28 @@
type: long
description: >
Age of a message in milliseconds.
- name: composite
type: group
dynamic: false
fields:

- name: count
type: long
description: >
Number of compressed spans the composite span represents.
- name: sum
type: group
fields:

- name: us
type: long
count: 1
description: >
Sum of the durations of the compression spans, in microseconds.
- name: compression_strategy
type: keyword
description: >
The compression strategy that was used.

0 comments on commit 93332d2

Please sign in to comment.