Skip to content

Commit

Permalink
Merge branch 'master' of github.com:elastic/kibana into 2021-02-25-ap…
Browse files Browse the repository at this point in the history
…i-doc-final-step
  • Loading branch information
stacey-gammon committed Mar 2, 2021
2 parents 43003a5 + 36523bb commit ee93939
Show file tree
Hide file tree
Showing 1,122 changed files with 22,067 additions and 8,415 deletions.
10 changes: 9 additions & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -1316,7 +1316,7 @@ module.exports = {

{
files: [
// platform-team owned code
// core-team owned code
'src/core/**',
'x-pack/plugins/features/**',
'x-pack/plugins/licensing/**',
Expand All @@ -1325,6 +1325,14 @@ module.exports = {
'packages/kbn-config-schema',
'src/plugins/status_page/**',
'src/plugins/saved_objects_management/**',
'packages/kbn-analytics/**',
'packages/kbn-telemetry-tools/**',
'src/plugins/kibana_usage_collection/**',
'src/plugins/usage_collection/**',
'src/plugins/telemetry/**',
'src/plugins/telemetry_collection_manager/**',
'src/plugins/telemetry_management_section/**',
'x-pack/plugins/telemetry_collection_xpack/**',
],
rules: {
'@typescript-eslint/prefer-ts-expect-error': 'error',
Expand Down
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,7 @@ x-pack/plugins/telemetry_collection_xpack/schema/ @elastic/kibana-core @elastic/
# Security
/src/core/server/csp/ @elastic/kibana-security @elastic/kibana-core
/src/plugins/security_oss/ @elastic/kibana-security
/src/plugins/spaces_oss/ @elastic/kibana-security
/test/security_functional/ @elastic/kibana-security
/x-pack/plugins/spaces/ @elastic/kibana-security
/x-pack/plugins/encrypted_saved_objects/ @elastic/kibana-security
Expand Down
138 changes: 138 additions & 0 deletions dev_docs/building_blocks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
---
id: kibBuildingBlocks
slug: /kibana-dev-docs/building-blocks
title: Building blocks
summary: Consider these building blocks when developing your plugin.
date: 2021-02-24
tags: ['kibana','onboarding', 'dev', 'architecture']
---

When building a plugin in Kibana, there are a handful of architectural "building blocks" you can use. Some of these building blocks are "higher-level",
and some are "lower-level". High-level building blocks come
with many built-in capabilities, require less maintenance, and evolve new feature sets over time with little to no
impact on consumers. When developers use high-level building blocks, new features are exposed consistently, across all of Kibana, at the same time.
On the downside, they are not as flexible as our low-level building blocks.

Low-level building blocks
provide greater flexibility, but require more code to stitch them together into a meaningful UX. This results in higher maintenance cost for consumers and greater UI/UX variability
across Kibana.

For example, if an application is using <DocLink id="kibBuildingBlocks" section="index-patterns" text="Index Patterns"/> and
<DocLink id="kibBuildingBlocks" section="search-source" text="Search Source"/>,
their application would automatically support runtime fields. If the app is instead using the
lower-level <DocLink id="kibBuildingBlocks" section="search-strategy" text="Search Strategy"/>, additional work would be required.

Armed with this knowledge, you can choose what works best for your use case!

# Application building blocks

## UI components

The following high-level building blocks can be rendered directly into your application UI.

### Query Bar

The <DocLink id="kibDataPlugin" text="Data plugin"/> provides a high-level Query Bar component that comes with support for Lucene, KQL, Saved Queries,
and <DocLink id="kibBuildingBlocks" section="index-patterns" text="Index Patterns"/>.

If you would like to expose the ability to search and filter on Elasticsearch data, the Query Bar provided by the
<DocLink id="kibDataPlugin" text="Data plugin"/>
is your go-to building block.

**Github labels**: `Team:AppServices`, `Feature:QueryBar`

### Dashboard Embeddable

Add a Dashboard Embeddable directly inside your application to provide users with a set of visualizations and graphs that work seamlessly
with the <DocLink id="kibBuildingBlocks" section="query-bar" text="Query Bar"/>. Every feature that is added to a registered
<DocLink id="kibBuildingBlocks" section="embeddables" text="Embeddable"/>
(Lens, Maps, Saved Searches and more) will be available automatically, as well as any
<DocLink id="kibBuildingBlocks" section="ui-actions--triggers" text="UI Actions"/> that are
added to the Embeddable context menu panel (for example, drilldowns, custom panel time ranges, and "share to" features).

The Dashboard Embeddable is one of the highest-level UI components you can add to your application.

**Github labels**: `Team:Presentation`, `Feature:Dashboard`

### Lens Embeddable

Check out the Lens Embeddable if you wish to show users visualizations based on Elasticsearch data without worrying about query building and chart rendering. It's built on top of the
<DocLink id="kibBuildingBlocks" section="expressions" text="Expression language"/>, and integrates with
<DocLink id="kibBuildingBlocks" section="index-patterns" text="Index Patterns"/>
and <DocLink id="kibBuildingBlocks" section="ui-actions--triggers" text="UI Actions"/>. Using the same configuration, it's also possible to link to
a prefilled Lens editor, allowing the user to drill deeper and explore their data.

**Github labels**: `Team:KibanaApp`, `Feature:Lens`

### Map Embeddable

Check out the Map Embeddable if you wish to embed a map in your application.

**Github labels**: `Team:Geo`

## Searching

### Index Patterns

<DocLink id="kibDataPlugin" section="index-patterns-api" text="Index Patterns"/> are a high-level, space-aware abstraction layer that sits
above Data Streams and Elasticsearch indices. Index Patterns provide users the
ability to define and customize the data they wish to search and filter on, on a per-space basis. For example, users can specify a set of indices,
and they can customize the field list with runtime fields, formatting options and custom labels.

Index Patterns are used in many other high-level building blocks so we highly recommend you consider this building block for your search needs.

**Github labels**: `Team:AppServices`, `Feature:Index Patterns`

### Search Source

<DocLink id="kibDataPlugin" section="searchsource" text="Search Source"/> is a high-level search service offered by the
<DocLink id="kibDataPlugin" section="searchsource" text="Data plugin"/>. It requires an
<DocLink id="kibBuildingBlocks" section="index-patterns" text="Index Pattern"/>, and abstracts away the raw ES DSL and search endpoint. Internally
it uses the ES <DocLink id="kibBuildingBlocks" section="search-strategies" text="Search Strategy"/>. Use Search Source if you need to query data
from Elasticsearch, and you aren't already using one of the high-level UI Components that handles this internally.

**Github labels**: `Team:AppServices`, `Feature:Search`

### Search Strategies

Search Strategies are a low-level building block that abstracts away search details, like what REST endpoint is being called. The ES Search Strategy
is a very lightweight abstraction layer that sits just above querying ES with the elasticsearch-js client. Other search stragies are offered for other
languages, like EQL and SQL. These are very low-level building blocks so expect a lot of glue work to make these work with the higher-level abstractions.

**Github labels**: `Team:AppServices`, `Feature:Search`

### Expressions

Expressions are a low-level building block that can be used if you have advanced search needs that requiring piping results into additional functionality, like
joining and manipulating data. Lens and Canvas are built on top of Expressions. Most developers should be able to use
<DocLink id="kibBuildingBlocks" section="lens-embeddable" text="Lens"/> or
<DocLink id="kibBuildingBlocks" section="search-source" text="Search Source"/>, rather than need to access the Expression language directly.

**Github labels**: `Team:AppServices`, `Feature:ExpressionLanguage`

## Saved Objects

<DocLink id="kibDevDocsSavedObjectsIntro" text="Saved Objects" /> should be used if you need to persist application-level information. If you were building a TODO
application, each TODO item would be a `Saved Object`. Saved objects come pre-wired with support for bulk export/import, security features like space sharing and
space isolation, and tags.

**Github labels**: `Team:Core`, `Feature:Saved Objects`

# Integration building blocks

Use the following building blocks to create an inter-connected, cross-application, holistic Kibana experience. These building blocks allow you to expose functionality
that promotes your own application into other applications, as well as help developers of other applications integrate into your app.

## UI Actions & Triggers

Integrate custom actions into other applications by registering UI Actions attached to existing triggers. For example, the Maps
application could register a UI Action called "View in Maps" to appear any time the user clicked a geo field to filter on.

**Github labels**: `Team:AppServices`, `Feature:UIActions`

## Embeddables

Embeddables help you integrate your application with the Dashboard application. Register your custom UI Widget as an Embeddable and users will
be able to add it as a panel on a Dashboard. With a little extra work, it can also be exposed in Canvas workpads.

**Github labels**: `Team:AppServices`, `Feature:Embeddables`
10 changes: 9 additions & 1 deletion docs/api/actions-and-connectors/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ Creates an action.

`POST <kibana host>:<port>/api/actions/action`

`POST <kibana host>:<port>/s/<space_id>/api/actions/action`

[[actions-and-connectors-api-create-path-params]]
==== Path parameters

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[actions-and-connectors-api-create-request-body]]
==== Request body

Expand Down Expand Up @@ -67,4 +75,4 @@ The API returns the following:
},
"isPreconfigured": false
}
--------------------------------------------------
--------------------------------------------------
6 changes: 5 additions & 1 deletion docs/api/actions-and-connectors/delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,17 @@ WARNING: When you delete an action, _it cannot be recovered_.

`DELETE <kibana host>:<port>/api/actions/action/<id>`

`DELETE <kibana host>:<port>/s/<space_id>/api/actions/action/<id>`

[[actions-and-connectors-api-delete-path-params]]
==== Path parameters

`id`::
(Required, string) The ID of the action.

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[actions-and-connectors-api-delete-response-codes]]
==== Response code

