List of Kibana plugins

edit

List of Kibana plugins

edit

src/plugins

edit
Name Description

advancedSettings

This plugin contains the advanced settings management section allowing users to configure their advanced settings, also known as uiSettings within the code.

bfetch

bfetch allows to batch HTTP requests and streams responses back.

charts

The Charts plugin is a way to create easier integration of shared colors, themes, types and other utilities across all Kibana charts and visualizations.

console

Console provides the user with tools for storing and executing requests against Elasticsearch.

controls

The Controls plugin contains Embeddables which can be used to add user-friendly interactivity to apps.

customIntegrations

Register add-data cards

Dashboard plugin

- Registers the dashboard application. - Adds a dashboard embeddable that can be used in other applications.

data

The data plugin provides common data access services, such as search and query, for solutions and application developers.

dataViewEditor

Create data views from within Kibana apps.

dataViewFieldEditor

The reusable field editor across Kibana!

dataViewManagement

WARNING: Missing README.

dataViews

The data views API provides a consistent method of structuring and formatting documents and field lists across the various Kibana apps. Its typically used in conjunction with <DocLink id="kibDevTutorialDataSearchAndSessions" section="high-level-search" text="SearchSource" /> for composing queries.

devTools

The ui/registry/dev_tools is removed in favor of the devTools plugin which exposes a register method in the setup contract. Registering app works mostly the same as registering apps in core.application.register. Routing will be handled by the id of the dev tool - your dev tool will be mounted when the URL matches /app/dev_tools#/<YOUR ID>. This API doesn’t support angular, for registering angular dev tools, bootstrap a local module on mount into the given HTML element.

discover

Contains the Discover application and the saved search embeddable.

Embeddables plugin

Embeddables are re-usable widgets that can be rendered on dashboard, but also in other apps. Developers can embed them directly in their plugin. End users can dynamically add them to embeddable containers.

esUiShared

This plugin contains reusable code in the form of self-contained modules (or libraries). Each of these modules exports a set of functionality relevant to the domain of the module.

eventAnnotation

The Event Annotation service contains expressions for event annotations

expressionError

Expression Error plugin adds an error renderer to the expression plugin. The renderer will display the error image.

expressionGauge

WARNING: Missing README.

expressionHeatmap

WARNING: Missing README.

expressionImage

Expression Image plugin adds an image renderer to the expression plugin. The renderer will display the given image.

expressionMetric

Expression Metric plugin adds a metric renderer and function to the expression plugin.

expressionMetricVis

Expression MetricVis plugin adds a metric renderer and function to the expression plugin. The renderer will display the metric chart.

expressionPartitionVis

Expression Partition Visualization plugin adds a partitionVis renderer and pieVis, mosaicVis, treemapVis, waffleVis functions to the expression plugin. The renderer will display the pie, waffle, treemap and mosaic charts.

expressionRepeatImage

Expression Repeat Image plugin adds a repeatImage function to the expression plugin and an associated renderer. The renderer will display the given image in mutliple instances.

expressionRevealImage

Expression Reveal Image plugin adds a revealImage function to the expression plugin and an associated renderer. The renderer will display the given percentage of a given image.

expressions plugin

Expression pipeline is a chain of functions that pipe its output to the input of the next function. Functions can be configured using arguments provided by the user. The final output of the expression pipeline can be rendered using one of the renderers registered in expressions plugin.

All the arguments to expression functions need to be serializable, as well as input and output. Expression functions should try to stay pure. This makes functions easy to reuse and also make it possible to serialize the whole chain as well as output at every step of execution.

It is possible to add comments to expressions by starting them with a // sequence or by using /* and */ to enclose multi-line comments.

Expressions power visualizations in Dashboard and Lens, as well as, every element in Canvas is backed by an expression.

This plugin provides methods which will parse & execute an expression pipeline string for you, as well as a series of registries for advanced users who might want to incorporate their own functions, types, and renderers into the service for use in their own application.

expressionShape

Expression Shape plugin adds a shape function to the expression plugin and an associated renderer. The renderer will display the given shape with selected decorations.

expressionTagcloud

