Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quote the labels example, to avoid the YAML interpreter interpreting it #782

Merged
merged 2 commits into from
Mar 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ Thanks, you're awesome :-) -->

#### Bugfixes

* Quoted the example for `labels` to avoid YAML interpreting it, and having
slightly different results in different situations. #782

#### Added

#### Improvements
Expand Down
2 changes: 1 addition & 1 deletion docs/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ type: object



example: `{'application': 'foo-bar', 'env': 'production'}`
example: `{"application": "foo-bar", "env": "production"}`

| core

Expand Down
4 changes: 1 addition & 3 deletions generated/beats/fields.ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@
All values are stored as keyword.

Example: `docker` and `k8s` labels.'
example:
application: foo-bar
env: production
example: '{"application": "foo-bar", "env": "production"}'
- name: message
level: core
type: text
Expand Down
2 changes: 1 addition & 1 deletion generated/csv/fields.csv
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
1.6.0-dev,true,base,@timestamp,date,core,,2016-05-23T08:05:34.853Z,Date/time when the event originated.
1.6.0-dev,true,base,labels,object,core,,"{'application': 'foo-bar', 'env': 'production'}",Custom key/value pairs.
1.6.0-dev,true,base,labels,object,core,,"{""application"": ""foo-bar"", ""env"": ""production""}",Custom key/value pairs.
1.6.0-dev,true,base,message,text,core,,Hello World,Log message optimized for viewing in a log viewer.
1.6.0-dev,true,base,tags,keyword,core,array,"[""production"", ""env2""]",List of keywords used to tag each event.
1.6.0-dev,true,agent,agent.ephemeral_id,keyword,extended,,8a4f500f,Ephemeral identifier of this agent.
Expand Down
4 changes: 1 addition & 3 deletions generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3829,9 +3829,7 @@ labels:
All values are stored as keyword.

Example: `docker` and `k8s` labels.'
example:
application: foo-bar
env: production
example: '{"application": "foo-bar", "env": "production"}'
flat_name: labels
level: core
name: labels
Expand Down
4 changes: 1 addition & 3 deletions generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,7 @@ base:
All values are stored as keyword.

Example: `docker` and `k8s` labels.'
example:
application: foo-bar
env: production
example: '{"application": "foo-bar", "env": "production"}'
flat_name: labels
level: core
name: labels
Expand Down
2 changes: 1 addition & 1 deletion schemas/base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
level: core
type: object
object_type: keyword
example: {application: foo-bar, env: production}
example: "{\"application\": \"foo-bar\", \"env\": \"production\"}"
short: Custom key/value pairs.
description: >
Custom key/value pairs.
Expand Down