Expand All @@ -32,4 +37,3 @@ WARNING: When you delete an action, _it cannot be recovered_.
$ curl -X DELETE api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
--------------------------------------------------
// KIBANA

7 changes: 6 additions & 1 deletion docs/api/actions-and-connectors/execute.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ Executes an action by ID.

`POST <kibana host>:<port>/api/actions/action/<id>/_execute`

`POST <kibana host>:<port>/s/<space_id>/api/actions/action/<id>/_execute`

[[actions-and-connectors-api-execute-params]]
==== Path parameters

`id`::
(Required, string) The ID of the action.

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[actions-and-connectors-api-execute-request-body]]
==== Request body

Expand Down Expand Up @@ -80,4 +85,4 @@ The API returns the following:
},
"actionId": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad"
}
--------------------------------------------------
--------------------------------------------------
5 changes: 5 additions & 0 deletions docs/api/actions-and-connectors/get.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ Retrieves an action by ID.

`GET <kibana host>:<port>/api/actions/action/<id>`

`GET <kibana host>:<port>/s/<space_id>/api/actions/action/<id>`

[[actions-and-connectors-api-get-params]]
==== Path parameters

`id`::
(Required, string) The ID of the action.

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[actions-and-connectors-api-get-codes]]
==== Response code

Expand Down
8 changes: 8 additions & 0 deletions docs/api/actions-and-connectors/get_all.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ Retrieves all actions.

