Skip to content

Commit

Permalink
[DOCS] Add output.console to Functionbeat doc and Functionbeat refere…
Browse files Browse the repository at this point in the history
…nce file (elastic#18965)

* Add outputconsole to Functionbeat doc

* Remove no_codec attirbute

* Updates following review
  • Loading branch information
EamonnTP committed Jun 11, 2020
1 parent 0867118 commit 5cd55f9
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 3 deletions.
2 changes: 2 additions & 0 deletions libbeat/outputs/console/docs/console.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

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`.

Expand Down
2 changes: 0 additions & 2 deletions x-pack/functionbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
12 changes: 12 additions & 0 deletions x-pack/functionbeat/functionbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 ====================================

Expand Down
2 changes: 1 addition & 1 deletion x-pack/functionbeat/scripts/mage/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 5cd55f9

Please sign in to comment.