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

Document process.env.whitelist config option #3694

Merged
merged 2 commits into from
Mar 3, 2017

Conversation

andrewkroh
Copy link
Member

@andrewkroh andrewkroh commented Feb 28, 2017

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.

Needs back port to 5.3.

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

Adds documentation for elastic#3337.
@andrewkroh andrewkroh added docs needs_backport PR is waiting to be backported to other branches. review v5.3.0 labels Feb 28, 2017

This metricset can collect the environment variables that were used to start the
process. This feature is available on Linux, Darwin, and FreeBSD. By default
no environment variables are collected. You must configure the environment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could mention here, that for security reasons no env variables are fetched by default.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the reasoning behind the behavior.

@ruflin ruflin merged commit f9ac9f2 into elastic:master Mar 3, 2017
@monicasarbu monicasarbu deleted the docs/process-env-vars branch March 4, 2017 07:20
monicasarbu pushed a commit to monicasarbu/beats that referenced this pull request Mar 4, 2017
* 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 elastic#3337.

* Add reason behind default behavior for process env vars

(cherry picked from commit f9ac9f2)
@monicasarbu monicasarbu removed the needs_backport PR is waiting to be backported to other branches. label Mar 4, 2017
ruflin pushed a commit that referenced this pull request Mar 6, 2017
* 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

(cherry picked from commit f9ac9f2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants