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
Show file tree
Hide file tree
Changes from 9 commits
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
57 changes: 57 additions & 0 deletions docs/developer/architecture/core/client-side-services.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
[[client-side-services]]
== Application service
Kibana has migrated to be a Single Page Application. Plugins should use `Application service` API to instruct Kibana what an application should be loaded & rendered in the UI in response to user interactions.
[source,typescript]
----
import { AppMountParameters, CoreSetup, Plugin, DEFAULT_APP_CATEGORIES } from 'kibana/public';

export class MyPlugin implements Plugin {
public setup(core: CoreSetup) {
core.application.register({ // <1>
category: DEFAULT_APP_CATEGORIES.kibana,
id: 'my-plugin',
title: 'my plugin title',
euiIconType: '/path/to/some.svg',
order: 100,
appRoute: '/app/my_plugin', // <2>
async mount(params: AppMountParameters) { // <3>
// Load application bundle
const { renderApp } = await import('./application');
// Get start services
const [coreStart, depsStart] = await core.getStartServices(); // <4>
// Render the application
return renderApp(coreStart, depsStart, params); // <5>
},
});
}
}
----
<1> See {kib-repo}blob/{branch}/docs/development/core/public/kibana-plugin-core-public.applicationsetup.register.md[application.register interface]
<2> Application specific URL.
<3> `mount` callback is invoked when a user navigates to the application-specific URL.
<4> `core.getStartServices` method provides API available during `start` lifecycle.
<5> `mount` method must return a function that will be called to unmount the application.
TinaHeiligers marked this conversation as resolved.
Show resolved Hide resolved

NOTE:: you are free to use any UI library to render a plugin application in DOM.
However, we recommend using React and https://elastic.github.io/eui[EUI] for all your basic UI
components to create a consistent UI experience.

[[client-side-http-service]]
== HTTP service
Provides API to communicate with the {kib} server. Feel free to use another HTTP client library to request 3rd party services.
TinaHeiligers marked this conversation as resolved.
Show resolved Hide resolved

[source,typescript]
----
import { CoreStart } from 'kibana/public';
interface ResponseType {…};
async function fetchData<ResponseType>(core: CoreStart) {
return await core.http.get<>(
TinaHeiligers marked this conversation as resolved.
Show resolved Hide resolved
'/api/my_plugin/',
{ query: … },
);
}
----
See {kib-repo}blob/{branch}/docs/development/core/public/kibana-plugin-core-public.httpsetup.md[for all available API].

== Elasticsearch service
Not available in the browser. Use {kib-repo}blob/{branch}/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md[Data plugin] instead.
147 changes: 147 additions & 0 deletions docs/developer/architecture/core/configuration-service.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
[[configuration-service]]
== Configuration service
{kib} provides `ConfigService` if a plugin developer may want to support
TinaHeiligers marked this conversation as resolved.
Show resolved Hide resolved
adjustable runtime behavior for their plugins.
Plugins can only read their own configuration values, it is not possible to access the configuration values from {kib} Core or other plugins directly.

[source,js]
----
// in Legacy platform
const basePath = config.get('server.basePath');
// in Kibana Platform 'basePath' belongs to the http service
const basePath = core.http.basePath.get(request);
----

To have access to your plugin config, you _should_:

* Declare plugin-specific `configPath` (will fallback to plugin `id`
if not specified) in {kib-repo}blob/{branch}/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md[`kibana.json`] manifest file.
* Export schema validation for the config from plugin's main file. Schema is
mandatory. If a plugin reads from the config without schema declaration,
`ConfigService` will throw an error.

*my_plugin/server/index.ts*
[source,typescript]
----
import { schema, TypeOf } from '@kbn/config-schema';
export const plugin = …
export const config = {
schema: schema.object(…),
};
export type MyPluginConfigType = TypeOf<typeof config.schema>;
----

* Read config value exposed via `PluginInitializerContext`:

*my_plugin/server/index.ts*
[source,typescript]
----
import type { PluginInitializerContext } from 'kibana/server';
export class MyPlugin {
constructor(initializerContext: PluginInitializerContext) {
this.config$ = initializerContext.config.create<MyPluginConfigType>();
// or if config is optional:
this.config$ = initializerContext.config.createIfExists<MyPluginConfigType>();
}
...
}
----

If your plugin also has a client-side part, you can also expose
configuration properties to it using the configuration `exposeToBrowser`
allow-list property.

*my_plugin/server/index.ts*
[source,typescript]
----
import { schema, TypeOf } from '@kbn/config-schema';
import type { PluginConfigDescriptor } from 'kibana/server';

const configSchema = schema.object({
secret: schema.string({ defaultValue: 'Only on server' }),
uiProp: schema.string({ defaultValue: 'Accessible from client' }),
});