Expression Tagcloud plugin adds a tagcloud renderer and function to the expression plugin. The renderer will display the Wordcloud chart.

expressionXY

Expression XY plugin adds a xy renderer and function to the expression plugin. The renderer will display the xy chart.

fieldFormats

Index pattern fields formatters

home

Moves the legacy ui/registry/feature_catalogue module for registering "features" that should be shown in the home page’s feature catalogue to a service within a "home" plugin. The feature catalogue refered to here should not be confused with the "feature" plugin for registering features used to derive UI capabilities for feature controls.

inputControlVis

Contains the input control visualization allowing to place custom filter controls on a dashboard.

inspector

The inspector is a contextual tool to gain insights into different elements in Kibana, e.g. visualizations. It has the form of a flyout panel.

interactiveSetup

The plugin provides UI and APIs for the interactive setup mode.

kibanaOverview

An overview page highlighting Kibana apps

kibanaReact

Tools for building React applications in Kibana.

kibanaUsageCollection

This plugin registers the Platform Usage Collectors in Kibana.

kibanaUtils

Utilities for building Kibana plugins.

management

This plugins contains the "Stack Management" page framework. It offers navigation and an API to link individual managment section into it. This plugin does not contain any individual management section itself.

mapsEms

Utility plugin:

navigation

The navigation plugins exports the TopNavMenu component. It also provides a stateful version of it on the start contract.

newsfeed

The newsfeed plugin adds a NewsfeedNavButton to the top navigation bar and renders the content in the flyout. Content is fetched from the remote (https://feeds.elastic.co and https://feeds-staging.elastic.co in dev mode) once a day, with periodic checks if the content needs to be refreshed. All newsfeed content is hosted remotely.

presentationUtil

The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas).

savedObjects

NOTE: This plugin is deprecated and will be removed in 8.0. See https://github.com/elastic/kibana/issues/46435 for more information.

savedObjectsManagement

The savedObjectsManagement plugin manages the Saved Objects management section.

savedObjectsTaggingOss

Bridge plugin for consumption of the saved object tagging feature from oss plugins.

screenshotMode

The service exposed by this plugin informs consumers whether they should optimize for non-interactivity. In this way plugins can avoid loading unnecessary code, data or other services.

share

The share plugin contains various utilities for displaying sharing context menu, generating deep links to other apps using locators, and creating short URLs.

sharedUX

Our mission is to make consistency in our user experience a product.

telemetry

Telemetry allows Kibana features to have usage tracked in the wild. The general term "telemetry" refers to multiple things:

telemetryCollectionManager

Telemetry’s collection manager to go through all the telemetry sources when fetching it before reporting.

telemetryManagementSection

This plugin adds the Advanced Settings section for the Usage and Security Data collection (aka Telemetry).

UI Actions

UI Actions plugins provides API to manage triggers and actions.

Trigger is an abstract description of user’s intent to perform an action (like user clicking on a value inside chart). It allows us to do runtime binding between code from different plugins. For, example one such trigger is when somebody applies filters on dashboard; another one is when somebody opens a Dashboard panel context menu.

Actions are pieces of code that execute in response to a trigger. For example, to the dashboard filtering trigger multiple actions can be attached. Once a user filters on the dashboard all possible actions are displayed to the user in a popup menu and the user has to chose one.

In general this plugin provides:

- Creating custom functionality (actions). - Creating custom user interaction events (triggers). - Attaching and detaching actions to triggers. - Emitting trigger events. - Executing actions attached to a given trigger. - Exposing a context menu for the user to choose the appropriate action when there are multiple actions attached to a single trigger.

urlForwarding

This plugins contains helpers to redirect legacy URLs. It can be used to forward old URLs to their new counterparts.

usageCollection

The Usage Collection Service defines a set of APIs for other plugins to report the usage of their features. At the same time, it provides necessary the APIs for other services (i.e.: telemetry, monitoring, …​) to consume that usage data.

visDefaultEditor

The default editor is used in most primary visualizations, e.x. Area, Data table, Pie, etc. It acts as a container for a particular visualization and options tabs. Contains the default "Data" tab in public/components/sidebar/data_tab.tsx. The plugin exposes the static DefaultEditorController class to consume.

