List of Kibana plugins

edit

src/plugins

edit
Name Description

advancedSettings

WARNING: Missing README.

apmOss

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.

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.

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 in any environment or plugin. Developers can embed them directly in their plugin. End users can dynamically add them to any embeddable containers.

esUiShared

WARNING: Missing README.

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.

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.

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.

indexPatternManagement

WARNING: Missing README.

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.

kibanaLegacy

This plugin contains several helpers and services to integrate pieces of the legacy Kibana app with the new Kibana platform.

kibanaOverview

An overview page highlighting Kibana apps

kibanaReact

Tools for building React applications in Kibana.

kibanaUsageCollection

This plugin registers the basic usage collectors from Kibana:

kibanaUtils

Utilities for building Kibana plugins.

legacyExport

The legacyExport plugin adds support for the legacy saved objects export format.

management

WARNING: Missing README.

mapsLegacy

Internal objects used by the Coordinate, Region, and Vega visualizations.

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).

regionMap

Create choropleth maps. Display the results of a term-aggregation as e.g. countries, zip-codes, states.

savedObjects

The savedObjects plugin exposes utilities to manipulate saved objects on the client side.

savedObjectsManagement

The savedObjectsManagement plugin manages the Saved Objects management section.

savedObjectsTaggingOss

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

securityOss

securityOss is responsible for educating users about Elastic’s free security features, so they can properly protect the data within their clusters.

share

Replaces the legacy ui/share module for registering share context menus.

spacesOss

Bridge plugin for consumption of the Spaces feature from OSS plugins.

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).

tileMap

Create a coordinate map. Display the results of a geohash_tile aggregation as bubbles, rectangles, or heatmap color blobs.

timelion

Contains the deprecated timelion application. For the timelion visualization, which also contains the timelion APIs and backend, look at the vis_type_timelion plugin.

UI Actions

An API for:

- 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.

visTypeMarkdown

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

visTypeMetric

Contains the metric visualization.

visTypeTable

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

visTypeTagcloud

Contains the tagcloud visualization.

visTypeTimelion

Contains the timelion visualization and the timelion backend.

visTypeTimeseries

Contains everything around TSVB (the editor, visualizatin implementations and backends).

visTypeVega

Contains the Vega visualization.

visTypeVislib

Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and heatmap charts.

visTypeXy

Contains the new xy-axis chart using the elastic-charts library, which will eventually replace the vislib xy-axis charts including bar, area, and line.

visualizations

Contains most of the visualization infrastructure, e.g. the visualization type registry or the visualization embeddable.

visualize

x-pack/plugins

edit
Name Description

actions

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

alerts

The Kibana alerting plugin provides a common place to set up alerts. You can:

apm

To access an elasticsearch instance that has live data you have two options:

banners

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

beatsManagement

Notes: Failure to have auth enabled in Kibana will make for a broken UI. UI-based errors not yet in place

canvas

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

case

Experimental Feature

cloud

The cloud plugin adds cloud specific features to Kibana.

code

WARNING: Missing README.

consoleExtensions

This plugin provides autocomplete definitions of licensed APIs to the OSS Console plugin.

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.

dashboardMode

The deprecated dashboard only mode.

dataEnhanced

The data_enhanced plugin is the x-pack counterpart to the OSS data plugin.

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 as well as performing audit logging.

enterpriseSearch

This plugin’s goal is to provide a Kibana user interface to the Enterprise Search solution’s products (App Search and Workplace Search). In it’s current MVP state, the plugin provides the following with the goal of gathering user feedback and raising product awareness:

eventLog

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

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 a data stream using Console and you’ll be able to view it in the UI:

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 nodes. Please refer to the Elasticsearch documentation for more details.

lens

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

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.

mapsLegacyLicensing

This plugin provides access to the detailed tile map services from Elastic.

ml

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

monitoring

WARNING: Missing README.

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.

runtimeFields

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

savedObjectsTagging

Add tagging capability to saved objects

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.

snapshotRestore

or

spaces

See Configuring Kibana Spaces.

stackAlerts

This plugin provides alertTypes shipped with Kibana for use with the the alerts 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.

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/master/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. Its primary purposes are to:

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.

watcher

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

xpackLegacy

Contains HTTP endpoints and UiSettings that are slated for removal.