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.

Sign up for GitHub

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

Tidy trailing spaces and newlines #1667

Merged
merged 13 commits into from
Nov 18, 2021
Merged

Tidy trailing spaces and newlines #1667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
24c3648
apply yamllint and set sensible config
Nov 11, 2021
5f36b39
add artefacts
Nov 11, 2021
91ae993
Merge branch 'main' into apply_and_fix_yamllint
djptek Nov 11, 2021
59a5e18
Merge branch 'main' into apply_and_fix_yamllint
Nov 11, 2021
80024ef
update CHANGELOG
Nov 11, 2021
4b6c220
Merge branch 'apply_and_fix_yamllint' of http://github.com/djptek/ecs…
Nov 11, 2021
e097b4f
Merge branch 'main' into apply_and_fix_yamllint
djptek Nov 11, 2021
2e113ca
Merge branch 'main' into apply_and_fix_yamllint
djptek Nov 16, 2021
b1f2266
Merge branch 'elastic:main' into apply_and_fix_yamllint
djptek Nov 17, 2021
df17b04
Update CHANGELOG.next.md
djptek Nov 17, 2021
2423881
Update Makefile
djptek Nov 17, 2021
67f1155
Update Makefile
djptek Nov 17, 2021
021002b
Update CHANGELOG.next.md
djptek Nov 18, 2021
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
1 change: 1 addition & 0 deletions CHANGELOG.next.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Thanks, you're awesome :-) -->

#### Improvements

* Clean up trailing spaces and additional newlines in schemas #1667
* Update refs from master to main in USAGE.md etc #1658

#### Deprecated
Expand Down
35 changes: 18 additions & 17 deletions experimental/generated/beats/fields.ecs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,15 +491,15 @@
in the cloud, the field contains cloud data from the machine the service is
running on.

The cloud fields may be self-nested under cloud.origin.* and cloud.target.* to
describe origin or target service''s cloud information in the context of incoming
or outgoing requests, respectively. However, the fieldsets cloud.origin.* and
cloud.target.* must not be confused with the root cloud fieldset that is used
to describe the cloud context of the actual service under observation. The
fieldset cloud.origin.* may only be used in the context of incoming requests
or events to provide the originating service''s cloud information. The fieldset
cloud.target.* may only be used in the context of outgoing requests or events
to describe the target service''s cloud information.'
The cloud fields may be self-nested under cloud.origin.* and cloud.target.*
to describe origin or target service''s cloud information in the context of
incoming or outgoing requests, respectively. However, the fieldsets cloud.origin.*
and cloud.target.* must not be confused with the root cloud fieldset that is
used to describe the cloud context of the actual service under observation.
The fieldset cloud.origin.* may only be used in the context of incoming requests
or events to provide the originating service''s cloud information. The fieldset
cloud.target.* may only be used in the context of outgoing requests or events
to describe the target service''s cloud information.'
type: group
default_field: true
fields:
Expand Down Expand Up @@ -7091,14 +7091,15 @@
was collected.

These fields help you find and correlate logs for a specific service and version.'
footnote: The service fields may be self-nested under service.origin.* and service.target.* to
describe origin or target services in the context of incoming or outgoing requests, respectively.
However, the fieldsets service.origin.* and service.target.* must not be confused
with the root service fieldset that is used to describe the actual service
under observation. The fieldset service.origin.* may only be used in the context
of incoming requests or events to describe the originating service of the request.
The fieldset service.target.* may only be used in the context of outgoing requests
or events to describe the target service of the request.
footnote: The service fields may be self-nested under service.origin.* and service.target.*
to describe origin or target services in the context of incoming or outgoing
requests, respectively. However, the fieldsets service.origin.* and service.target.*
must not be confused with the root service fieldset that is used to describe
the actual service under observation. The fieldset service.origin.* may only
be used in the context of incoming requests or events to describe the originating
service of the request. The fieldset service.target.* may only be used in the
context of outgoing requests or events to describe the target service of the
request.
type: group
default_field: true
fields:
Expand Down
34 changes: 17 additions & 17 deletions experimental/generated/ecs/ecs_nested.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1246,15 +1246,15 @@ cloud:
in the cloud, the field contains cloud data from the machine the service is running
on.

