From f68f08ae23293422fd412c0b0624684afa656586 Mon Sep 17 00:00:00 2001 From: EamonnTP Date: Thu, 11 Jun 2020 22:43:00 +0100 Subject: [PATCH] [DOCS] Add output.console to Functionbeat doc and Functionbeat reference file (#18965) * Add outputconsole to Functionbeat doc * Remove no_codec attirbute * Updates following review # Conflicts: # libbeat/outputs/console/docs/console.asciidoc # x-pack/functionbeat/functionbeat.reference.yml # x-pack/functionbeat/scripts/mage/config.go --- libbeat/outputs/console/docs/console.asciidoc | 7 ++++++ x-pack/functionbeat/docs/index.asciidoc | 2 -- .../functionbeat/functionbeat.reference.yml | 18 +++++++++++++- x-pack/functionbeat/scripts/mage/config.go | 24 +++++++------------ 4 files changed, 32 insertions(+), 19 deletions(-) diff --git a/libbeat/outputs/console/docs/console.asciidoc b/libbeat/outputs/console/docs/console.asciidoc index 102eb13c7c8..ae25bb3dc0c 100644 --- a/libbeat/outputs/console/docs/console.asciidoc +++ b/libbeat/outputs/console/docs/console.asciidoc @@ -7,6 +7,13 @@ The Console output writes events in JSON format to stdout. +WARNING: The Console output should be used only for debugging issues as it can produce a large amount of logging data. + +To use this output, edit the {beatname_uc} configuration file to disable the {es} +output by commenting it out, and enable the console output by adding `output.console`. + +Example configuration: + [source,yaml] ------------------------------------------------------------------------------ output.console: diff --git a/x-pack/functionbeat/docs/index.asciidoc b/x-pack/functionbeat/docs/index.asciidoc index 28283ffd77f..fc6a1f933d9 100644 --- a/x-pack/functionbeat/docs/index.asciidoc +++ b/x-pack/functionbeat/docs/index.asciidoc @@ -20,8 +20,6 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :no_kafka_output: :no_redis_output: :no_file_output: -:no_console_output: -:no_codec: :requires_xpack: :serverless: :mac_os: diff --git a/x-pack/functionbeat/functionbeat.reference.yml b/x-pack/functionbeat/functionbeat.reference.yml index e6599e340e2..a40382e9616 100644 --- a/x-pack/functionbeat/functionbeat.reference.yml +++ b/x-pack/functionbeat/functionbeat.reference.yml @@ -896,7 +896,23 @@ output.elasticsearch: # timing out. The default is 30s. #timeout: 30s -#================================= Paths ====================================== + + + +# ------------------------------- Console Output ------------------------------- +#output.console: + # Boolean flag to enable or disable the output module. + #enabled: true + + # Configure JSON encoding + #codec.json: + # Pretty-print JSON event + #pretty: false + + # Configure escaping HTML symbols in strings. + #escape_html: false + +# =================================== Paths ==================================== # The home path for the Functionbeat installation. This is the default base path # for all other path settings and for miscellaneous files that come with the diff --git a/x-pack/functionbeat/scripts/mage/config.go b/x-pack/functionbeat/scripts/mage/config.go index 576fc765b12..1dba56dbe33 100644 --- a/x-pack/functionbeat/scripts/mage/config.go +++ b/x-pack/functionbeat/scripts/mage/config.go @@ -10,21 +10,13 @@ import ( // XPackConfigFileParams returns the configuration of sample and reference configuration data. func XPackConfigFileParams() devtools.ConfigFileParams { - return devtools.ConfigFileParams{ - ShortParts: []string{ - devtools.OSSBeatDir("_meta/beat.yml"), - devtools.LibbeatDir("_meta/config.yml.tmpl"), - }, - ReferenceParts: []string{ - devtools.OSSBeatDir("_meta/beat.reference.yml"), - devtools.LibbeatDir("_meta/config.reference.yml.tmpl"), - }, - ExtraVars: map[string]interface{}{ - "ExcludeConsole": true, - "ExcludeFileOutput": true, - "ExcludeKafka": true, - "ExcludeRedis": true, - "UseDockerMetadataProcessor": false, - }, + p := devtools.DefaultConfigFileParams() + p.Templates = append(p.Templates, "_meta/config/*.tmpl") + p.ExtraVars = map[string]interface{}{ + "ExcludeConsole": false, + "ExcludeFileOutput": true, + "ExcludeKafka": true, + "ExcludeRedis": true, + "UseDockerMetadataProcessor": false, } }