visTypeGauge

WARNING: Missing README.

visTypeHeatmap

WARNING: Missing README.

visTypeMarkdown

The markdown visualization that can be used to place text panels on dashboards.

visTypeMetric

WARNING: Missing README.

visTypePie

WARNING: Missing README.

visTypeTable

Contains the data table visualization, that allows presenting data in a simple table format.

visTypeTagcloud

WARNING: Missing README.

visTypeTimelion

Contains the timelion visualization and the timelion backend.

visTypeTimeseries

WARNING: Missing README.

visTypeVega

WARNING: Missing README.

visTypeVislib

WARNING: Missing README.

visTypeXy

WARNING: Missing README.

visualizations

WARNING: Missing README.

x-pack/plugins

edit
Name Description

actions

The Kibana actions plugin provides a framework to create executable actions. You can:

alerting

The Kibana Alerting plugin provides a common place to set up rules. You can:

apm

undefined

banners

Allow to add a header banner that will be displayed on every page of the Kibana application

canvas

"Never look back. The past is done. The future is a blank canvas." ― Suzy Kassem, Rise Up and Salute the Sun

cases

This plugin provides cases management in Kibana

cloud

The cloud plugin adds Cloud-specific features to Kibana.

cloudSecurityPosture

Cloud Posture automates the identification and remediation of risks across cloud infrastructures

crossClusterReplication

You can run a local cluster and simulate a remote cluster within a single Kibana directory.

Dashboard app enhancements plugin

Adds drilldown capabilities to dashboard. Owned by the Kibana App team.

dataEnhanced

The data_enhanced plugin is the x-pack counterpart to the src/plguins/data plugin.

dataVisualizer

The data_visualizer plugin enables you to explore the fields in your data.

discoverEnhanced

Contains the enhancements to the OSS discover app.

Enhanced embeddables plugin

Enhances Embeddables by registering a custom factory provider. The enhanced factory provider adds dynamic actions to every embeddables state, in order to support drilldowns.

encryptedSavedObjects

The purpose of this plugin is to provide a way to encrypt/decrypt attributes on the custom Saved Objects that works with security and spaces filtering.

enterpriseSearch

This plugin provides Kibana user interfaces for managing the Enterprise Search solution and its products, App Search and Workplace Search.

eventLog

The event log plugin provides a persistent history of alerting and action activities.

features

The features plugin enhance Kibana with a per-feature privilege system.

fileUpload

WARNING: Missing README.

fleet

Fleet needs to have Elasticsearch API keys enabled, and also to have TLS enabled on kibana, (if you want to run Kibana without TLS you can provide the following config flag --xpack.fleet.agents.tlsCheckDisabled=false)

globalSearch

The GlobalSearch plugin provides an easy way to search for various objects, such as applications or dashboards from the Kibana instance, from both server and client-side plugins

globalSearchBar

The GlobalSearchBar plugin provides a search interface for navigating Kibana. (It is the UI to the GlobalSearch plugin.)

globalSearchProviders

The globalSearchProviders plugin provides Kibana default search providers for the GlobalSearch plugin.

graph

This is the main source folder of the Graph plugin. It contains all of the Kibana server and client source code. x-pack/test/functional/apps/graph contains additional functional tests.

grokdebugger

This plugin helps users define Grok patterns, which are particularly useful for ingesting logs.

indexLifecycleManagement

You can test that the Frozen badge, phase filtering, and lifecycle information is surfaced in Index Management by running this series of requests in Console:

indexManagement

Create an index with special characters and verify it renders correctly:

infra

This is the home of the infra plugin, which aims to provide a solution for the infrastructure monitoring use-case within Kibana.

ingestPipelines

The ingest_pipelines plugin provides Kibana support for Elasticsearch’s ingest pipelines.

lens

Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads.

licenseApiGuard

This plugin is used by ES UI plugins to reject API requests when the plugin is unsupported by the user’s license.

licenseManagement

This plugin enables users to activate a trial license, downgrade to Basic, and upload a new license.

licensing

The licensing plugin retrieves license data from Elasticsearch at regular configurable intervals.

