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

[DOCS] Adds user-facing docs for the new KP logging configuration #94993

Merged
merged 33 commits into from
Mar 30, 2021
Merged

[DOCS] Adds user-facing docs for the new KP logging configuration #94993

merged 33 commits into from
Mar 30, 2021

Conversation

TinaHeiligers
Copy link
Contributor

@TinaHeiligers TinaHeiligers commented Mar 18, 2021 •
edited
Loading

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.

  • Documentation was added for features that require explanation or tutorials

For maintainers

@TinaHeiligers TinaHeiligers added Team:Docs release_note:breaking Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:Logging v7.13.0 v8.0.0 labels Mar 18, 2021
@TinaHeiligers
Copy link
Contributor Author

TinaHeiligers commented Mar 18, 2021 •
edited
Loading

@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 TinaHeiligers requested review from mshustov and a team and removed request for mshustov March 19, 2021 01:19
mshustov
mshustov reviewed Mar 23, 2021
View reviewed changes
docs/developer/architecture/core/client-side-services.asciidoc Outdated Show resolved Hide resolved
docs/developer/architecture/core/client-side-services.asciidoc Outdated Show resolved Hide resolved
docs/developer/architecture/core/client-side-services.asciidoc Outdated Show resolved Hide resolved
docs/developer/architecture/core/http-service.asciidoc Outdated Show resolved Hide resolved
docs/developer/architecture/core/elasticsearch-service.asciidoc Outdated Show resolved Hide resolved
docs/developer/architecture/core/elasticsearch-service.asciidoc 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
@TinaHeiligers
Copy link
Contributor Author

@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 migration guide and the settings doc, so if we miss anything in this PR, we can address it in the follow up one.

joshdover
joshdover reviewed Mar 26, 2021
View reviewed changes
docs/developer/architecture/core/logging-service.asciidoc Outdated Show resolved Hide resolved
docs/developer/architecture/core/logging-service-configuration.asciidoc Outdated Show resolved Hide resolved
docs/setup/settings.asciidoc
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:`
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we include link(s) in this section that link to the more advanced documentation?

Copy link
Contributor Author

@TinaHeiligers TinaHeiligers Mar 26, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

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.

docs/developer/architecture/core/logging-service-configuration.asciidoc Outdated
@@ -0,0 +1,73 @@
[[logging-service-configuration-example]]
== Logging Service Configuration Example
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this page may make more sense under the docs/setup directory where we have dedicated pages for different configuration domains.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

lukeelmers
lukeelmers approved these changes Mar 26, 2021
View reviewed changes
Copy link
Member

@lukeelmers lukeelmers left a comment

Choose a reason for hiding this comment

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

In agreement with Josh's comments above, otherwise changes here LGTM!

@TinaHeiligers TinaHeiligers requested a review from lcawl March 29, 2021 22:59
lcawl
lcawl approved these changes Mar 29, 2021
View reviewed changes
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

I added some minor grammatical suggestions, otherwise LGTM

docs/developer/architecture/core/application_service.asciidoc Outdated Show resolved Hide resolved
docs/developer/architecture/core/application_service.asciidoc Outdated Show resolved Hide resolved
docs/developer/architecture/core/configuration-service.asciidoc Outdated Show resolved Hide resolved
docs/developer/architecture/core/logging-service.asciidoc Outdated Show resolved Hide resolved
docs/developer/architecture/core/logging-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
TinaHeiligers and others added 9 commits March 29, 2021 18:31
@TinaHeiligers @lcawl
Update docs/developer/architecture/core/application_service.asciidoc
83c6b6d 
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@TinaHeiligers @lcawl
Update docs/developer/architecture/core/application_service.asciidoc
d77b4ea 
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@TinaHeiligers @lcawl
Update docs/developer/architecture/core/configuration-service.asciidoc
5b7424e 
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@TinaHeiligers @lcawl
Update docs/developer/architecture/core/logging-service.asciidoc
7ebd4c1 
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@TinaHeiligers @lcawl
Update docs/developer/architecture/core/logging-service.asciidoc
d8b74c7 
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@TinaHeiligers @lcawl
Update docs/developer/architecture/core/logging-service.asciidoc
01905e3 
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@TinaHeiligers @lcawl
Update docs/developer/architecture/core/saved-objects-service.asciidoc
de11253 
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@TinaHeiligers @lcawl
Update docs/developer/architecture/core/saved-objects-service.asciidoc
ac6d10d 
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@TinaHeiligers @lcawl
Apply suggestions from code review
c543306 
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@TinaHeiligers TinaHeiligers added the auto-backport Deprecated - use backport:version if exact versions are needed label Mar 30, 2021
@TinaHeiligers TinaHeiligers merged commit d29abdf into elastic:master Mar 30, 2021
@TinaHeiligers TinaHeiligers deleted the core-docs/logging branch March 30, 2021 14:54
@kibanamachine
Copy link
Contributor

💔 Backport failed

❌ 7.x: Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 94993

@TinaHeiligers TinaHeiligers mentioned this pull request Mar 30, 2021
Merged
TinaHeiligers added a commit that referenced this pull request Mar 30, 2021
@TinaHeiligers
[DOCS] Adds user-facing docs for the new KP logging configuration (#9…
bd3f30f 
…4993) (#95803)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
# Conflicts:
#	docs/migration/migrate_8_0.asciidoc
@TinaHeiligers TinaHeiligers mentioned this pull request Apr 5, 2021
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mshustov mshustov mshustov approved these changes

@joshdover joshdover joshdover left review comments

@lcawl lcawl lcawl approved these changes

@lukeelmers lukeelmers lukeelmers approved these changes

Assignees
No one assigned
Labels
auto-backport Deprecated - use backport:version if exact versions are needed Feature:Logging release_note:breaking Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Team:Docs v7.13.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add user-facing docs for new logging configuration
8 participants
@TinaHeiligers @elasticmachine @rudolf @lukeelmers @kibanamachine @joshdover @mshustov @lcawl