The cloud fields may be self-nested under cloud.origin.* and cloud.target.* to
describe origin or target service''s cloud information in the context of incoming
or outgoing requests, respectively. However, the fieldsets cloud.origin.* and
cloud.target.* must not be confused with the root cloud fieldset that is used
to describe the cloud context of the actual service under observation. The fieldset
cloud.origin.* may only be used in the context of incoming requests or events
to provide the originating service''s cloud information. The fieldset cloud.target.*
may only be used in the context of outgoing requests or events to describe the
target service''s cloud information.'
The cloud fields may be self-nested under cloud.origin.* and cloud.target.* to
describe origin or target service''s cloud information in the context of incoming
or outgoing requests, respectively. However, the fieldsets cloud.origin.* and
cloud.target.* must not be confused with the root cloud fieldset that is used
to describe the cloud context of the actual service under observation. The fieldset
cloud.origin.* may only be used in the context of incoming requests or events
to provide the originating service''s cloud information. The fieldset cloud.target.*
may only be used in the context of outgoing requests or events to describe the
target service''s cloud information.'
group: 2
name: cloud
nestings:
Expand Down Expand Up @@ -12776,14 +12776,14 @@ service:
normalize: []
short: Version of the service.
type: keyword
footnote: The service fields may be self-nested under service.origin.* and service.target.* to
describe origin or target services in the context of incoming or outgoing requests, respectively.
However, the fieldsets service.origin.* and service.target.* must not be confused
with the root service fieldset that is used to describe the actual service under
observation. The fieldset service.origin.* may only be used in the context of
incoming requests or events to describe the originating service of the request.
The fieldset service.target.* may only be used in the context of outgoing requests
or events to describe the target service of the request.
footnote: The service fields may be self-nested under service.origin.* and service.target.*
to describe origin or target services in the context of incoming or outgoing requests,
respectively. However, the fieldsets service.origin.* and service.target.* must
not be confused with the root service fieldset that is used to describe the actual
service under observation. The fieldset service.origin.* may only be used in the
context of incoming requests or events to describe the originating service of
the request. The fieldset service.target.* may only be used in the context of
outgoing requests or events to describe the target service of the request.
group: 2
name: service
nestings:
Expand Down
35 changes: 18 additions & 17 deletions generated/beats/fields.ecs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,15 +441,15 @@
in the cloud, the field contains cloud data from the machine the service is
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot there were some fields with a footnote attribute!

I think this is good detail we should capture somehow in the documentation in addition to the schema.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ebeahan I hadn't noticed that - does footnote still add value or could we add an RFC to merge existing footnotes into description? From what I've seen they are mostly usage examples

running on.

The cloud fields may be self-nested under cloud.origin.* and cloud.target.* to
describe origin or target service''s cloud information in the context of incoming
or outgoing requests, respectively. However, the fieldsets cloud.origin.* and
cloud.target.* must not be confused with the root cloud fieldset that is used
to describe the cloud context of the actual service under observation. The
fieldset cloud.origin.* may only be used in the context of incoming requests
or events to provide the originating service''s cloud information. The fieldset
cloud.target.* may only be used in the context of outgoing requests or events
to describe the target service''s cloud information.'
The cloud fields may be self-nested under cloud.origin.* and cloud.target.*
to describe origin or target service''s cloud information in the context of
incoming or outgoing requests, respectively. However, the fieldsets cloud.origin.*
and cloud.target.* must not be confused with the root cloud fieldset that is
used to describe the cloud context of the actual service under observation.
The fieldset cloud.origin.* may only be used in the context of incoming requests
or events to provide the originating service''s cloud information. The fieldset
cloud.target.* may only be used in the context of outgoing requests or events
to describe the target service''s cloud information.'
type: group
default_field: true
fields:
Expand Down Expand Up @@ -5782,14 +5782,15 @@
was collected.