lists

README.md for developers working on the backend lists on how to get started using the CURL scripts in the scripts folder.

logstash

WARNING: Missing README.

maps

Visualize geo data from Elasticsearch or 3rd party geo-services.

metricsEntities

This is the metrics and entities plugin where you add can add transforms for your project and group those transforms into modules. You can also re-use existing transforms in your newly created modules as well.

ml

This plugin provides access to the machine learning features provided by Elastic.

monitoring

This plugin provides the Stack Monitoring kibana application.

monitoringCollection

This plugin allows for other plugins to add data to Kibana stack monitoring documents.

observability

This plugin provides shared components and services for use across observability solutions, as well as the observability landing page UI.

osquery

This plugin adds extended support to Security Solution Fleet Osquery integration

painlessLab

This plugin helps users learn how to use the Painless scripting language.

remoteClusters

This plugin helps users manage their remote clusters, which enable cross-cluster search and cross-cluster replication.

reporting

An awesome Kibana reporting plugin

rollup

Welcome to the Kibana rollup plugin! This plugin provides Kibana support for Elasticsearch’s rollup feature. Please refer to the Elasticsearch documentation to understand rollup indices and how to create rollup jobs.

ruleRegistry

The rule registry plugin aims to make it easy for rule type producers to have their rules produce the data that they need to build rich experiences on top of a unified experience, without the risk of mapping conflicts.

runtimeFields

Welcome to the home of the runtime field editor and everything related to runtime fields!

savedObjectsTagging

Add tagging capability to saved objects

screenshotting

This plugin provides functionality to take screenshots of the Kibana pages. It uses Chromium and Puppeteer underneath to run the browser in headless mode.

searchprofiler

The search profiler consumes the Profile API by sending a search API with profile: true enabled in the request body. The response contains detailed information on how Elasticsearch executed the search request. People use this information to understand why a search request might be slow.

security

See Configuring security in Kibana.

securitySolution

Welcome to the Kibana Security Solution plugin! This README will go over getting started with development and testing.

sessionView

Session View is meant to provide a visualization into what is going on in a particular Linux environment where the agent is running. It looks likes a terminal emulator; however, it is a tool for introspecting process activity and understanding user and service behaviour in your Linux servers and infrastructure. It is a time-ordered series of process executions displayed in a tree over time.

snapshotRestore

or

spaces

See Configuring Kibana Spaces.

stackAlerts

This plugin provides alertTypes shipped with Kibana for use with the the alerting plugin. When enabled, it will register the alertTypes by the Stack in the alerting plugin, register associated HTTP routes, etc.

taskManager

The task manager is a generic system for running background tasks.

telemetryCollectionXpack

Gathers all usage collection, retrieving them from both: OSS and X-Pack plugins.

timelines

Timelines is a plugin that provides a grid component with accompanying server side apis to help users identify events of interest and perform root cause analysis within Kibana.

transform

This plugin provides access to the transforms features provided by Elastic.

Translations plugin

Contains Elastic-supported translations. Owned by the Localizations team. For adding localizations and instrument a ui to support translated content, see https://github.com/elastic/kibana/tree/main/packages/kbn-i18n

triggersActionsUi

The Kibana alerts and actions UI plugin provides a user interface for managing alerts and actions. As a developer you can reuse and extend built-in alerts and actions UI functionality:

uiActionsEnhanced

Registers commercially licensed generic actions like per panel time range and contains some code that supports drilldown work.

upgradeAssistant

Upgrade Assistant helps users prepare their Stack for being upgraded to the next major. It will only be enabled on the last minor before the next major release. This is controlled via the config: xpack.upgrade_assistant.readonly (#101296).

uptime

The purpose of this plugin is to provide users of Heartbeat more visibility of what’s happening in their infrastructure.

urlDrilldown

NOTE: This plugin contains implementation of URL drilldown. For drilldowns infrastructure code refer to ui_actions_enhanced plugin.

ux

https://docs.elastic.dev/kibana-dev-docs/welcome

watcher

This plugins adopts some conventions in addition to or in place of conventions in Kibana (at the time of the plugin’s creation):