[DOCS] Adds user-facing docs for the new KP logging configuration #94993
Conversation
TinaHeiligers
added
Team:Docs
release_note:breaking
Team:Core
|
@elastic/kibana-core I've split up the Core dev docs into subpages to fit the new logging system documentation in. Could you please double check that these still make sense? @gchaps @KOTungseth I'm going to need you help on checking/fixing the language in the new logging doc sections. I've tried to rehash the info from the Core logging README. For now, I've removed the links from the Settings and Breaking Changes pages to the main logging guide and will add them back once they are merged. |
TinaHeiligers
requested review from
mshustov and
a team
and removed request for
mshustov
docs/developer/architecture/core/elasticsearch-service.asciidoc
Outdated
Show resolved
Hide resolved
docs/developer/architecture/core/logging-configuration-migration.asciidoc
Outdated
Show resolved
Hide resolved
docs/developer/architecture/core/logging-configuration-migration.asciidoc
Outdated
Show resolved
Hide resolved
|
@lukeelmers I've address the comments and restructured the services a bit. Would you like to give it one more look before I merge? There will be at least one follow up PR to add the links to the |
docs/developer/architecture/core/logging-service-configuration.asciidoc
Outdated
Show resolved
Hide resolved
| metadata that may be associated with the log message. | ||
| When <<logging-dest, `logging.dest.stdout`>> is set, and there is no interactive terminal ("TTY"), | ||
| this setting defaults to `true`. *Default: `false`* | ||
| |[[logging-root]] `logging.root:` |
There was a problem hiding this comment.
Should we include link(s) in this section that link to the more advanced documentation?
There was a problem hiding this comment.
Links will be added in a follow up PR. We can't link to docs we're adding within the same PR. I added a comment as a reminder.
| @@ -0,0 +1,73 @@ | |||
| [[logging-service-configuration-example]] | |||
| == Logging Service Configuration Example | |||
There was a problem hiding this comment.
I think this page may make more sense under the docs/setup directory where we have dedicated pages for different configuration domains.
There was a problem hiding this comment.
That's a great idea! With the logging-service-configuration in the docs/setup directory, we can link to the basic examples from the main settings page. 😄
We still can't link to the more advanced documentation yet but that will be done in a follow up PR. I've added a comment to the logging.root description to get that done next.
docs/developer/architecture/core/configuration-service.asciidoc
Outdated
Show resolved
Hide resolved
docs/developer/architecture/core/patterns-scoped-services.asciidoc
Outdated
Show resolved
Hide resolved
docs/developer/architecture/core/patterns-scoped-services.asciidoc
Outdated
Show resolved
Hide resolved
docs/developer/architecture/core/saved-objects-service.asciidoc
Outdated
Show resolved
Hide resolved
docs/developer/architecture/core/saved-objects-service.asciidoc
Outdated
Show resolved
Hide resolved
docs/developer/architecture/core/saved-objects-service.asciidoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
TinaHeiligers
added
the
auto-backport
💔 Backport failed❌ 7.x: Commit could not be cherrypicked due to conflicts To backport manually run: |
…4993) (#95803) Co-authored-by: Lisa Cawley <[email protected]> # Conflicts: # docs/migration/migrate_8_0.asciidoc
Summary
Resolves #57502
This PR breaks up the Kibana Core API page into dedicated subpages and adds a new sub page for logging configuration.
Note to reviewers:
There will be a follow up PR to add links from the settings and breaking changes documentation to the new logging system docs once those are merged.
Checklist
Delete any items that are not applicable to this PR.
For maintainers