Console

Forward

Synopsis

Creates a console target that writes log messages to the standard output. Supports field normalization to various logging standards through the field_format property.

Schema

- name: <string>
  description: <string>
  type: console
  status: <boolean>
  pipelines: <pipeline[]>
  properties:
    field_format: <string>

Configuration

The following are the fields used to define the target:

Field	Required	Default	Description
name	Y		Target name
description	N	-	Optional description
type	Y		Must be console
pipelines	N	-	Optional post-processor pipelines
status	N	true	Enable/disable the target
field_format	N	-	Data normalization format. See applicable Normalization section

Field format standards:

ecs	Elastic Common Schema
cim	Common Information Model
asim	Advanced Security Information Model

note

If no field_format is specified, log messages will be written to the console without any field normalization.

warning

Using field normalization may impact the performance with high message volumes.

Examples

Basic

Console use without field normalization:

targets:
  - name: basic_console
    type: console

ECS

Console use with ECS field normalization:

targets:
  - name: ecs_console
    type: console
    properties:
      field_format: "ecs"

note

For defails of ECS, see Appendix.

ASIM

Console use with ASIM field normalization:

targets:
  - name: asim_console
    type: console
    properties:
      field_format: "asim"

tip

For details of ASIM, see Appendix.