Skip to content

Commit

Permalink
add http.request.id (elastic#1208)
Browse files Browse the repository at this point in the history
Co-authored-by: Eric Beahan <[email protected]>
# Conflicts:
#	experimental/generated/csv/fields.csv
#	generated/csv/fields.csv
  • Loading branch information
graphaelli authored and ebeahan committed Jan 14, 2021
1 parent 4ab85fa commit 5e84e9e
Show file tree
Hide file tree
Showing 17 changed files with 143 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Thanks, you're awesome :-) -->

#### Added

* Added `http.request.id`. #1208

#### Improvements

#### Deprecated
Expand Down
6 changes: 6 additions & 0 deletions code/go/ecs/http.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions docs/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3383,6 +3383,24 @@ example: `1437`

// ===============================================================

|
[[field-http-request-id]]
<<field-http-request-id, http.request.id>>

| A unique identifier for each HTTP request to correlate logs between clients and servers in transactions.

The id may be contained in a non-standard HTTP header, such as `X-Request-ID` or `X-Correlation-ID`.

type: keyword



example: `123e4567-e89b-12d3-a456-426614174000`

| extended

// ===============================================================

|
[[field-http-request-method]]
<<field-http-request-method, http.request.method>>
Expand Down
11 changes: 11 additions & 0 deletions experimental/generated/beats/fields.ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2413,6 +2413,17 @@
format: bytes
description: Total size in bytes of the request (body and headers).
example: 1437
- name: request.id
level: extended
type: keyword
ignore_above: 1024
description: 'A unique identifier for each HTTP request to correlate logs between
clients and servers in transactions.
The id may be contained in a non-standard HTTP header, such as `X-Request-ID`
or `X-Correlation-ID`.'
example: 123e4567-e89b-12d3-a456-426614174000
default_field: false
- name: request.method
level: extended
type: keyword
Expand Down
1 change: 1 addition & 0 deletions experimental/generated/csv/fields.csv
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
1.9.0-dev+exp,true,http,http.request.body.content,wildcard,extended,,Hello world,The full HTTP request body.
1.9.0-dev+exp,true,http,http.request.body.content.text,text,extended,,Hello world,The full HTTP request body.
1.9.0-dev+exp,true,http,http.request.bytes,long,extended,,1437,Total size in bytes of the request (body and headers).
1.9.0-dev+exp,true,http,http.request.id,keyword,extended,,123e4567-e89b-12d3-a456-426614174000,HTTP request ID.
1.9.0-dev+exp,true,http,http.request.method,keyword,extended,,"GET, POST, PUT, PoST",HTTP request method.
1.9.0-dev+exp,true,http,http.request.mime_type,keyword,extended,,image/gif,Mime type of the body of the request.
1.9.0-dev+exp,true,http,http.request.referrer,wildcard,extended,,https://blog.example.com/,Referrer for this HTTP request.
Expand Down
15 changes: 15 additions & 0 deletions experimental/generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3832,6 +3832,21 @@ http.request.bytes:
normalize: []
short: Total size in bytes of the request (body and headers).
type: long
http.request.id:
dashed_name: http-request-id
description: 'A unique identifier for each HTTP request to correlate logs between
clients and servers in transactions.
The id may be contained in a non-standard HTTP header, such as `X-Request-ID`
or `X-Correlation-ID`.'
example: 123e4567-e89b-12d3-a456-426614174000
flat_name: http.request.id
ignore_above: 1024
level: extended
name: request.id
normalize: []
short: HTTP request ID.
type: keyword
http.request.method:
dashed_name: http-request-method
description: 'HTTP request method.
Expand Down
15 changes: 15 additions & 0 deletions experimental/generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4548,6 +4548,21 @@ http:
normalize: []
short: Total size in bytes of the request (body and headers).
type: long
http.request.id:
dashed_name: http-request-id
description: 'A unique identifier for each HTTP request to correlate logs between
clients and servers in transactions.
The id may be contained in a non-standard HTTP header, such as `X-Request-ID`
or `X-Correlation-ID`.'
example: 123e4567-e89b-12d3-a456-426614174000
flat_name: http.request.id
ignore_above: 1024
level: extended
name: request.id
normalize: []
short: HTTP request ID.
type: keyword
http.request.method:
dashed_name: http-request-method
description: 'HTTP request method.
Expand Down
4 changes: 4 additions & 0 deletions experimental/generated/elasticsearch/7/template.json
Original file line number Diff line number Diff line change
Expand Up @@ -1296,6 +1296,10 @@
"bytes": {
"type": "long"
},
"id": {
"ignore_above": 1024,
"type": "keyword"
},
"method": {
"ignore_above": 1024,
"type": "keyword"
Expand Down
4 changes: 4 additions & 0 deletions experimental/generated/elasticsearch/component/http.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
"bytes": {
"type": "long"
},
"id": {
"ignore_above": 1024,
"type": "keyword"
},
"method": {
"ignore_above": 1024,
"type": "keyword"
Expand Down
11 changes: 11 additions & 0 deletions generated/beats/fields.ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2315,6 +2315,17 @@
format: bytes
description: Total size in bytes of the request (body and headers).
example: 1437
- name: request.id
level: extended
type: keyword
ignore_above: 1024
description: 'A unique identifier for each HTTP request to correlate logs between
clients and servers in transactions.
The id may be contained in a non-standard HTTP header, such as `X-Request-ID`
or `X-Correlation-ID`.'
example: 123e4567-e89b-12d3-a456-426614174000
default_field: false
- name: request.method
level: extended
type: keyword
Expand Down
1 change: 1 addition & 0 deletions generated/csv/fields.csv
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
1.9.0-dev,true,http,http.request.body.content,wildcard,extended,,Hello world,The full HTTP request body.
1.9.0-dev,true,http,http.request.body.content.text,text,extended,,Hello world,The full HTTP request body.
1.9.0-dev,true,http,http.request.bytes,long,extended,,1437,Total size in bytes of the request (body and headers).
1.9.0-dev,true,http,http.request.id,keyword,extended,,123e4567-e89b-12d3-a456-426614174000,HTTP request ID.
1.9.0-dev,true,http,http.request.method,keyword,extended,,"GET, POST, PUT, PoST",HTTP request method.
1.9.0-dev,true,http,http.request.mime_type,keyword,extended,,image/gif,Mime type of the body of the request.
1.9.0-dev,true,http,http.request.referrer,wildcard,extended,,https://blog.example.com/,Referrer for this HTTP request.
Expand Down
15 changes: 15 additions & 0 deletions generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3712,6 +3712,21 @@ http.request.bytes:
normalize: []
short: Total size in bytes of the request (body and headers).
type: long
http.request.id:
dashed_name: http-request-id
description: 'A unique identifier for each HTTP request to correlate logs between
clients and servers in transactions.
The id may be contained in a non-standard HTTP header, such as `X-Request-ID`
or `X-Correlation-ID`.'
example: 123e4567-e89b-12d3-a456-426614174000
flat_name: http.request.id
ignore_above: 1024
level: extended
name: request.id
normalize: []
short: HTTP request ID.
type: keyword
http.request.method:
dashed_name: http-request-method
description: 'HTTP request method.
Expand Down
15 changes: 15 additions & 0 deletions generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4405,6 +4405,21 @@ http:
normalize: []
short: Total size in bytes of the request (body and headers).
type: long
http.request.id:
dashed_name: http-request-id
description: 'A unique identifier for each HTTP request to correlate logs between
clients and servers in transactions.
The id may be contained in a non-standard HTTP header, such as `X-Request-ID`
or `X-Correlation-ID`.'
example: 123e4567-e89b-12d3-a456-426614174000
flat_name: http.request.id
ignore_above: 1024
level: extended
name: request.id
normalize: []
short: HTTP request ID.
type: keyword
http.request.method:
dashed_name: http-request-method
description: 'HTTP request method.
Expand Down
4 changes: 4 additions & 0 deletions generated/elasticsearch/6/template.json
Original file line number Diff line number Diff line change
Expand Up @@ -1270,6 +1270,10 @@
"bytes": {
"type": "long"
},
"id": {
"ignore_above": 1024,
"type": "keyword"
},
"method": {
"ignore_above": 1024,
"type": "keyword"
Expand Down
4 changes: 4 additions & 0 deletions generated/elasticsearch/7/template.json
Original file line number Diff line number Diff line change
Expand Up @@ -1233,6 +1233,10 @@
"bytes": {
"type": "long"
},
"id": {
"ignore_above": 1024,
"type": "keyword"
},
"method": {
"ignore_above": 1024,
"type": "keyword"
Expand Down
4 changes: 4 additions & 0 deletions generated/elasticsearch/component/http.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
"bytes": {
"type": "long"
},
"id": {
"ignore_above": 1024,
"type": "keyword"
},
"method": {
"ignore_above": 1024,
"type": "keyword"
Expand Down
13 changes: 13 additions & 0 deletions schemas/http.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@
type: group
fields:

- name: request.id
level: extended
type: keyword
short: HTTP request ID.
description: >
A unique identifier for each HTTP request to correlate logs between clients
and servers in transactions.
The id may be contained in a non-standard HTTP header, such as `X-Request-ID`
or `X-Correlation-ID`.
example: 123e4567-e89b-12d3-a456-426614174000

- name: request.method
level: extended
type: keyword
Expand Down

0 comments on commit 5e84e9e

Please sign in to comment.