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

[DOCS] enabling logging.verbose depends on silent and quiet settings being false #74827

Closed
wants to merge 3 commits into from

Conversation

geekpete
Copy link
Member

Summary

Doc fix to mention logging.verbose requires silent/quiet logging settings to be false or Kibana will fail to start

Checklist

For maintainers

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@geekpete
Copy link
Member Author

Probably needs all the backports to maintained versions as well.
Tested that Kibana fails to start if either of logging.silent or logging.quiet are set to true when logging.verbose is set to true, on versions 6.8.8, 7.1.1, 7.8.1

Copy link

@lockewritesdocs lockewritesdocs left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@@ -304,7 +304,7 @@ list of timezones, refer to https://en.wikipedia.org/wiki/List_of_tz_database_ti

| [[logging-verbose]] `logging.verbose:` {ece-icon}
| Set to `true` to log all events, including system usage information and all
requests. *Default: `false`*
requests. Requires `logging.silent` and `logging.quiet` set to `false`. *Default: `false`*
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it also be worth adding a note to logging.quiet that it requires logging.silent to be true?

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe I can be clearer here, but if either logging.silent or logging.quiet are set to true then also setting logging.verbose to true will result in Kibana failing to start. Put another way, the logging.verbose setting is mutually exclusive to these other two settings.
Separately, I don't think if logging.silent is true then logging.quiet also needs to be true or vice-versa to avoid issues, but I can also test this in case it's another dependency.
We might indicate the opposite configuration in the docs for these other two settings if you want to use them then you need to ensure verbose is false, which should cover warning for this startup failure scenario from the context of these two different groups of settings.

Copy link
Contributor

@joshdover joshdover left a comment

Choose a reason for hiding this comment

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

One other suggestion but LGTM

@gchaps
Copy link
Contributor

gchaps commented Sep 30, 2020

@elasticmachine merge upstream

@gchaps
Copy link
Contributor

gchaps commented Sep 30, 2020

jenkins, test this

@LeeDr LeeDr added v7.10.1 and removed v7.10.0 labels Nov 12, 2020
@gchaps
Copy link
Contributor

gchaps commented Nov 18, 2020

@elasticmachine merge upstream

@KOTungseth
Copy link
Contributor

@elasticmachine merge upstream

@elastic elastic deleted a comment from kibanamachine Jun 8, 2021
@joshdover
Copy link
Contributor

We don't document this setting anymore since it's been deprecated. Going to close this.

@joshdover joshdover closed this Jun 16, 2021
@geekpete
Copy link
Member Author

For reference: #84363

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.

8 participants