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.

Sign up for GitHub

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

Document process.env.whitelist config option #3694

Merged
merged 2 commits into from
Mar 3, 2017
Merged

Document process.env.whitelist config option #3694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00b5a5c
Document process.env.whitelist config option
andrewkroh Feb 28, 2017
ad9da9a
Add reason behind default behavior for process env vars
andrewkroh Mar 1, 2017
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
1 change: 1 addition & 0 deletions CHANGELOG.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,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
View file
Open in desktop
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_.*'
----