These fields help you find and correlate logs for a specific service and version.'
footnote: The service fields may be self-nested under service.origin.* and service.target.* to
describe origin or target services in the context of incoming or outgoing requests, respectively.
However, the fieldsets service.origin.* and service.target.* must not be confused
with the root service fieldset that is used to describe the actual service
under observation. The fieldset service.origin.* may only be used in the context
of incoming requests or events to describe the originating service of the request.
The fieldset service.target.* may only be used in the context of outgoing requests
or events to describe the target service of the request.
footnote: The service fields may be self-nested under service.origin.* and service.target.*
to describe origin or target services in the context of incoming or outgoing
requests, respectively. However, the fieldsets service.origin.* and service.target.*
must not be confused with the root service fieldset that is used to describe
the actual service under observation. The fieldset service.origin.* may only
be used in the context of incoming requests or events to describe the originating
service of the request. The fieldset service.target.* may only be used in the
context of outgoing requests or events to describe the target service of the
request.
type: group
default_field: true
fields:
Expand Down
34 changes: 17 additions & 17 deletions generated/ecs/ecs_nested.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1166,15 +1166,15 @@ cloud:
in the cloud, the field contains cloud data from the machine the service is running
on.

The cloud fields may be self-nested under cloud.origin.* and cloud.target.* to
describe origin or target service''s cloud information in the context of incoming
or outgoing requests, respectively. However, the fieldsets cloud.origin.* and
cloud.target.* must not be confused with the root cloud fieldset that is used
to describe the cloud context of the actual service under observation. The fieldset
cloud.origin.* may only be used in the context of incoming requests or events
to provide the originating service''s cloud information. The fieldset cloud.target.*
may only be used in the context of outgoing requests or events to describe the
target service''s cloud information.'
The cloud fields may be self-nested under cloud.origin.* and cloud.target.* to
describe origin or target service''s cloud information in the context of incoming
or outgoing requests, respectively. However, the fieldsets cloud.origin.* and
cloud.target.* must not be confused with the root cloud fieldset that is used
to describe the cloud context of the actual service under observation. The fieldset
cloud.origin.* may only be used in the context of incoming requests or events
to provide the originating service''s cloud information. The fieldset cloud.target.*
may only be used in the context of outgoing requests or events to describe the
target service''s cloud information.'
group: 2
name: cloud
nestings:
Expand Down Expand Up @@ -10544,14 +10544,14 @@ service:
normalize: []
short: Version of the service.
type: keyword
footnote: The service fields may be self-nested under service.origin.* and service.target.* to
describe origin or target services in the context of incoming or outgoing requests, respectively.
However, the fieldsets service.origin.* and service.target.* must not be confused
with the root service fieldset that is used to describe the actual service under
observation. The fieldset service.origin.* may only be used in the context of
incoming requests or events to describe the originating service of the request.
The fieldset service.target.* may only be used in the context of outgoing requests
or events to describe the target service of the request.
footnote: The service fields may be self-nested under service.origin.* and service.target.*
to describe origin or target services in the context of incoming or outgoing requests,
respectively. However, the fieldsets service.origin.* and service.target.* must
not be confused with the root service fieldset that is used to describe the actual
service under observation. The fieldset service.origin.* may only be used in the
context of incoming requests or events to describe the originating service of
the request. The fieldset service.target.* may only be used in the context of
outgoing requests or events to describe the target service of the request.
group: 2
name: service
nestings:
Expand Down
4 changes: 2 additions & 2 deletions schemas/as.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@
Organization name.
example: Google LLC
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text
18 changes: 9 additions & 9 deletions schemas/cloud.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@
running in the cloud, the field contains cloud data from the machine the
service is running on.

