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

Beef up the description of the log field set. #540

Merged
merged 4 commits into from
Sep 26, 2019
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
7 changes: 6 additions & 1 deletion code/go/ecs/log.go

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

6 changes: 5 additions & 1 deletion docs/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2103,7 +2103,11 @@ example: `1.1`
[[ecs-log]]
=== Log Fields

Fields which are specific to log events.
Details about the event's logging mechanism or logging transport.

The log.* fields are typically populated with details about the logging mechanism used to create and/or transport the event. For example, syslog details belong under `log.syslog.*`.

The details specific to your event source are typically not logged under `log.*`, but rather in `event.*` or in other ECS fields.

==== Log Field Details

Expand Down
2 changes: 1 addition & 1 deletion docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ all fields are defined.

| <<ecs-http,HTTP>> | Fields describing an HTTP request.

| <<ecs-log,Log>> | Fields which are specific to log events.
| <<ecs-log,Log>> | Details about the event's logging mechanism.

| <<ecs-network,Network>> | Fields describing the communication path over which the event happened.

Expand Down
9 changes: 8 additions & 1 deletion generated/beats/fields.ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1590,7 +1590,14 @@
- name: log
title: Log
group: 2
description: Fields which are specific to log events.
description: 'Details about the event''s logging mechanism or logging transport.

The log.* fields are typically populated with details about the logging mechanism
used to create and/or transport the event. For example, syslog details belong
under `log.syslog.*`.

The details specific to your event source are typically not logged under `log.*`,
but rather in `event.*` or in other ECS fields.'
type: group
fields:
- name: level
Expand Down
11 changes: 9 additions & 2 deletions generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2571,7 +2571,14 @@ http:
title: HTTP
type: group
log:
description: Fields which are specific to log events.
description: 'Details about the event''s logging mechanism or logging transport.

The log.* fields are typically populated with details about the logging mechanism
used to create and/or transport the event. For example, syslog details belong
under `log.syslog.*`.

The details specific to your event source are typically not logged under `log.*`,
but rather in `event.*` or in other ECS fields.'
fields:
level:
description: 'Original log level of the log event.
Expand Down Expand Up @@ -2730,7 +2737,7 @@ log:
group: 2
name: log
prefix: log.
short: Fields which are specific to log events.
short: Details about the event's logging mechanism.
title: Log
type: group
network:
Expand Down
2 changes: 1 addition & 1 deletion schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -1533,7 +1533,7 @@
"type": "group"
},
"log": {
"description": "Fields which are specific to log events.\n",
"description": "Details about the event's logging mechanism or logging transport.\nThe log.* fields are typically populated with details about the logging mechanism used to create and/or transport the event. For example, syslog details belong under `log.syslog.*`.\nThe details specific to your event source are typically not logged under `log.*`, but rather in `event.*` or in other ECS fields.\n",
"fields": {
"log.level": {
"description": "Original log level of the log event.\nIf the source of the event provides a log level or textual severity, this is the one that goes in `log.level`. If your source doesn't specify one, you may put your event transport's severity here (e.g. Syslog severity).\nSome examples are `warn`, `err`, `i`, `informational`.",
Expand Down
10 changes: 9 additions & 1 deletion schemas/log.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@
- name: log
title: Log
group: 2
short: Details about the event's logging mechanism.
description: >
Fields which are specific to log events.
Details about the event's logging mechanism or logging transport.

The log.* fields are typically populated with details about the logging
mechanism used to create and/or transport the event.
For example, syslog details belong under `log.syslog.*`.

The details specific to your event source are typically not logged under `log.*`,
but rather in `event.*` or in other ECS fields.
type: group
fields:

Expand Down