Configuration service
editConfiguration service
editKibana provides ConfigService
for plugin developers that want to support
adjustable runtime behavior for their plugins.
Plugins can only read their own configuration values, it is not possible to access the configuration values from Kibana Core or other plugins directly.
The Configuration service is only available server side.
// 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 pluginid
if not specified) inkibana.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
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
import type { PluginInitializerContext } from '@kbn/core/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
import { schema, TypeOf } from '@kbn/config-schema'; import type { PluginConfigDescriptor } from '@kbn/core/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
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 Kibana Platform key. Kibana reads its
value and won’t create a plugin instance if enabled: false
.
export const config = { schema: schema.object({ enabled: schema.boolean({ defaultValue: false }) }), };
Handle plugin configuration deprecations
editIf 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
import { schema, TypeOf } from '@kbn/config-schema'; import type { PluginConfigDescriptor } from '@kbn/core/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
export const config: PluginConfigDescriptor<ConfigType> = { schema: configSchema, deprecations: ({ renameFromRoot, unusedFromRoot }) => [ renameFromRoot('oldplugin.property', 'myplugin.property'), unusedFromRoot('oldplugin.deprecated'), ], };
Validating your configuration based on context references
editSome features require special configuration when running in different modes (dev/prod/dist, or even serverless). For purpose, core injects the following references in the validation’s context:
Context Reference | Potential values | Description |
---|---|---|
|
|
Is Kibana running in Dev mode? |
|
|
Is Kibana running in Production mode (running from binary)? |
|
|
Is Kibana running from a distributable build (not running from source)? |
|
|
Is Kibana running in Serverless offering? |
|
|
The current version of Kibana |
|
|
The build number |
|
|
The current branch running |
|
|
The build SHA (typically refers to the last commit’s SHA) |
|
|
The ISO 8601 date of the build |
To use any of the references listed above in a config validation schema, they can be accessed via schema.contextRef('{CONTEXT_REFERENCE}')
:
export const config = { schema: schema.object({ // Enabled by default in Dev mode enabled: schema.boolean({ defaultValue: schema.contextRef('dev') }), // Setting only allowed in the Serverless offering plansForWorldPeace: schema.conditional( schema.contextRef('serverless'), true, schema.string({ defaultValue: 'Free hugs' }), schema.never() ), }), };