Skip to content

Commit

Permalink
Document process.env.whitelist config option (#3694)
Browse files Browse the repository at this point in the history
* Document process.env.whitelist config option

Document `process.env.whitelist` which is used by the Metricbeat system process metricset to specify what environment variables should be captured.

Adds documentation for #3337.

* Add reason behind default behavior for process env vars
  • Loading branch information
andrewkroh authored and ruflin committed Mar 3, 2017
1 parent e7a4908 commit f9ac9f2
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ https://github.com/elastic/beats/compare/v5.1.1...master[Check the HEAD diff]
- Add Beta php_fpm module with pool metricset. {pull}3415[3415]
- The Docker, Kafka, and Prometheus modules are now Beta, instead of experimental. {pull}3525[3525]
- The HAProxy module is now GA, instead of experimental. {pull}3525[3525]
- Add the ability to collect the environment variables from system processes. {pull}3337[3337]

*Packetbeat*
- Add `fields` and `fields_under_root` to packetbeat protocols configurations. {pull}3518[3518]
Expand Down
18 changes: 18 additions & 0 deletions metricbeat/module/system/process/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,21 @@ On Linux this metricset will collect metrics from any cgroups that the process
is a member of. This feature is enabled by default and can be disabled by adding
`process.cgroup.enabled: false` to the system module configuration.

[float]
=== Process Environment Variables

This metricset can collect the environment variables that were used to start the
process. This feature is available on Linux, Darwin, and FreeBSD. No environment
variables are collected by default because they could contain sensitive information.
You must configure the environment variables that you wish to collect by
specifying a list of regular expressions that match the variable name.

[source,yaml]
----
metricbeat.modules:
- module: system
metricsets: ["process"]
process.env.whitelist:
- '^PATH$'
- '^SSH_.*'
----

0 comments on commit f9ac9f2

Please sign in to comment.