`GET <kibana host>:<port>/api/actions`

`GET <kibana host>:<port>/s/<space_id>/api/actions`

[[actions-and-connectors-api-get-all-path-params]]
==== Path parameters

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[actions-and-connectors-api-get-all-codes]]
==== Response code

Expand Down
8 changes: 8 additions & 0 deletions docs/api/actions-and-connectors/list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ Retrieves a list of all action types.

`GET <kibana host>:<port>/api/actions/list_action_types`

`GET <kibana host>:<port>/s/<space_id>/api/actions/list_action_types`

[[actions-and-connectors-api-list-path-params]]
==== Path parameters

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[actions-and-connectors-api-list-codes]]
==== Response code

Expand Down
5 changes: 5 additions & 0 deletions docs/api/actions-and-connectors/update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ Updates the attributes for an existing action.

`PUT <kibana host>:<port>/api/actions/action/<id>`

`PUT <kibana host>:<port>/s/<space_id>/api/actions/action/<id>`

[[actions-and-connectors-api-update-params]]
==== Path parameters

`id`::
(Required, string) The ID of the action.

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[actions-and-connectors-api-update-request-body]]
==== Request body

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ Create {kib} alerts.

`POST <kibana host>:<port>/api/alerts/alert/<id>`

`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>`

[[alerts-api-create-path-params]]
==== Path parameters

`<id>`::
(Optional, string) Specifies a UUID v1 or v4 to use instead of a randomly generated ID.

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[alerts-api-create-request-body]]
==== Request body

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,17 @@ WARNING: Once you delete an alert, you cannot recover it.

`DELETE <kibana host>:<port>/api/alerts/alert/<id>`

`DELETE <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>`

[[alerts-api-delete-path-params]]
==== Path parameters

`id`::
(Required, string) The ID of the alert that you want to remove.

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[alerts-api-delete-response-codes]]
==== Response code

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/disable.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ Disable an alert.

`POST <kibana host>:<port>/api/alerts/alert/<id>/_disable`

`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>/_disable`

[[alerts-api-disable-path-params]]
==== Path parameters

`id`::
(Required, string) The ID of the alert that you want to disable.

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[alerts-api-disable-response-codes]]
==== Response code

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/enable.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ Enable an alert.

`POST <kibana host>:<port>/api/alerts/alert/<id>/_enable`

`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>/_enable`

[[alerts-api-enable-path-params]]
==== Path parameters

`id`::
(Required, string) The ID of the alert that you want to enable.

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[alerts-api-enable-response-codes]]
==== Response code

Expand Down
8 changes: 8 additions & 0 deletions docs/api/alerts/find.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ change. Use the find API for traditional paginated results, but avoid using it t

`GET <kibana host>:<port>/api/alerts/_find`

`GET <kibana host>:<port>/s/<space_id>/api/alerts/_find`

[[alerts-api-find-path-params]]
==== Path parameters

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[[alerts-api-find-query-params]]
==== Query Parameters

Expand Down
Loading

0 comments on commit ee93939

Please sign in to comment.