type ConfigType = TypeOf<typeof configSchema>;

export const config: PluginConfigDescriptor<ConfigType> = {
exposeToBrowser: {
uiProp: true,
},
schema: configSchema,
};
----

Configuration containing only the exposed properties will be then
available on the client-side using the plugin's `initializerContext`:

*my_plugin/public/index.ts*
[source,typescript]
----
interface ClientConfigType {
uiProp: string;
}

export class MyPlugin implements Plugin<PluginSetup, PluginStart> {
constructor(private readonly initializerContext: PluginInitializerContext) {}

public async setup(core: CoreSetup, deps: {}) {
const config = this.initializerContext.config.get<ClientConfigType>();
}
----

All plugins are considered enabled by default. If you want to disable
your plugin, you could declare the `enabled` flag in the plugin
config. This is a special {kib} Platform key. {kib} reads its
value and won’t create a plugin instance if `enabled: false`.

[source,js]
----
export const config = {
schema: schema.object({ enabled: schema.boolean({ defaultValue: false }) }),
};
----
[[handle-plugin-configuration-deprecations]]
=== Handle plugin configuration deprecations
If your plugin has deprecated configuration keys, you can describe them using
the `deprecations` config descriptor field.
Deprecations are managed on a per-plugin basis, meaning you don’t need to specify
the whole property path, but use the relative path from your plugin’s
configuration root.

*my_plugin/server/index.ts*
[source,typescript]
----
import { schema, TypeOf } from '@kbn/config-schema';
import type { PluginConfigDescriptor } from 'kibana/server';

const configSchema = schema.object({
newProperty: schema.string({ defaultValue: 'Some string' }),
});

type ConfigType = TypeOf<typeof configSchema>;

export const config: PluginConfigDescriptor<ConfigType> = {
schema: configSchema,
deprecations: ({ rename, unused }) => [
rename('oldProperty', 'newProperty'),
unused('someUnusedProperty'),
],
};
----

In some cases, accessing the whole configuration for deprecations is
necessary. For these edge cases, `renameFromRoot` and `unusedFromRoot`
are also accessible when declaring deprecations.

*my_plugin/server/index.ts*
[source,typescript]
----
export const config: PluginConfigDescriptor<ConfigType> = {
schema: configSchema,
deprecations: ({ renameFromRoot, unusedFromRoot }) => [
renameFromRoot('oldplugin.property', 'myplugin.property'),
unusedFromRoot('oldplugin.deprecated'),
],
};
----
26 changes: 26 additions & 0 deletions docs/developer/architecture/core/elasticsearch-service.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[[elasticsearch-service]]
== Elasticsearch service
TinaHeiligers marked this conversation as resolved.
Show resolved Hide resolved
`Elasticsearch service` provides `elasticsearch.client` program API to communicate with Elasticsearch server REST API.
TinaHeiligers marked this conversation as resolved.
Show resolved Hide resolved
`elasticsearch.client` interacts with Elasticsearch service on behalf of:

- `kibana_system` user via `elasticsearch.client.asInternalUser.*` methods.
- a current end-user via `elasticsearch.client.asCurrentUser.*` methods. In this case Elasticsearch client should be given the current user credentials.
See <<scoped-services>> and <<development-security>>.

{kib-repo}blob/{branch}/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.md[Elasticsearch service API docs]

[source,typescript]
----
import { CoreStart, Plugin } from 'kibana/public';

export class MyPlugin implements Plugin {
public start(core: CoreStart) {
async function asyncTask() {
const result = await core.elasticsearch.client.asInternalUser.ping(…);
}
asyncTask();
}
}
----

For advanced use-cases, such as a search, use {kib-repo}blob/{branch}/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.md[Data plugin]
42 changes: 42 additions & 0 deletions docs/developer/architecture/core/http-service.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
[[http-service]]
== HTTP service
Allows plugins:

* to extend the {kib} server with custom REST API.
TinaHeiligers marked this conversation as resolved.
Show resolved Hide resolved
* to execute custom logic on an incoming request or server response.
* implement custom authentication and authorization strategy.

See {kib-repo}blob/{branch}/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md[HTTP service API docs]

[source,typescript]
----
import { schema } from '@kbn/config-schema';
import type { CoreSetup, Plugin } from 'kibana/server';

export class MyPlugin implements Plugin {
public setup(core: CoreSetup) {
const router = core.http.createRouter();

const validate = {
params: schema.object({
id: schema.string(),
}),
};

router.get({
path: 'my_plugin/{id}',
validate
},
async (context, request, response) => {
const data = await findObject(request.params.id);
if (!data) return response.notFound();
return response.ok({
body: data,
headers: {
'content-type': 'application/json'
}
});
});
}
}
----
Loading