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] Adds user-facing docs for the new KP logging configuration #94993

Merged
merged 33 commits into from
Mar 30, 2021
Merged
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
bfd3394
Converting logging README from mdx to asciidoc for user facing docs
TinaHeiligers Mar 14, 2021
ac8b690
Converts README to asciidoc
TinaHeiligers Mar 14, 2021
a89dd12
Adds logging settings to setup settings guide
TinaHeiligers Mar 15, 2021
bd22fc2
Splits Core API dev docs into individual service pages
TinaHeiligers Mar 16, 2021
a05082f
Adds logging configuration changes to breaking changes page
TinaHeiligers Mar 18, 2021
afbdab3
Cleans up some logging documentation
TinaHeiligers Mar 18, 2021
0b028fb
Cleans up commented out section
TinaHeiligers Mar 18, 2021
b06ed3d
Removes links that will be added once the new logging docs are merged
TinaHeiligers Mar 19, 2021
b2cb201
Removes bad link
TinaHeiligers Mar 19, 2021
d4edcd9
Address PR review comments
TinaHeiligers Mar 23, 2021
1eebed4
Adds a note to the Elasticsearch service section
TinaHeiligers Mar 23, 2021
526616c
Merge branch 'master' into core-docs/logging
TinaHeiligers Mar 24, 2021
3354da8
Groups services sections together into server and or client side usag…
TinaHeiligers Mar 25, 2021
3cd78af
Addresses more review comments
TinaHeiligers Mar 25, 2021
3bd3aea
Minor fixes
TinaHeiligers Mar 25, 2021
8147e92
Adds a few phrases from the Platform Building Blocks documentation
TinaHeiligers Mar 25, 2021
4cd64c9
Removes duplicate scoped elasticsearch service
TinaHeiligers Mar 25, 2021
9a80b1d
Moves layout, appenders before logger heirarchy
TinaHeiligers Mar 29, 2021
163dcd9
Adds basic logging configuration examples
TinaHeiligers Mar 29, 2021
648f6b6
Updates general logging settings with links to new reference code sni…
TinaHeiligers Mar 29, 2021
6c3907e
Cleanup and follow up comments
TinaHeiligers Mar 29, 2021
3f675b4
Deletes file
TinaHeiligers Mar 29, 2021
c13c70d
Merge branch 'master' into core-docs/logging
TinaHeiligers Mar 29, 2021
cd26a55
Merge branch 'master' into core-docs/logging
TinaHeiligers Mar 29, 2021
83c6b6d
Update docs/developer/architecture/core/application_service.asciidoc
TinaHeiligers Mar 30, 2021
d77b4ea
Update docs/developer/architecture/core/application_service.asciidoc
TinaHeiligers Mar 30, 2021
5b7424e
Update docs/developer/architecture/core/configuration-service.asciidoc
TinaHeiligers Mar 30, 2021
7ebd4c1
Update docs/developer/architecture/core/logging-service.asciidoc
TinaHeiligers Mar 30, 2021
d8b74c7
Update docs/developer/architecture/core/logging-service.asciidoc
TinaHeiligers Mar 30, 2021
01905e3
Update docs/developer/architecture/core/logging-service.asciidoc
TinaHeiligers Mar 30, 2021
de11253
Update docs/developer/architecture/core/saved-objects-service.asciidoc
TinaHeiligers Mar 30, 2021
ac6d10d
Update docs/developer/architecture/core/saved-objects-service.asciidoc
TinaHeiligers Mar 30, 2021
c543306
Apply suggestions from code review
TinaHeiligers Mar 30, 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
Prev Previous commit
Apply suggestions from code review
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
  • Loading branch information
TinaHeiligers and lcawl authored Mar 30, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit c5433061aeab34b932d67b9a0a0b39dca7e3fed6
2 changes: 1 addition & 1 deletion docs/developer/architecture/core/logging-service.asciidoc
Original file line number Diff line number Diff line change
@@ -411,7 +411,7 @@ fully configured.

You can configure _<<log-level, log level>>_ and _appenders_ for a specific logger. If a logger only has a _log level_ configured, then the _appenders_ configuration applied to the logger is inherited from the ancestor logger.

NOTE: In the current implementation we __don't support__ so called _appender additivity_ when log messages are forwarded to _every_ distinct appender within
NOTE: In the current implementation we __don't support__ so called _appender additivity_ when log messages are forwarded to _every_ distinct appender within the
ancestor chain including `root`. That means that log messages are only forwarded to appenders that are configured for a particular logger. If a logger doesn't have any appenders configured, the configuration of that particular logger will be inherited from its closest ancestor.

[[dedicated-loggers]]
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
== Patterns
[[scoped-services]]
=== Scoped services
Whenever Kibana needs to get access to data saved in elasticsearch, it
Whenever Kibana needs to get access to data saved in Elasticsearch, it
should perform a check whether an end-user has access to the data.
The Kibana Platform introduced a handler interface on the server-side to perform that association
internally. Core services, that require impersonation with an incoming
@@ -30,7 +30,7 @@ handler context] exposes the following scoped *core* services:

Plugins can extend the handler context with a custom API that will be
available to the plugin itself and all dependent plugins. For example,
the plugin creates a custom elasticsearch client and wants to use it via
the plugin creates a custom Elasticsearch client and wants to use it via
the request handler context:

[source,typescript]
Original file line number Diff line number Diff line change
@@ -267,7 +267,7 @@ in this code, there's really no reason not to aim for 100% test code coverage.

When a Saved Object declares `references` to other Saved Objects, the
Saved Objects Export API will automatically export the target object with all
of it's references. This makes it easy for users to export the entire
of its references. This makes it easy for users to export the entire
reference graph of an object.

If a Saved Object can't be used on its own, that is, it needs other objects