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

Jump to bottom

Adds links to advanced logging documentation from settings #96240

Merged
merged 2 commits into from
Apr 6, 2021
Merged

Adds links to advanced logging documentation from settings #96240

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
d1612bc
Adds links to advanced logging documentation from the setup/settings …
TinaHeiligers Apr 5, 2021
5282bae
Adds links to advanced logging documentation from the migration guide…
TinaHeiligers Apr 5, 2021
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
8 changes: 4 additions & 4 deletions docs/migration/migrate_8_0.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ for example, `logstash-*`.
==== Default logging timezone is now the system's timezone
*Details:* In prior releases the timezone used in logs defaulted to UTC. We now use the host machine's timezone by default.

*Impact:* To restore the previous behavior, in kibana.yml use the pattern layout, with a date modifier:
*Impact:* To restore the previous behavior, in kibana.yml use the pattern layout, with a {kibana-ref}/logging-service.html#date-format[date modifier]:
[source,yaml]
-------------------
logging:
Expand Down Expand Up @@ -87,7 +87,7 @@ See https://github.com/elastic/kibana/pull/87939 for more details.

[float]
==== Logging destination is specified by the appender
*Details:* Previously log destination would be `stdout` and could be changed to `file` using `logging.dest`. With the new logging configuration, you can specify the destination using appenders.
*Details:* Previously log destination would be `stdout` and could be changed to `file` using `logging.dest`. With the new logging configuration, you can specify the destination using {kibana-ref}/logging-service.html#logging-appenders[appenders].

*Impact:* To restore the previous behavior and log records to *stdout*, in `kibana.yml` use an appender with `type: console`.
[source,yaml]
Expand Down Expand Up @@ -118,7 +118,7 @@ logging:

[float]
==== Set log verbosity with root
*Details:* Previously logging output would be specified by `logging.silent` (none), `logging.quiet` (error messages only) and `logging.verbose` (all). With the new logging configuration, set the minimum required log level.
*Details:* Previously logging output would be specified by `logging.silent` (none), `logging.quiet` (error messages only) and `logging.verbose` (all). With the new logging configuration, set the minimum required {kibana-ref}/logging-service.html#log-level[log level].
Copy link
Contributor

Choose a reason for hiding this comment

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

question: Is it possible to use the standard asciidoc cross-references instead of relying on generated URL?
https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#ex-xrefs
Should the file name change, the link is broken.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The doc we're linking to isn't in the same book so we have to use an external link here.


*Impact:* To restore the previous behavior, in `kibana.yml` specify `logging.root.level`:
[source,yaml]
Expand Down Expand Up @@ -175,7 +175,7 @@ logging:
==== Configure log rotation with the rolling-file appender
*Details:* Previously log rotation would be enabled when `logging.rotate.enabled` was true.

*Impact:* To restore the previous behavior, in `kibana.yml` use the `rolling-file` appender.
*Impact:* To restore the previous behavior, in `kibana.yml` use the {kibana-ref}/logging-service.html#rolling-file-appender[`rolling-file`] appender.

[source,yaml]
-------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/setup/settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ To reload the logging settings, send a SIGHUP signal to {kib}.
|===

|[[logging-root]] `logging.root:`
| The `root` logger has a dedicated configuration node since this context name is special and is pre-configured for logging by default.
| The {kibana-ref}/logging-service.html#logging-service[`root` logger] has a dedicated configuration node since this context name is special and is pre-configured for logging by default.
// TODO: add link to the advanced logging documentation.

|[[logging-root-appenders]] `logging.root.appenders:`
Expand All @@ -303,7 +303,7 @@ To reload the logging settings, send a SIGHUP signal to {kib}.
| Specific appender format to apply for a particular logger context.

| `logging.appenders:`
| Define how and where log messages are displayed (eg. *stdout* or console) and stored (eg. file on the disk).
| {kibana-ref}/logging-service.html#logging-appenders[Appenders] define how and where log messages are displayed (eg. *stdout* or console) and stored (eg. file on the disk).
// TODO: add link to the advanced logging documentation.

| `logging.appenders.console:`
Expand Down