Skip to content

Consistently map message field in windows integrations #2008

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

Merged
merged 2 commits into from
Oct 26, 2021
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
5 changes: 5 additions & 0 deletions packages/system/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.6.0"
changes:
- description: Consistently map message field in Windows integrations.
type: bugfix
link: https://github.com/elastic/integrations/pull/2008
- version: "1.5.0"
changes:
- description: Better user mappings for security events
Expand Down
2 changes: 2 additions & 0 deletions packages/system/data_stream/application/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@
name: event.ingested
- external: ecs
name: event.original
- external: ecs
name: message
2 changes: 2 additions & 0 deletions packages/system/data_stream/security/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@
name: log.file.path
- external: ecs
name: log.level
- external: ecs
name: message
- external: ecs
name: process.args
- external: ecs
Expand Down
2 changes: 2 additions & 0 deletions packages/system/data_stream/system/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,5 @@
name: event.sequence
- external: ecs
name: event.type
- external: ecs
name: message
3 changes: 3 additions & 0 deletions packages/system/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ The Windows `application` dataset provides events from the Windows
| host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword |
| host.os.version | Operating system version as a raw string. | keyword |
| host.type | Type of host. For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment. | keyword |
| message | For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. If multiple messages exist, they can be combined into one message. | match_only_text |
| winlog.activity_id | A globally unique identifier that identifies the current activity. The events that are published with this identifier are part of the same activity. | keyword |
| winlog.api | The event log API type used to read the record. The possible values are "wineventlog" for the Windows Event Log API or "eventlogging" for the Event Logging API. The Event Logging API was designed for Windows Server 2003 or Windows 2000 operating systems. In Windows Vista, the event logging infrastructure was redesigned. On Windows Vista or later operating systems, the Windows Event Log API is used. Winlogbeat automatically detects which API to use for reading event logs. | keyword |
| winlog.channel | The name of the channel from which this record was read. This value is one of the names from the `event_logs` collection in the configuration. | keyword |
Expand Down Expand Up @@ -261,6 +262,7 @@ event log.
| host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword |
| host.os.version | Operating system version as a raw string. | keyword |
| host.type | Type of host. For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment. | keyword |
| message | For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. If multiple messages exist, they can be combined into one message. | match_only_text |
| winlog.activity_id | A globally unique identifier that identifies the current activity. The events that are published with this identifier are part of the same activity. | keyword |
| winlog.api | The event log API type used to read the record. The possible values are "wineventlog" for the Windows Event Log API or "eventlogging" for the Event Logging API. The Event Logging API was designed for Windows Server 2003 or Windows 2000 operating systems. In Windows Vista, the event logging infrastructure was redesigned. On Windows Vista or later operating systems, the Windows Event Log API is used. Winlogbeat automatically detects which API to use for reading event logs. | keyword |
| winlog.channel | The name of the channel from which this record was read. This value is one of the names from the `event_logs` collection in the configuration. | keyword |
Expand Down Expand Up @@ -537,6 +539,7 @@ An example event for `security` looks as following:
| input.type | Type of Filebeat input. | keyword |
| log.file.path | Full path to the log file this event came from, including the file name. It should include the drive letter, when appropriate. If the event wasn't read from a log file, do not populate this field. | keyword |
| log.level | Original log level of the log event. If 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). Some examples are `warn`, `err`, `i`, `informational`. | keyword |
| message | For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. If multiple messages exist, they can be combined into one message. | match_only_text |
| process.args | Array of process arguments, starting with the absolute path to the executable. May be filtered to protect sensitive information. | keyword |
| process.args_count | Length of the process.args array. This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity. | long |
| process.command_line | Full command line that started the process, including the absolute path to the executable, and all arguments. Some arguments may be filtered to protect sensitive information. | wildcard |
Expand Down
2 changes: 1 addition & 1 deletion packages/system/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
format_version: 1.0.0
name: system
title: System
version: 1.5.0
version: 1.6.0
license: basic
description: This Elastic integration collects logs and metrics from your servers
type: integration
Expand Down
5 changes: 5 additions & 0 deletions packages/windows/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.3.0"
changes:
- description: Consistently map message field in Windows integrations.
type: bugfix
link: https://github.com/elastic/integrations/pull/2008
- version: "1.2.3"
changes:
- description: Fix ingest pipeline templating for related.ip
Expand Down
2 changes: 2 additions & 0 deletions packages/windows/data_stream/powershell/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
name: host.name
- external: ecs
name: log.level
- external: ecs
name: message
- external: ecs
name: process.args
- external: ecs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
name: host.name
- external: ecs
name: log.level
- external: ecs
name: message
- external: ecs
name: process.args
- external: ecs
Expand Down
2 changes: 2 additions & 0 deletions packages/windows/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ An example event for `powershell` looks as following:
| host.type | Type of host. For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment. | keyword |
| input.type | Type of Filebeat input. | keyword |
| log.level | Original log level of the log event. If 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). Some examples are `warn`, `err`, `i`, `informational`. | keyword |
| message | For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. If multiple messages exist, they can be combined into one message. | match_only_text |
| powershell.command.invocation_details | An array of objects containing detailed information of the executed command. | array |
| powershell.command.invocation_details.name | Only used for ParameterBinding detail type. Indicates the parameter name. | keyword |
| powershell.command.invocation_details.related_command | The command to which the detail is related to. | keyword |
Expand Down Expand Up @@ -614,6 +615,7 @@ An example event for `powershell_operational` looks as following:
| host.type | Type of host. For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment. | keyword |
| input.type | Type of Filebeat input. | keyword |
| log.level | Original log level of the log event. If 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). Some examples are `warn`, `err`, `i`, `informational`. | keyword |
| message | For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. If multiple messages exist, they can be combined into one message. | match_only_text |
| powershell.command.invocation_details | An array of objects containing detailed information of the executed command. | array |
| powershell.command.invocation_details.name | Only used for ParameterBinding detail type. Indicates the parameter name. | keyword |
| powershell.command.invocation_details.related_command | The command to which the detail is related to. | keyword |
Expand Down
2 changes: 1 addition & 1 deletion packages/windows/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: windows
title: Windows
version: 1.2.3
version: 1.3.0
description: This Elastic integration collects logs and metrics from Windows
type: integration
categories:
Expand Down
5 changes: 5 additions & 0 deletions packages/winlog/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.1.0"
changes:
- description: Consistently map message field in Windows integrations.
type: bugfix
link: https://github.com/elastic/integrations/pull/2008
- version: "1.0.3"
changes:
- description: Update Title and Description.
Expand Down
2 changes: 2 additions & 0 deletions packages/winlog/data_stream/winlog/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
external: ecs
- name: log.level
external: ecs
- name: message
external: ecs
1 change: 1 addition & 0 deletions packages/winlog/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ To configure Splunk Enterprise to be able to pull events from it, please visit
| event.module | Event module | constant_keyword |
| input.type | Type of Filebeat input. | keyword |
| log.level | Original log level of the log event. If 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). Some examples are `warn`, `err`, `i`, `informational`. | keyword |
| message | For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. If multiple messages exist, they can be combined into one message. | text |
| tags | User defined tags | keyword |
| winlog.activity_id | A globally unique identifier that identifies the current activity. The events that are published with this identifier are part of the same activity. | keyword |
| winlog.api | The event log API type used to read the record. The possible values are "wineventlog" for the Windows Event Log API or "eventlogging" for the Event Logging API. The Event Logging API was designed for Windows Server 2003 or Windows 2000 operating systems. In Windows Vista, the event logging infrastructure was redesigned. On Windows Vista or later operating systems, the Windows Event Log API is used. Winlogbeat automatically detects which API to use for reading event logs. | keyword |
Expand Down
2 changes: 1 addition & 1 deletion packages/winlog/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: winlog
title: Custom Windows event logs
description: Collect event logs from Windows with Elastic Agent.
type: integration
version: 1.0.3
version: 1.1.0
release: ga
conditions:
kibana.version: '^7.16.0'
Expand Down