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

Expose some configuration values via SHOW DIAGNOSTICS #7821

Closed
mark-rushakoff opened this issue Jan 11, 2017 · 0 comments
Closed

Expose some configuration values via SHOW DIAGNOSTICS #7821

mark-rushakoff opened this issue Jan 11, 2017 · 0 comments

Comments

@mark-rushakoff
Copy link
Contributor

To reduce back-and-forth cycles between developers and users, we should include a subset of runtime configuration values in the output of SHOW DIAGNOSTICS. We already ask for diagnostics output in our issue template.

Rationale

  • SHOW DIAGNOSTICS output will reflect any configuration set as environment variables (which is higher precedence than the config file)
  • Diagnostics output is available without needing shell access to the machine running InfluxDB and without knowing where the config file resides on disk
  • Diagnostics output will not contain large and numerous blocks of comments like most config files do, so it will be easier for developers to read

Example configuration settings likely to be included

A configuration setting is likely to be included if it will help us diagnose issues users are experiencing.

  • data.cache-snapshot-memory-size
  • http.https-enabled
  • udp.batch-timeout

Example configuration settings likely to be excluded

A configuration setting will not be included if it is not helpful in troubleshooting or if exposing that value would make the system less secure.

  • data.query-log-enabled: whether certain logs are enabled is usually not interesting to developers
  • http.shared-secret: security-related, should not be exposed via any external tooling
@mark-rushakoff mark-rushakoff added this to the 1.3.0 milestone Jan 11, 2017
@mark-rushakoff mark-rushakoff self-assigned this Jan 11, 2017
mark-rushakoff added a commit that referenced this issue Feb 18, 2017
Including these config values in /debug/vars should eliminate the need
to ask for config file content separate from the /debug/vars output.

Fixes #7821
mark-rushakoff added a commit that referenced this issue Mar 14, 2017
This includes hand-selected config settings that are safe to expose and
not expected to include any kind of secrets.

Fixes #7821
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant