Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename .full.yml to .reference.yml
Browse files Browse the repository at this point in the history
This renaming should help to better explain what the `full` config file is about.
ruflin committed Jun 27, 2017

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent d09da0c commit fa1e2b3
Showing 67 changed files with 71 additions and 70 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
@@ -15,6 +15,7 @@ https://github.com/elastic/beats/compare/v6.0.0-alpha2...master[Check the HEAD d
*Affecting all Beats*

- Rename `kubernetes` processor to `add_kubernetes_metadata`. {pull}4473[4473]
- Rename `*.full.yml` config files to `*.reference.yml`. {pull}

*Filebeat*

2 changes: 1 addition & 1 deletion auditbeat/.gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
build
_meta/kibana
_meta/beat.yml
_meta/beat.full.yml
_meta/beat.reference.yml

/auditbeat
/auditbeat.test
4 changes: 2 additions & 2 deletions auditbeat/Makefile
Original file line number Diff line number Diff line change
@@ -26,8 +26,8 @@ fields: python-env
configs: python-env
@cp ${ES_BEATS}/auditbeat/_meta/common.yml _meta/beat.yml
@${PYTHON_ENV}/bin/python ${ES_BEATS}/script/config_collector.py --beat ${BEAT_NAME} $(PWD) >> _meta/beat.yml
@cp ${ES_BEATS}/auditbeat/_meta/common.full.yml _meta/beat.full.yml
@${PYTHON_ENV}/bin/python ${ES_BEATS}/script/config_collector.py --beat ${BEAT_NAME} --full $(PWD) >> _meta/beat.full.yml
@cp ${ES_BEATS}/auditbeat/_meta/common.reference.yml _meta/beat.reference.yml
@${PYTHON_ENV}/bin/python ${ES_BEATS}/script/config_collector.py --beat ${BEAT_NAME} --full $(PWD) >> _meta/beat.reference.yml

# Collects all module docs
.PHONY: collect-docs
2 changes: 1 addition & 1 deletion auditbeat/_meta/beat.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
###################### Auditbeat Configuration Example #######################

# This file is an example configuration file highlighting only the most common
# options. The auditbeat.full.yml file from the same directory contains all the
# options. The auditbeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
File renamed without changes.
2 changes: 1 addition & 1 deletion auditbeat/_meta/common.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
###################### Auditbeat Configuration Example #######################

# This file is an example configuration file highlighting only the most common
# options. The auditbeat.full.yml file from the same directory contains all the
# options. The auditbeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
File renamed without changes.
2 changes: 1 addition & 1 deletion auditbeat/auditbeat.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
###################### Auditbeat Configuration Example #######################

# This file is an example configuration file highlighting only the most common
# options. The auditbeat.full.yml file from the same directory contains all the
# options. The auditbeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
2 changes: 1 addition & 1 deletion dev-tools/packer/platforms/binary/run.sh.j2
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ cp -a homedir/. /{{.beat_name}}-${VERSION}-linux-{{.bin_arch}}/
install -D -m 755 import_dashboards-linux-{{.arch}} /{{.beat_name}}-${VERSION}-linux-{{.bin_arch}}/scripts/import_dashboards
cp {{.beat_name}}-linux-{{.arch}} /{{.beat_name}}-${VERSION}-linux-{{.bin_arch}}/{{.beat_name}}
cp {{.beat_name}}-linux.yml /{{.beat_name}}-${VERSION}-linux-{{.bin_arch}}/{{.beat_name}}.yml
cp {{.beat_name}}-linux.full.yml /{{.beat_name}}-${VERSION}-linux-{{.bin_arch}}/{{.beat_name}}.full.yml
cp {{.beat_name}}-linux.reference.yml /{{.beat_name}}-${VERSION}-linux-{{.bin_arch}}/{{.beat_name}}.reference.yml
cp fields.yml /{{.beat_name}}-${VERSION}-linux-{{.bin_arch}}/

mkdir -p upload
2 changes: 1 addition & 1 deletion dev-tools/packer/platforms/centos/run.sh.j2
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ fpm --force -s dir -t rpm \
beatname-${RUNID}.sh=/usr/bin/{{.beat_name}}.sh \
{{.beat_name}}-linux-{{.arch}}=/usr/share/{{.beat_name}}/bin/{{.beat_name}} \
{{.beat_name}}-linux.yml=/etc/{{.beat_name}}/{{.beat_name}}.yml \
{{.beat_name}}-linux.full.yml=/etc/{{.beat_name}}/{{.beat_name}}.full.yml \
{{.beat_name}}-linux.reference.yml=/etc/{{.beat_name}}/{{.beat_name}}.reference.yml \
fields.yml=/etc/{{.beat_name}}/fields.yml \
${RUNID}.service=/lib/systemd/system/{{.beat_name}}.service \
god-linux-{{.arch}}=/usr/share/{{.beat_name}}/bin/{{.beat_name}}-god \
2 changes: 1 addition & 1 deletion dev-tools/packer/platforms/darwin/run.sh.j2
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ cp -a homedir/. /{{.beat_name}}-${VERSION}-darwin-x86_64/
install -D -m 755 import_dashboards-darwin-{{.arch}} /{{.beat_name}}-${VERSION}-darwin-x86_64/scripts/import_dashboards
cp {{.beat_name}}-darwin-amd64 /{{.beat_name}}-${VERSION}-darwin-x86_64/{{.beat_name}}
cp {{.beat_name}}-darwin.yml /{{.beat_name}}-${VERSION}-darwin-x86_64/{{.beat_name}}.yml
cp {{.beat_name}}-darwin.full.yml /{{.beat_name}}-${VERSION}-darwin-x86_64/{{.beat_name}}.full.yml
cp {{.beat_name}}-darwin.reference.yml /{{.beat_name}}-${VERSION}-darwin-x86_64/{{.beat_name}}.reference.yml
cp fields.yml /{{.beat_name}}-${VERSION}-darwin-x86_64/

mkdir -p upload
2 changes: 1 addition & 1 deletion dev-tools/packer/platforms/debian/run.sh.j2
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ fpm --force -s dir -t deb \
beatname-${RUNID}.sh=/usr/bin/{{.beat_name}}.sh \
{{.beat_name}}-linux-{{.arch}}=/usr/share/{{.beat_name}}/bin/{{.beat_name}} \
{{.beat_name}}-linux.yml=/etc/{{.beat_name}}/{{.beat_name}}.yml \
{{.beat_name}}-linux.full.yml=/etc/{{.beat_name}}/{{.beat_name}}.full.yml \
{{.beat_name}}-linux.reference.yml=/etc/{{.beat_name}}/{{.beat_name}}.reference.yml \
fields.yml=/etc/{{.beat_name}}/fields.yml \
${RUNID}.service=/lib/systemd/system/{{.beat_name}}.service \
god-linux-{{.arch}}=/usr/share/{{.beat_name}}/bin/{{.beat_name}}-god \
2 changes: 1 addition & 1 deletion dev-tools/packer/platforms/windows/run.sh.j2
Original file line number Diff line number Diff line change
@@ -16,7 +16,7 @@ install -D -m 755 import_dashboards-windows-{{.arch}} /{{.beat_name}}-${VERSION}
cp {{.beat_name}}-windows-{{.arch}}.exe /{{.beat_name}}-${VERSION}-windows-{{.win_arch}}/{{.beat_name}}.exe
unix2dos {{.beat_name}}-win.yml
cp {{.beat_name}}-win.yml /{{.beat_name}}-${VERSION}-windows-{{.win_arch}}/{{.beat_name}}.yml
cp {{.beat_name}}-win.full.yml /{{.beat_name}}-${VERSION}-windows-{{.win_arch}}/{{.beat_name}}.full.yml
cp {{.beat_name}}-win.reference.yml /{{.beat_name}}-${VERSION}-windows-{{.win_arch}}/{{.beat_name}}.reference.yml
cp fields.yml /{{.beat_name}}-${VERSION}-windows-{{.win_arch}}/
cp install-service-{{.beat_name}}.ps1 /{{.beat_name}}-${VERSION}-windows-{{.win_arch}}/
cp uninstall-service-{{.beat_name}}.ps1 /{{.beat_name}}-${VERSION}-windows-{{.win_arch}}/
6 changes: 3 additions & 3 deletions dev-tools/packer/xgo-scripts/before_build.sh
Original file line number Diff line number Diff line change
@@ -18,17 +18,17 @@ cp fields.yml $PREFIX/fields.yml
# linux
cp $BEAT_NAME.yml $PREFIX/$BEAT_NAME-linux.yml
chmod 0600 $PREFIX/$BEAT_NAME-linux.yml
cp $BEAT_NAME.full.yml $PREFIX/$BEAT_NAME-linux.full.yml
cp $BEAT_NAME.reference.yml $PREFIX/$BEAT_NAME-linux.reference.yml

