Skip to content
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

[7.7] [DOCS] Add output.console to Functionbeat doc and Functionbeat reference file (#18965) #19147

Merged
merged 3 commits into from
Jun 16, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
7 changes: 7 additions & 0 deletions libbeat/outputs/console/docs/console.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
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
18 changes: 17 additions & 1 deletion x-pack/functionbeat/functionbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 8 additions & 16 deletions x-pack/functionbeat/scripts/mage/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
EamonnTP marked this conversation as resolved.
Show resolved Hide resolved
}
}