Tutorials [tutorials]

Hands-on, task-focused guides for working with the {{kib}} platform from inside a plugin. If you're new to {{kib}} development, start with Getting started instead.

Data access

• Access the Elasticsearch client — obtain the Elasticsearch client in plugin lifecycle hooks and route handlers
• Search saved objects — use the powerful search method on SavedObjectsClientContract
• Data views API — create, query, and manage data views programmatically
• data.search services — run search requests with async search, sessions, and custom strategies

HTTP APIs

• Register and access an endpoint — add a custom HTTP API and call it from client-side code
• Versioning HTTP APIs — create or migrate to versioned HTTP APIs
• Versioning interfaces — manage request and response schema versions over time
• Generate OAS documentation — generate OpenAPI Specification docs for your HTTP APIs

Building UIs

• Register an application — register a top-level application in {{kib}}
• Page template — create consistent page layouts with KibanaPageTemplate
• Recently viewed — register items in the side navigation's "Recently Viewed" list via chrome.recentlyAccessed
• Expressions service — build and execute expression pipelines
• Lens Config Builder API — embed Lens visualizations using the config builder API
• Add data tutorials — register data ingestion tutorials in the {{kib}} home screen

Configuration

• Configure your plugin — define a config schema and read values at runtime
• UI settings — register a new UI setting (aka advanced setting / uiSetting) and read it at runtime

Platform services

• Logging — structured logging from the server
• Reporting integration — integrate your plugin with the Reporting plugin
• Screenshotting service — generate screenshots programmatically
• Development telemetry — register telemetry events for usage analytics
• Internationalization (i18n) — add translatable strings and use the i18n tooling

External plugin development

• Overview — differences when developing plugins outside the {{kib}} repository
• Plugin tooling — build and package tooling for external plugins
• Functional tests — run FTR tests for plugins outside the repo
• Testing plugins — set up tests for a {{kib}} plugin