# darwin
cp $BEAT_NAME.yml $PREFIX/$BEAT_NAME-darwin.yml
chmod 0600 $PREFIX/$BEAT_NAME-darwin.yml
cp $BEAT_NAME.full.yml $PREFIX/$BEAT_NAME-darwin.full.yml
cp $BEAT_NAME.reference.yml $PREFIX/$BEAT_NAME-darwin.reference.yml

# win
cp $BEAT_NAME.yml $PREFIX/$BEAT_NAME-win.yml
chmod 0600 $PREFIX/$BEAT_NAME-win.yml
cp $BEAT_NAME.full.yml $PREFIX/$BEAT_NAME-win.full.yml
cp $BEAT_NAME.reference.yml $PREFIX/$BEAT_NAME-win.reference.yml

# Runs beat specific tasks which should be done before building
PREFIX=$PREFIX make before-build
4 changes: 2 additions & 2 deletions docs/devguide/create-module.asciidoc
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@ metricset by running `make create-metricset`, default versions of these files ar
[float]
==== Module Files

* `config.yml` and `config.full.yml`
* `config.yml` and `config.reference.yml`
* `docs.asciidoc`
* `fields.yml`

@@ -20,7 +20,7 @@ files are updated.


[float]
===== config.yml and config.full.yml
===== config.yml and config.reference.yml

The `config.yml` file contains the basic configuration options and looks like this:

2 changes: 1 addition & 1 deletion filebeat/.gitignore
Original file line number Diff line number Diff line change
@@ -8,5 +8,5 @@ build
_meta/kibana
_meta/module.generated
_meta/beat.yml
_meta/beat.full.yml
_meta/beat.reference.yml
/tests/load/logs
6 changes: 3 additions & 3 deletions filebeat/Makefile
Original file line number Diff line number Diff line change
@@ -41,9 +41,9 @@ configs: python-env
cat ${ES_BEATS}/filebeat/_meta/common.p1.yml > _meta/beat.yml
. ${PYTHON_ENV}/bin/activate; python ${ES_BEATS}/script/config_collector.py --beat ${BEAT_NAME} $(PWD) >> _meta/beat.yml
cat ${ES_BEATS}/filebeat/_meta/common.p2.yml >> _meta/beat.yml
cat ${ES_BEATS}/filebeat/_meta/common.full.p1.yml > _meta/beat.full.yml
. ${PYTHON_ENV}/bin/activate; python ${ES_BEATS}/script/config_collector.py --beat ${BEAT_NAME} --full $(PWD) >> _meta/beat.full.yml
cat ${ES_BEATS}/filebeat/_meta/common.full.p2.yml >> _meta/beat.full.yml
cat ${ES_BEATS}/filebeat/_meta/common.reference.p1.yml > _meta/beat.reference.yml
. ${PYTHON_ENV}/bin/activate; python ${ES_BEATS}/script/config_collector.py --beat ${BEAT_NAME} --full $(PWD) >> _meta/beat.reference.yml
cat ${ES_BEATS}/filebeat/_meta/common.reference.p2.yml >> _meta/beat.reference.yml

