From 8b1af4c697f687859616fef972323064d8897119 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 --- libbeat/outputs/console/docs/console.asciidoc | 7 +++++++ x-pack/functionbeat/docs/index.asciidoc | 2 -- x-pack/functionbeat/functionbeat.reference.yml | 12 ++++++++++++ x-pack/functionbeat/scripts/mage/config.go | 2 +- 4 files changed, 20 insertions(+), 3 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 61cf8a20042..4f605027459 100644 --- a/x-pack/functionbeat/functionbeat.reference.yml +++ b/x-pack/functionbeat/functionbeat.reference.yml @@ -930,6 +930,18 @@ output.elasticsearch: +# ------------------------------- 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 ==================================== diff --git a/x-pack/functionbeat/scripts/mage/config.go b/x-pack/functionbeat/scripts/mage/config.go index 7fb4395e2bc..1d3e773d602 100644 --- a/x-pack/functionbeat/scripts/mage/config.go +++ b/x-pack/functionbeat/scripts/mage/config.go @@ -13,7 +13,7 @@ func XPackConfigFileParams() devtools.ConfigFileParams { p := devtools.DefaultConfigFileParams() p.Templates = append(p.Templates, "_meta/config/*.tmpl") p.ExtraVars = map[string]interface{}{ - "ExcludeConsole": true, + "ExcludeConsole": false, "ExcludeFileOutput": true, "ExcludeKafka": true, "ExcludeRedis": true,