-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch '8.16' into backport/8.16/pr-193812
- Loading branch information
Showing
373 changed files
with
5,818 additions
and
9,478 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file removed
BIN
-48.4 KB
docs/user/dashboard/images/lens_lineChartMetricOverTimeBottomAxis_8.7.png
Binary file not shown.
Binary file removed
BIN
-55.2 KB
docs/user/dashboard/images/lens_lineChartMetricOverTimeLeftAxis_8.7.png
Binary file not shown.
Binary file removed
BIN
-141 KB
docs/user/dashboard/images/lens_metricUniqueCountOfClientip_8.4.0.png
Binary file not shown.
Binary file removed
BIN
-53.6 KB
docs/user/dashboard/images/lens_visualizationTypeDropdown_8.4.0.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+65.7 KB
docs/user/dashboard/images/table-with-request-keyword-and-client-ip-8.16.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+167 KB
docs/user/dashboard/images/tutorial-unique-count-of-client-ip-8.16.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,7 +34,7 @@ | |
}, | ||
{ | ||
"name": "endpoint", | ||
"version": "8.15.1" | ||
"version": "8.16.0" | ||
}, | ||
{ | ||
"name": "fleet_server", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,52 @@ | ||
The `bundle.json` and `bundle.serverless.json` files are generated automatically. | ||
See `node scripts/capture_oas_snapshot --help` for more info. | ||
# Kibana API reference documentation | ||
|
||
The `output/kibana.serverless.yaml` and `output/kibana.yaml` files join some manually-maintained files with the automatically generated files. | ||
To add integrate more files into this bundle, edit the appropriate `oas_docs/scripts/merge*.js` files. | ||
To generate the bundled files, run `make api-docs` (or `make api-docs-serverless` and `make api-docs-stateful`). | ||
To lint them, run `make api-docs-lint` (or `make api-docs-lint-serverless` and `make api-lint-stateful`). | ||
Documentation about our OpenAPI bundling workflow and configuration. See Kibana's hosted [stateful](https://www.elastic.co/docs/api/doc/kibana) and [serverless](https://www.elastic.co/docs/api/doc/serverless) docs. | ||
|
||
To apply some overlays that perform some post-processing and append some content, run `make api-docs-overlay`. | ||
## Workflow | ||
|
||
The final goal of this workflow is to produce an OpenAPI bundle containing all Kibana's public APIs. | ||
|
||
### Step 0 | ||
|
||
OAS from Kibana's APIs are continuously extracted and captured in `bundle.json` and `bundle.serverless.json` as fully formed OAS documentation. See `node scripts/capture_oas_snapshot --help` for more info. | ||
|
||
These bundles form the basis of our OpenAPI bundles to which we append and layer extra information before publishing. | ||
|
||
### Step 1 | ||
|
||
Append pre-existing bundles not extracted from code using [`kbn-openapi-bundler`](../packages/kbn-openapi-bundler/README.md) to produce the final resulting bundles. | ||
|
||
To add more files into the final bundle, edit the appropriate `oas_docs/scripts/merge*.js` files. | ||
|
||
### Step 2 | ||
|
||
Apply any final overalys to the document that might include examples or final tweaks (see the ["Scripts"](#scripts) section for more details). | ||
|
||
## Scripts | ||
|
||
The `oas_docs/scripts` folder contains scripts that point to the source domain-specific OpenAPI bundles and specify additional parameters for producing the final output bundle. Currently, there are the following scripts: | ||
|
||
- `merge_ess_oas.js` script produces production an output bundle for ESS | ||
|
||
- `merge_serverless_oas.js` script produces production an output bundle for Serverless | ||
|
||
### Output Kibana OpenAPI bundles | ||
|
||
The `oas_docs/output` folder contains the final resulting Kibana OpenAPI bundles | ||
|
||
- `kibana.yaml` production ready ESS OpenAPI bundle | ||
- `kibana.serverless.yaml` production ready Serverless OpenAPI bundle | ||
|
||
## Bundling commands | ||
|
||
Besides the scripts in the `oas_docs/scripts` folder, there is an `oas_docs/makefile` to simplify the workflow. The following makefile targets are available: | ||
|
||
| Command | Description | | ||
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| `api-docs` | Builds ESS Kibana OpenAPI bundle | | ||
| `api-docs-serverless` | Builds Serverless Kibana OpenAPI bundle | | ||
| `api-docs-lint` | Lints built result bundles | | ||
| `api-docs-lint-errs` | Lints built result bundles for errors | | ||
| `api-docs-preview` | Generates (ESS + Serverless) Kibana OpenAPI bundles preview | | ||
| `api-docs-overlay` | Applies [overlays](https://docs.bump.sh/help/specification-support/overlays/) from `overlays` folder to the Kibana OpenAPI bundles and generate `*.new.yaml` files. Overlays help to fine tune the result bundles. | | ||
| `api-docs-overlay-preview` | Generates a preview for bundles produced by `api-docs-overlay` | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.