# Collects all module docs
.PHONY: collect-docs
2 changes: 1 addition & 1 deletion filebeat/_meta/common.p1.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
###################### Filebeat Configuration Example #########################

# This file is an example configuration file highlighting only the most common
# options. The filebeat.full.yml file from the same directory contains all the
# options. The filebeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
2 changes: 1 addition & 1 deletion filebeat/_meta/common.p2.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# For more available modules and options, please see the filebeat.full.yml sample
# For more available modules and options, please see the filebeat.reference.yml sample
# configuration file.

#=========================== Filebeat prospectors =============================
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions filebeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
@@ -5,11 +5,11 @@
--
After following the <<filebeat-configuration,configuration steps>> in the
Getting Started, you might want to fine tune the behavior of Filebeat. This section
describes some common use cases for changing configuration options.
describes some common use cases for changing configuration options.

To configure {beatname_uc}, you edit the configuration file. For rpm and deb, you’ll find the default configuration file at
+/etc/{beatname_lc}/{beatname_lc}.yml+. There's also a full example configuration file at
+/etc/{beatname_lc}/{beatname_lc}.full.yml+ that shows all non-deprecated options. For mac and win, look in the archive that you extracted.
+/etc/{beatname_lc}/{beatname_lc}.reference.yml+ that shows all non-deprecated options. For mac and win, look in the archive that you extracted.

See the
{libbeat}/config-file-format.html[Config File Format] section of the
2 changes: 1 addition & 1 deletion filebeat/docs/modules-overview.asciidoc
Original file line number Diff line number Diff line change
@@ -110,7 +110,7 @@ Then you can start Filebeat simply with: `./filebeat -e`.

Each module and fileset has a set of "variables" which allow adjusting their
behaviour. To see the available variables, you can consult the
`filebeat.full.yml` file. For example, all filesets allow setting a custom
`filebeat.reference.yml` file. For example, all filesets allow setting a custom
`paths` value, which is a list of Globs where the log files are searched.

These variables have default values, sometimes depending on the operating
File renamed without changes.
4 changes: 2 additions & 2 deletions filebeat/filebeat.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
###################### Filebeat Configuration Example #########################

# This file is an example configuration file highlighting only the most common
# options. The filebeat.full.yml file from the same directory contains all the
# options. The filebeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
@@ -94,7 +94,7 @@ filebeat.modules:
#var.paths:


# For more available modules and options, please see the filebeat.full.yml sample
# For more available modules and options, please see the filebeat.reference.yml sample
# configuration file.

#=========================== Filebeat prospectors =============================
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion heartbeat/_meta/beat.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
################### Heartbeat Configuration Example #########################

# This file is an example configuration file highlighting only some common options.
# The heartbeat.full.yml file in the same directory contains all the supported options
# The heartbeat.reference.yml file in the same directory contains all the supported options
# with detailed comments. You can use it for reference.
#
# You can find the full configuration reference here:
2 changes: 1 addition & 1 deletion heartbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ This section describes some common use cases for changing configuration options.
To configure Heartbeat, you edit the configuration file. For rpm and deb,
you’ll find the default configuration file at
+/etc/heartbeat/heartbeat.yml+. There's also a full example
configuration file at +/etc/heartbeat/heartbeat.full.yml+ that shows
configuration file at +/etc/heartbeat/heartbeat.reference.yml+ that shows
all non-deprecated options. For mac and win, look in the archive that you
extracted.

File renamed without changes.
2 changes: 1 addition & 1 deletion heartbeat/heartbeat.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
################### Heartbeat Configuration Example #########################

# This file is an example configuration file highlighting only some common options.
# The heartbeat.full.yml file in the same directory contains all the supported options
# The heartbeat.reference.yml file in the same directory contains all the supported options
# with detailed comments. You can use it for reference.
#
# You can find the full configuration reference here:
2 changes: 1 addition & 1 deletion libbeat/.gitignore
Original file line number Diff line number Diff line change
@@ -26,5 +26,5 @@ _testmain.go
.jenkins

