mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
* added files plugin * [Files] Create files saved object and blob storage (#131886) * initial version of file saved objects * initial version of file saved objects part ii * added .blob index and setup logic for the file service and the blob service * wip: need to add .blob access to kibana_system role * use multiple-isolated after speaking of oleg * added metadata field * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * [CI] Auto-commit changed files from 'node scripts/build_plugin_list_docs' * updated file statuses per feedback * removed created_by and added "alt" text field and converted "name" to type "text" too * split content_type into mime and extension * use BlobStorage interface in adapters prop * minor fixes * handle multiple Kibanas at startup time * fix jest test * do not set up index at setup time * set importable exportable to false explicitly * remove use of non-existent function * added plugin ID, use type instead of interface to avoid specific interface issue and use typescript to check that properties map corresponds to type * remove storage_id for now * make the name snake case! * added fixmes Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> * [Files] Implement ES-based blob store (#132123) * minor clean up * remove unused import * added modified version of the content stream from reporting * remove plugin_id, replace with file_kind * remove unused commented out code and clean up imports * added jest.config.js * added FileChunkDocument interface and added the head_chunk_id for easier deletion of related file chunks * added an additional test case for writing with content stream * first implementation of ES blob storage * fix imports * get closer to a final version of the blobstore interface, use esClient.get rather than esClient.search since we are using IDs * added jest integration tests * add some comments * fix: eslint types issues * remove unused values * minor refactor for clarity * fix when saved objects are registered * remove unused variable * fix jest tests and make getMaxSize function sync * fix logger prefixes Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> * [Files] File service CRUD functionality and audit logging (#132416) * big ol wipperooni, but got a lot of initial functionality written out * added some todos and fixed import * finish adding integration tests for file service! also added the partial update capability to file * added file service integration tests and finalized Files and InternalFileService APIs * added security plugin * big refactor for security audit logging: FileServiceFactory * type lint * update delete file integration test and remove done TODOs * move comment * docs, accessibility modifiers and updated some import ordering * fix comments * pass in index name to ES blob store * tidy up debug and error messages * [Files] Added more chunking Jest integration tests (#132530) * added more thorough integration tests of chunking * refactor chunksize to a value that is passed to the ES constructor, update a comment and update tests * [Files] Public API v1 (#132602) * created public API, everything except the file registry * ensure the custom meta types are working as expected * added index: false to content * Revert "added index: false to content" This reverts commit 74259f86638aefc24755874cbd6ac89e0170c192. * updated comment * update how ids are generated * also filter out deleted files * fix id generation * test file deletion after upload failure * [Files] File kinds registry v0.1 (#132700) * initial commit of file kind registry * add actual registry * updated attributes reduceer slightly * separate blob storage interface, make the blob storage type a unique const * added integration test for file kinds * update test after adding registry logic * partial attributes * [Files] Blob storage with attributes (#134057) * updated blob storage interface with attributes * added dynamic: false to the file chunk doc for ES blob store * update mocks * support attributes at the blob store level part i * actually test setting of attributes, also refactor app_extra_data to app_meta_data * remove unused import * some corrections to tests, also refresh after creating a blob that has attributes to enable search * remove unnecessary default * getBaseId -> getContentReferenceId and added a bunch of doc comments * refactored getting of attribute chunk id, encapsulate everything inside content stream * remove app_search_data * app_meta_data -> app_metadata * [Files] Added `Transform` to blob stores (#134846) * added max byte size stream transform * added stream transforms to files * rename MaxByteSize to MaxByteSizeTransform * try a cool cool ternary, yeah * minor refactor * address PR feedback * [Files] File kind HTTP APIs and tests (#134655) * first version of dynamically creating file kinds routes * added update, delete, download, list and find endpoints and some minor refactoring * added return statement and additional requirement for file kind ids to be URI safe * update comment * added API integration tests for the file kinds routes, a lot of refactoring; removed the upload endpoint service since this does not make since with proxies, fixed a bunch of issues in registering routes and the enhanced file kind router * move the method to the specific route file too * remove unused function * add download content type response header * remove unused import * download http method should be "get" not "delete" * actually pass through the mime type * slight refactor after changing the create file response * findFile => getById * remove trailing verbs * update copy * addressing pr feedback * added missing property * fix copy * added comment * regrouping imoprts * rename "find" route to "getById" * [File storage] Public-side Client (#135403) * refactor store name * wip: first version of restful-ish endpoint types captured in one place except for path * use the endpoint definition directly * added first iteration of files client based on shared types * slight refactor * added content type headers and removed unused type * slight refactor and expose server and public side types * finish refactor * updated files plugin ui limits * [Files] Public file sharing service (#135598) * add new public file saved object type * generate random token * file share service, first iteration * initial version of files share service work, we can create a file share * delete shares when a file is deleted * refactor to InternalFileSharingService because certain events need to be audited * further clean up and added a comment * finish refactor * update tests * refactor tractor * move integration tests folder * does not need to be async, also added some samples to doc comment * added comment * use SO object references instead of hacking it yourself, also added comments and moved some stuff around * refactor to internal file share service * fix type lint * valid_until as unix ts * commit simplify random string generator * fix type issues and update SO integration tests * woops, 51 not 55 * change label * minor refactor to file service (#135836) * remove attributes from blobstore layer and update IDs to be xxxxx.1 instead of 1.xxxxx (#136294) * [Files] Refactor File metadata (#136370) * refactor tractor keeps on rolling * fix type issues * [Files] Conform with new blob store specification (#136396) * refactor es mappings * move puid file * updated the content stream implementation to support identifying "last" chunk * updated the es blob store * updated es mappings * minor updates to the file object, but importantly, passing the file ID to the blob store so that files and blobs are connected * updated test assertion * rather use cuid because it uses cryptography to reduce the chance of collisions (#136658) * do not index bid field (#136707) * [Files] Find endpoint (#136529) * refactor http endpoint interface names * wip on find files route, need to create shared test harness and test utils * added toJSON helper * pass through the filter * fix refactor to "getById" on file service instead of find and move order of attributes * actually add the toJSON utility * added shared integration test setup code * added find route path to common * return if 400 is returned when trying to create blob storage index. This is an edge case that can be hit if creation happens at the same time * update the find algo to build a kuery expression string that we pass to SO service, note: we want to prevent query injection shenanigans so we JSON.stringify * updated the create endpoint to enforce mime type from file type, thank you * updated the create endpoint to enforce mime type from file type, thank you * updated some tests and actually register the find enpoint, also updated to use mimeType * added a few integration level tests for the new find endpoint * updated the new setup integration test harness for use in new find and old file kinds integration tests * use flattened type for "Meta" and "hash" fields on saved object so that we can store multiple values in an object and search * updated import with "type" annotation * added readme explaining patterns used for routes * fix file kind integration tests * remove unused endpoint * do not expose chunk size and compression for now * use nodeBuilder rather than manually building a kuery string * make query strings limited in length and refactor "Extension" to "extension" plus some other minor changes * reorg some lines * [Files] Use `application/cbor` to optimise file uploads and downloads (#136528) * move puid file * added cbor-x dependency * remove all references to "raw" from the test code * remove "encoding" parameter and refactor to use cbor encoding for blob chunks, in this way we do not encoding our payloads to UTF-8 or Base64 Kibana side, only decode * fixed content stream tests * require instead of import cbor-x for now * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * try disable eslint comment scoped * download also as cbor to buffer directly, also updated upload endpoint to report when content has already been uploaded * updated tests and handle some edge case when reading buffers * remove unused require and added a comment * moved lengthy comment to separate file Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> * [Files] Added metrics endpoint and functionality (#136725) * added service-level functionality for getting usage metrics * built the metrics endpoint * do not count size of deleted files * updated comment * added agg by status and extension * update test assertions * [Files] File errors (#136946) * added domain-specific errors * map file errors to http responses and clean up list endpoint * [Files] Public File share HTTP endpoints (#137172) * refactor where server and client routes are declared * added new endpoint types and refactor api/files/files/metrics|share to api/files/metrics|share * added some more comments, a new error type for the file share service and created the endpoint handler for creating file shares * added doc comments to the file kind interface * rename test utils folder to "test_utils" and added a basic test for creating a share * added test_util folder and updated share test * added new endpoint types, updated import to test utils, updated share name * added unshare endpoint * added share list endpoint and refactored share JSON with version that contains token and version without * actually register the list shares route * a bunch of refactoring for saved object type "id" rather than "token" for the object id, also added the public download endpoint * updated error behavior on download endpoint * fixed test * use unix timestamp in seconds * added file name param to public download endpoint and added shared fileName schema * remove unused file and added public download tests * share to shares * added get endopint and updated tests and test titles per feedback * added get endpoint * updated test and back to milliseconds on validUntil * updated name of params in route and update error message in response * return only known messages in the expected format * update test * use Readable.from * reintroduce crazy typecasting * added security audit log tests (#137253) * [Files] Generate download headers utility tests (#137203) * move common schema to common schema file and move THAT file to a shared location * update mime type behaviour * update integration tests * added a little something to the README * update cbor-x to latest * delete "require" of cbor-x * upgrade cbor-x * rename "public" to "public_facing" * remove old lint rule * added a bunch of docs * fix interface surface area * more doc comments * more more doc comments * more more more doc comments * more more more more doc comments * more more more more more more doc comments * Actually 50GiB Co-authored-by: Vadim Kibana <82822460+vadimkibana@users.noreply.github.com> * Remove unnecessary comment Co-authored-by: Vadim Kibana <82822460+vadimkibana@users.noreply.github.com> * hasContent -> isReady * only call the createIndexIfNotExists function once per instance * [Files] Create files client (#137879) * biig refactor to use FileClient in File and remove all metadata functionality from file service * update file service factory to work with metadata client after refactor * also rename file share updateable attrs interface * updated use of types in saved objects client * export function arg types * added the creation helper file and added an example file for using it * implement find for the es index client * moved the query builder logic to a shared place * rename file, add prefixes and embed es doc in "file" key in ES document * type exports * fix bad rebase * Minor changes and updates to types * fix another minor type issue * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * fix minor type issues and update "update" behavior to only apply updatable fields bru * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' * actually be able to update status... also some other types cleanups * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> * remove TODO * update link to team * throw errors more consistently * createAuditLog -> writeAuditLog * more more more more more more more doc comments * more more more more more more more more doc comments * more more more more more more more more more doc comments * more more more more more more more more more more doc comments * more more more more more more more more more more more more doc comments * [Files] ES client tests (#138174) * move test utils and update expected metric size * remove cuid from "file" * update file client to set id using cuid and update types * moved test utils and wip of integration tests for file client * added es-index backed file client tests * adjust the upload endpoint to also return the file size * added size to response expect * fix some type issues * fix type issues * [Files] Register routes at setup time (#138392) * updated the fileKindRegistory to live behind a getter setter so that instantation can be taken care of in one place * refactor conditional endpoint registration and update tests to register file kind after setup * register routes at setup time * remove outdated README * fix import of non-existent function * register routes... * [Files] PR feedback 1 (#138417) * update comments and plugin description * filter lists and finds on non-deleted files * updated comment * added tests for larger files and files exactly divisible by chunk size * [CI] Auto-commit changed files from 'node scripts/build_plugin_list_docs' * do not use regexp * fix test assertion * update content stream tests * make fewer fields searchable * ok Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> * remove legacy comment Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Vadim Kibana <82822460+vadimkibana@users.noreply.github.com>
691 lines
30 KiB
Text
691 lines
30 KiB
Text
////
|
||
|
||
NOTE:
|
||
This is an automatically generated file. Please do not edit directly. Instead, run the
|
||
following from within the kibana repository:
|
||
|
||
node scripts/build_plugin_list_docs
|
||
|
||
You can update the template within node_modules/@kbn/dev-utils/target_node/plugin_list/generate_plugin_list.js
|
||
|
||
////
|
||
|
||
[[plugin-list]]
|
||
== List of {kib} plugins
|
||
|
||
[discrete]
|
||
=== src/plugins
|
||
|
||
[%header,cols=2*]
|
||
|===
|
||
|Name
|
||
|Description
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/advanced_settings/README.md[advancedSettings]
|
||
|This plugin contains the advanced settings management section
|
||
allowing users to configure their advanced settings, also known
|
||
as uiSettings within the code.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/bfetch/README.md[bfetch]
|
||
|bfetch allows to batch HTTP requests and streams responses back.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/charts/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/console/README.md[console]
|
||
|Console provides the user with tools for storing and executing requests against Elasticsearch.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/controls/README.mdx[controls]
|
||
|The Controls plugin contains Embeddables which can be used to add user-friendly interactivity to apps.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/custom_integrations/README.md[customIntegrations]
|
||
|Register add-data cards
|
||
|
||
|
||
|<<kibana-dashboard-plugin>>
|
||
|- Registers the dashboard application.
|
||
- Adds a dashboard embeddable that can be used in other applications.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/data/README.mdx[data]
|
||
|The data plugin provides common data access services, such as search and query, for solutions and application developers.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/data_view_editor/README.md[dataViewEditor]
|
||
|Create data views from within Kibana apps.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/data_view_field_editor/README.md[dataViewFieldEditor]
|
||
|The reusable field editor across Kibana!
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/data_view_management[dataViewManagement]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/data_views/README.mdx[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/dev_tools/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/discover/README.md[discover]
|
||
|Contains the Discover application and the saved search embeddable.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/embeddable/README.md[embeddable]
|
||
|The Embeddables Plugin provides an opportunity to expose reusable interactive widgets that can be embedded outside the original plugin.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/es_ui_shared/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/event_annotation/README.md[eventAnnotation]
|
||
|The Event Annotation service contains expressions for event annotations
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/expression_error/README.md[expressionError]
|
||
|Expression Error plugin adds an error renderer to the expression plugin. The renderer will display the error image.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/chart_expressions/expression_gauge[expressionGauge]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/chart_expressions/expression_heatmap[expressionHeatmap]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/expression_image/README.md[expressionImage]
|
||
|Expression Image plugin adds an image renderer to the expression plugin. The renderer will display the given image.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/chart_expressions/expression_legacy_metric/README.md[expressionLegacyMetricVis]
|
||
|Expression MetricVis plugin adds a metric renderer and function to the expression plugin. The renderer will display the metric chart.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/expression_metric/README.md[expressionMetric]
|
||
|Expression Metric plugin adds a metric renderer and function to the expression plugin.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/chart_expressions/expression_metric/README.md[expressionMetricVis]
|
||
|Expression MetricVis plugin adds a metric renderer and function to the expression plugin. The renderer will display the metric chart.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/chart_expressions/expression_partition_vis/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/expression_repeat_image/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/expression_reveal_image/README.md[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.
|
||
|
||
|
||
|<<kibana-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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/expression_shape/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/chart_expressions/expression_tagcloud/README.md[expressionTagcloud]
|
||
|Expression Tagcloud plugin adds a tagcloud renderer and function to the expression plugin. The renderer will display the Wordcloud chart.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/chart_expressions/expression_xy/README.md[expressionXY]
|
||
|Expression XY plugin adds a xy renderer and function to the expression plugin. The renderer will display the xy chart.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/field_formats/README.md[fieldFormats]
|
||
|Index pattern fields formatters
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/home/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/input_control_vis/README.md[inputControlVis]
|
||
|Contains the input control visualization allowing to place custom filter controls on a dashboard.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/inspector/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/interactive_setup/README.md[interactiveSetup]
|
||
|The plugin provides UI and APIs for the interactive setup mode.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/kibana_overview/README.md[kibanaOverview]
|
||
|An overview page highlighting Kibana apps
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/kibana_react/README.md[kibanaReact]
|
||
|Tools for building React applications in Kibana.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/kibana_usage_collection/README.md[kibanaUsageCollection]
|
||
|This plugin registers the Platform Usage Collectors in Kibana.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/kibana_utils/README.md[kibanaUtils]
|
||
|Utilities for building Kibana plugins.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/management/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/maps_ems/README.md[mapsEms]
|
||
|Utility plugin:
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/navigation/README.md[navigation]
|
||
|The navigation plugins exports the TopNavMenu component.
|
||
It also provides a stateful version of it on the start contract.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/newsfeed/README.md[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) once a day, with periodic checks if the content needs to be refreshed. All newsfeed content is hosted remotely.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/presentation_util/README.mdx[presentationUtil]
|
||
|The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas).
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/saved_objects/README.md[savedObjects]
|
||
|NOTE: This plugin is deprecated and will be removed in 8.0. See https://github.com/elastic/kibana/issues/46435 for more information.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/saved_objects_management/README.md[savedObjectsManagement]
|
||
|The savedObjectsManagement plugin manages the Saved Objects management section.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/saved_objects_tagging_oss/README.md[savedObjectsTaggingOss]
|
||
|Bridge plugin for consumption of the saved object tagging feature from
|
||
oss plugins.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/screenshot_mode/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/share/README.mdx[share]
|
||
|The share plugin contains various utilities for displaying sharing context menu,
|
||
generating deep links to other apps using locators, and creating short URLs.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/shared_ux/README.md[sharedUX]
|
||
|Our mission is to make consistency in our user experience a product.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/telemetry/README.md[telemetry]
|
||
|Telemetry allows Kibana features to have usage tracked in the wild. The general term "telemetry" refers to multiple things:
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/telemetry_collection_manager/README.md[telemetryCollectionManager]
|
||
|Telemetry's collection manager to go through all the telemetry sources when fetching it before reporting.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/telemetry_management_section/README.md[telemetryManagementSection]
|
||
|This plugin adds the Advanced Settings section for the Usage and Security Data collection (aka Telemetry).
|
||
|
||
|
||
|<<uiactions-plugin>>
|
||
|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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/ui_actions_enhanced/README.md[uiActionsEnhanced]
|
||
|Registers commercially licensed generic actions like per panel time range and contains some code that supports drilldown work.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/unified_search/README.md[unifiedSearch]
|
||
|Contains all the components of Kibana's unified search experience. Specifically:
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/url_forwarding/README.md[urlForwarding]
|
||
|This plugins contains helpers to redirect legacy URLs. It can be used to forward old URLs to their new counterparts.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/usage_collection/README.mdx[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_default_editor/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/gauge[visTypeGauge]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/heatmap[visTypeHeatmap]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_type_markdown/README.md[visTypeMarkdown]
|
||
|The markdown visualization that can be used to place text panels on dashboards.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/metric[visTypeMetric]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/pie[visTypePie]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/table/README.md[visTypeTable]
|
||
|Contains the data table visualization, that allows presenting data in a simple table format.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/tagcloud[visTypeTagcloud]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/timelion/README.md[visTypeTimelion]
|
||
|Contains the timelion visualization and the timelion backend.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/timeseries[visTypeTimeseries]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/vega[visTypeVega]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/vislib[visTypeVislib]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/vis_types/xy[visTypeXy]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/src/plugins/visualizations[visualizations]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|===
|
||
|
||
[discrete]
|
||
=== x-pack/plugins
|
||
|
||
[%header,cols=2*]
|
||
|===
|
||
|Name
|
||
|Description
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/actions/README.md[actions]
|
||
|The Kibana actions plugin provides a framework to create executable actions. You can:
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/aiops/README.md[aiops]
|
||
|The plugin provides APIs and components for AIOps features, including the “Explain log rate spikes” UI, maintained by the ML team.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/alerting/README.md[alerting]
|
||
|The Kibana Alerting plugin provides a common place to set up rules. You can:
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/apm/readme.md[apm]
|
||
|undefined
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/banners/README.md[banners]
|
||
|Allow to add a header banner that will be displayed on every page of the Kibana application
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/canvas/README.md[canvas]
|
||
|"Never look back. The past is done. The future is a blank canvas." ― Suzy Kassem, Rise Up and Salute the Sun
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/cases/README.md[cases]
|
||
|This plugin provides cases management in Kibana
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/cloud/README.md[cloud]
|
||
|The cloud plugin adds Cloud-specific features to Kibana.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/cloud_security_posture/README.md[cloudSecurityPosture]
|
||
|Cloud Posture automates the identification and remediation of risks across cloud infrastructures
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/cross_cluster_replication/README.md[crossClusterReplication]
|
||
|You can run a local cluster and simulate a remote cluster within a single Kibana directory.
|
||
|
||
|
||
|<<dashboard-enhanced-plugin>>
|
||
|Adds drilldown capabilities to dashboard. Owned by the Kibana App team.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/data_visualizer/README.md[dataVisualizer]
|
||
|The data_visualizer plugin enables you to explore the fields in your data.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/discover_enhanced/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/encrypted_saved_objects/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/enterprise_search/README.md[enterpriseSearch]
|
||
|This plugin provides Kibana user interfaces for managing the Enterprise Search solution and its products, App Search and Workplace Search.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/event_log/README.md[eventLog]
|
||
|The event log plugin provides a persistent history of alerting and action
|
||
activities.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/features/README.md[features]
|
||
|The features plugin enhance Kibana with a per-feature privilege system.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/files/README.md[files]
|
||
|File upload, download, sharing, and serving over HTTP implementation in Kibana.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/file_upload[fileUpload]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/fleet/README.md[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)
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/global_search/README.md[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
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/global_search_bar/README.md[globalSearchBar]
|
||
|The GlobalSearchBar plugin provides a search interface for navigating Kibana. (It is the UI to the GlobalSearch plugin.)
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/global_search_providers/README.md[globalSearchProviders]
|
||
|The globalSearchProviders plugin provides Kibana default search providers for the GlobalSearch plugin.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/graph/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/grokdebugger/README.md[grokdebugger]
|
||
|This plugin helps users define Grok patterns,
|
||
which are particularly useful for ingesting logs.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/index_lifecycle_management/README.md[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:
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/index_management/README.md[indexManagement]
|
||
|Create an index with special characters and verify it renders correctly:
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/infra/README.md[infra]
|
||
|This is the home of the infra plugin, which aims to provide a solution for
|
||
the infrastructure monitoring use-case within Kibana.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/ingest_pipelines/README.md[ingestPipelines]
|
||
|The ingest_pipelines plugin provides Kibana support for Elasticsearch's ingest pipelines.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/kubernetes_security/README.md[kubernetesSecurity]
|
||
|(under construction)
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/lens/readme.md[lens]
|
||
|Lens is a visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/license_api_guard/README.md[licenseApiGuard]
|
||
|This plugin is used by ES UI plugins to reject API requests when the plugin is unsupported by the user's license.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/license_management/README.md[licenseManagement]
|
||
|This plugin enables users to activate a trial license, downgrade to Basic, and upload a new license.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/licensing/README.md[licensing]
|
||
|The licensing plugin retrieves license data from Elasticsearch at regular configurable intervals.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/lists/README.md[lists]
|
||
|README.md for developers working on the backend lists on how to get started
|
||
using the CURL scripts in the scripts folder.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/logstash[logstash]
|
||
|WARNING: Missing README.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/maps/README.md[maps]
|
||
|Visualize geo data from Elasticsearch or 3rd party geo-services.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/ml/readme.md[ml]
|
||
|This plugin provides access to the machine learning features provided by
|
||
Elastic.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/monitoring/readme.md[monitoring]
|
||
|This plugin provides the Stack Monitoring kibana application.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/monitoring_collection/README.md[monitoringCollection]
|
||
|This plugin allows for other plugins to add data to Kibana stack monitoring documents.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/observability/README.md[observability]
|
||
|This plugin provides shared components and services for use across observability solutions, as well as the observability landing page UI.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/osquery/README.md[osquery]
|
||
|This plugin adds extended support to Security Solution Fleet Osquery integration
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/painless_lab/README.md[painlessLab]
|
||
|This plugin helps users learn how to use the Painless scripting language.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/remote_clusters/README.md[remoteClusters]
|
||
|This plugin helps users manage their remote clusters, which enable cross-cluster search and cross-cluster replication.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/reporting/README.md[reporting]
|
||
|An awesome Kibana reporting plugin
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/rollup/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/rule_registry/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/runtime_fields/README.md[runtimeFields]
|
||
|Welcome to the home of the runtime field editor and everything related to runtime fields!
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/saved_objects_tagging/README.md[savedObjectsTagging]
|
||
|Add tagging capability to saved objects
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/screenshotting/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/searchprofiler/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/security/README.md[security]
|
||
|See Configuring security in
|
||
Kibana.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/security_solution/README.md[securitySolution]
|
||
|Welcome to the Kibana Security Solution plugin! This README will go over getting started with development and testing.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/session_view/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/snapshot_restore/README.md[snapshotRestore]
|
||
|or
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/spaces/README.md[spaces]
|
||
|See Configuring Kibana Spaces.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/stack_alerts/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/synthetics/README.md[synthetics]
|
||
|The purpose of this plugin is to provide users of Heartbeat more visibility of what's happening
|
||
in their infrastructure.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/task_manager/README.md[taskManager]
|
||
|The task manager is a generic system for running background tasks.
|
||
Documentation: https://www.elastic.co/guide/en/kibana/master/task-manager-production-considerations.html
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/telemetry_collection_xpack/README.md[telemetryCollectionXpack]
|
||
|Gathers all usage collection, retrieving them from both: OSS and X-Pack plugins.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/threat_intelligence/README.md[threatIntelligence]
|
||
|Elastic Threat Intelligence makes it easy to analyze and investigate potential security threats by aggregating data from multiple sources in one place. You’ll be able to view data from all activated threat intelligence feeds and take action.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/timelines/README.md[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.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/transform/readme.md[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
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/triggers_actions_ui/README.md[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:
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/upgrade_assistant/README.md[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).
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/drilldowns/url_drilldown/README.md[urlDrilldown]
|
||
|NOTE: This plugin contains implementation of URL drilldown. For drilldowns infrastructure code refer to ui_actions_enhanced plugin.
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/ux/readme.md[ux]
|
||
|https://docs.elastic.dev/kibana-dev-docs/welcome
|
||
|
||
|
||
|{kib-repo}blob/{branch}/x-pack/plugins/watcher/README.md[watcher]
|
||
|This plugins adopts some conventions in addition to or in place of conventions in Kibana (at the time of the plugin's creation):
|
||
|
||
|
||
|===
|
||
|
||
include::{kibana-root}/src/plugins/dashboard/README.asciidoc[leveloffset=+1]
|
||
include::{kibana-root}/src/plugins/expressions/README.asciidoc[leveloffset=+1]
|
||
include::{kibana-root}/src/plugins/ui_actions/README.asciidoc[leveloffset=+1]
|
||
include::{kibana-root}/x-pack/plugins/dashboard_enhanced/README.asciidoc[leveloffset=+1]
|
||
include::{kibana-root}/x-pack/plugins/embeddable_enhanced/README.asciidoc[leveloffset=+1]
|
||
include::{kibana-root}/x-pack/plugins/translations/README.asciidoc[leveloffset=+1]
|