The cloud fields may be self-nested under cloud.origin.* and cloud.target.*
to describe origin or target service's cloud information in the context of
incoming or outgoing requests, respectively. However, the fieldsets
cloud.origin.* and cloud.target.* must not be confused with the root cloud
fieldset that is used to describe the cloud context of the actual service
under observation. The fieldset cloud.origin.* may only be used in the
context of incoming requests or events to provide the originating service's
cloud information. The fieldset cloud.target.* may only be used in the
context of outgoing requests or events to describe the target service's
The cloud fields may be self-nested under cloud.origin.* and cloud.target.*
to describe origin or target service's cloud information in the context of
incoming or outgoing requests, respectively. However, the fieldsets
cloud.origin.* and cloud.target.* must not be confused with the root cloud
fieldset that is used to describe the cloud context of the actual service
under observation. The fieldset cloud.origin.* may only be used in the
context of incoming requests or events to provide the originating service's
cloud information. The fieldset cloud.target.* may only be used in the
context of outgoing requests or events to describe the target service's
cloud information.
reusable:
top_level: true
Expand Down
2 changes: 1 addition & 1 deletion schemas/elf.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@
type: keyword
level: extended
normalize:
- array
- array

- name: telfhash
short: telfhash hash for ELF file.
Expand Down
4 changes: 2 additions & 2 deletions schemas/error.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@
description: >
The stack trace of this error in plain text.
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text
1 change: 0 additions & 1 deletion schemas/faas.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,3 @@
description: >
The ID of the trigger request , message, event, etc.
example: 123456789

1 change: 0 additions & 1 deletion schemas/group.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,3 @@
Name of the directory the group is a member of.

For example, an LDAP or Active Directory domain name.

8 changes: 4 additions & 4 deletions schemas/http.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@
The full HTTP request body.
example: Hello world
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text

- name: request.referrer
level: extended
Expand Down Expand Up @@ -110,8 +110,8 @@
The full HTTP response body.
example: Hello world
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text

- name: version
level: extended
Expand Down
4 changes: 2 additions & 2 deletions schemas/organization.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
description: >
Organization name.
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text

- name: id
level: extended
Expand Down
8 changes: 4 additions & 4 deletions schemas/os.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@
description: >
Operating system name, without the version.
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text

- name: full
level: extended
Expand All @@ -68,8 +68,8 @@
description: >
Operating system name, including the version or code name.
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text

- name: family
level: extended
Expand Down
20 changes: 10 additions & 10 deletions schemas/process.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@
Sometimes called program name or similar.
example: ssh
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text

- name: pgid
format: string
Expand All @@ -91,8 +91,8 @@
Some arguments may be filtered to protect sensitive information.
example: "/usr/bin/ssh -l user 10.0.0.16"
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text

- name: args
level: extended
Expand Down Expand Up @@ -125,8 +125,8 @@
Absolute path to the process executable.
example: /usr/bin/ssh
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text

- name: title
level: extended
Expand All @@ -138,8 +138,8 @@
The proctitle, some times the same as process name. Can also be different:
for example a browser setting its title to the web page currently opened.
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text

- name: thread.id
format: string
Expand Down Expand Up @@ -177,8 +177,8 @@
description: >
The working directory of the process.
multi_fields:
- type: match_only_text
name: text
- type: match_only_text
name: text

- name: exit_code
level: extended
Expand Down
1 change: 0 additions & 1 deletion schemas/registry.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,3 @@

For Windows registry operations, such as SetValueEx and RegQueryValueEx, this corresponds to the data pointed by `lp_data`.
This is optional but provides better recoverability and should be populated for REG_BINARY encoded values.

12 changes: 6 additions & 6 deletions schemas/service.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@
These fields help you find and correlate logs for a specific
service and version.
footnote: >
The service fields may be self-nested under service.origin.* and service.target.*
to describe origin or target services in the context of incoming or outgoing requests,
The service fields may be self-nested under service.origin.* and service.target.*
to describe origin or target services in the context of incoming or outgoing requests,
respectively.
However, the fieldsets service.origin.* and service.target.* must not be confused with
However, the fieldsets service.origin.* and service.target.* must not be confused with
the root service fieldset that is used to describe the actual service under observation.
The fieldset service.origin.* may only be used in the context of incoming requests or
events to describe the originating service of the request. The fieldset service.target.*
may only be used in the context of outgoing requests or events to describe the target
The fieldset service.origin.* may only be used in the context of incoming requests or
events to describe the originating service of the request. The fieldset service.target.*
may only be used in the context of outgoing requests or events to describe the target
service of the request.
reusable:
top_level: true
Expand Down
Loading