/libbeat.yml
/libbeat.full.yml
/libbeat.reference.yml
/docs/fields.asciidoc
2 changes: 1 addition & 1 deletion libbeat/Makefile
Original file line number Diff line number Diff line change
@@ -16,4 +16,4 @@ fields:
collect: fields

clean::
rm -rf libbeat.full.yml libbeat.yml
rm -rf libbeat.reference.yml libbeat.yml
File renamed without changes.
2 changes: 1 addition & 1 deletion libbeat/docs/shared-configuring.asciidoc
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@ To configure {beatname_uc}, you edit the configuration file. For rpm and deb,
you'll find the configuration file at +/etc/{beatname_lc}/{beatname_lc}.yml+. Under
Docker, it's located at +/usr/share/{beatname_lc}/{beatname_lc}.yml+. For mac and win,
look in the archive that you just extracted. There’s also a full example
configuration file called +{beatname_lc}.full.yml+ that shows all non-deprecated
configuration file called +{beatname_lc}.reference.yml+ that shows all non-deprecated
options.

See the
10 changes: 5 additions & 5 deletions libbeat/scripts/Makefile
Original file line number Diff line number Diff line change
@@ -119,7 +119,7 @@ clean:: ## @build Cleans up all files generated by the build steps
# Remove generated fields docs
rm -f _meta/fields.generated.yml fields.yml
# Remove config files and fields which will be generated
rm -f ${BEAT_NAME}.yml {BEAT_NAME}.full.yml
rm -f ${BEAT_NAME}.yml {BEAT_NAME}.reference.yml
# Clean index pattern
rm -f $(PWD)/_meta/kibana/index-pattern/${BEAT_NAME}.json
# Remove temp templates
@@ -260,13 +260,13 @@ update: python-env collect
# Update config
echo "Update config file"
cat _meta/beat.yml ${ES_BEATS}/libbeat/_meta/config.yml | sed -e "s/beatname/${BEAT_NAME}/g" > ${BEAT_NAME}.yml
cat _meta/beat.yml ${ES_BEATS}/libbeat/_meta/config.full.yml | sed -e "s/beatname/${BEAT_NAME}/g" > ${BEAT_NAME}.full.yml
chmod go-w ${BEAT_NAME}.yml ${BEAT_NAME}.full.yml
cat _meta/beat.yml ${ES_BEATS}/libbeat/_meta/config.reference.yml | sed -e "s/beatname/${BEAT_NAME}/g" > ${BEAT_NAME}.reference.yml
chmod go-w ${BEAT_NAME}.yml ${BEAT_NAME}.reference.yml

# Check if also a full config exist (optional)
if [ -a _meta/beat.full.yml ] ; \
if [ -a _meta/beat.reference.yml ] ; \
then \
cat _meta/beat.full.yml ${ES_BEATS}/libbeat/_meta/config.full.yml | sed -e "s/beatname/${BEAT_NAME}/g" > ${BEAT_NAME}.full.yml ; \
cat _meta/beat.reference.yml ${ES_BEATS}/libbeat/_meta/config.reference.yml | sed -e "s/beatname/${BEAT_NAME}/g" > ${BEAT_NAME}.reference.yml ; \
fi;

# make sure generated docs in libbeat are up-to-date
2 changes: 1 addition & 1 deletion metricbeat/.gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
build
_meta/kibana
_meta/beat.yml
_meta/beat.full.yml
_meta/beat.reference.yml

/metricbeat
/metricbeat.test
8 changes: 4 additions & 4 deletions metricbeat/Makefile
Original file line number Diff line number Diff line change
@@ -50,8 +50,8 @@ configs: python-env
cat ${ES_BEATS}/metricbeat/_meta/common.yml > _meta/beat.yml
. ${PYTHON_ENV}/bin/activate; python ${ES_BEATS}/script/config_collector.py --beat ${BEAT_NAME} $(PWD) >> _meta/beat.yml
cat ${ES_BEATS}/metricbeat/_meta/setup.yml >> _meta/beat.yml
cat ${ES_BEATS}/metricbeat/_meta/common.full.yml > _meta/beat.full.yml
. ${PYTHON_ENV}/bin/activate; python ${ES_BEATS}/script/config_collector.py --beat ${BEAT_NAME} --full $(PWD) >> _meta/beat.full.yml
cat ${ES_BEATS}/metricbeat/_meta/common.reference.yml > _meta/beat.reference.yml
. ${PYTHON_ENV}/bin/activate; python ${ES_BEATS}/script/config_collector.py --beat ${BEAT_NAME} --full $(PWD) >> _meta/beat.reference.yml

# Generates imports for all modules and metricsets
.PHONY: imports
@@ -66,8 +66,8 @@ ifeq ($(BEAT_NAME), metricbeat)
# disable the system/load metricset on windows
sed -i.bk 's/- load/#- load/' $(PREFIX)/metricbeat-win.yml
rm $(PREFIX)/metricbeat-win.yml.bk
sed -i.bk 's/- load/#- load/' $(PREFIX)/metricbeat-win.full.yml
rm $(PREFIX)/metricbeat-win.full.yml.bk
sed -i.bk 's/- load/#- load/' $(PREFIX)/metricbeat-win.reference.yml
rm $(PREFIX)/metricbeat-win.reference.yml.bk
endif

# Runs all collection steps and updates afterwards
File renamed without changes.
2 changes: 1 addition & 1 deletion metricbeat/_meta/common.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
###################### Metricbeat Configuration Example #######################

# This file is an example configuration file highlighting only the most common
# options. The metricbeat.full.yml file from the same directory contains all the
# options. The metricbeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
12 changes: 6 additions & 6 deletions metricbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ This section describes some common use cases for changing configuration options.

To configure {beatname_uc}, you edit the configuration file. For rpm and deb, you’ll find the configuration file at
+/etc/{beatname_lc}/{beatname_lc}.yml+. There's also a full example configuration file at
+/etc/{beatname_lc}/{beatname_lc}.full.yml+ that shows all non-deprecated options.
+/etc/{beatname_lc}/{beatname_lc}.reference.yml+ that shows all non-deprecated options.
For mac and win, look in the archive that you extracted.

See the
@@ -33,12 +33,12 @@ A Metricbeat configuration contains a list of modules. Each module contains the

* `module`: The name of the module to run. For documentation about each module, see the <<metricbeat-modules>> section.
* `metricsets`: A list of metricsets to execute. For a list of available metricsets, see the documentation for the module.
* `enabled`: Specifies whether the module is enabled.
* `period`: How often the metricsets are executed.
* `enabled`: Specifies whether the module is enabled.
* `period`: How often the metricsets are executed.
* `hosts`: A list of hosts to fetch information from. For some modules, such as the System module, this setting is not required.
* `fields`: A dictionary of fields that will be sent with the metricset event. This setting is optional.
* `fields`: A dictionary of fields that will be sent with the metricset event. This setting is optional.
* `tags`: A list of tags that will be sent with the metricset event. This setting is optional.
* `filters`: With filters you can reduce the amount of data that is sent in the event. For more about the available filter options, see <<filtering-and-enhancing-data>>. This setting is optional.
* `filters`: With filters you can reduce the amount of data that is sent in the event. For more about the available filter options, see <<filtering-and-enhancing-data>>. This setting is optional.

The following example shows a basic configuration for the Apache module:

@@ -79,7 +79,7 @@ metricbeat:
enabled: true
----

For a module with multiple metricsets defined, it's possible to define the module twice and specify
For a module with multiple metricsets defined, it's possible to define the module twice and specify
a different period to use for each metricset. For the following example, the `set1` metricset will be fetched every
10 seconds, while the `set2` metricset will be fetched every 2 minutes:

File renamed without changes.
2 changes: 1 addition & 1 deletion metricbeat/metricbeat.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
###################### Metricbeat Configuration Example #######################

# This file is an example configuration file highlighting only the most common
# options. The metricbeat.full.yml file from the same directory contains all the
# options. The metricbeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
Loading

0 comments on commit fa1e2b3

Please sign in to comment.