Commit graph

73 commits

Author SHA1 Message Date
Thomas Neirynck
558ff8200b
[Docs] [APM] Clarify which Kibana deployment (#160991)
Small suggestion. Thx!
2023-06-30 15:54:53 +02:00
Walter Rafelsberger
a8e07e8709
[ML] Transforms: Add performance journey for transform wizard source index loading. (#160837)
Add a performance journey for transform wizard source index loading.
2023-06-30 13:03:22 +02:00
Jean-Louis Leysens
f21f7ce6ca
[HTTP/Docs] Clarify versioning practices for internal vs public endpoints (#158828)
## Summary

Expands on the HTTP versioning tutorial with more information about
`internal` vs `public` endpoints.

## Screenshots

<img width="875" alt="Screenshot 2023-06-01 at 15 52 18"
src="f8f790a0-31ec-4123-89db-b1f01aa17845">

<img width="923" alt="Screenshot 2023-06-01 at 15 52 33"
src="f97ad89b-face-4176-a814-8e17ecd3d2a5">
2023-06-02 13:40:42 +02:00
Michael Dokolin
a65cd356aa
[Migrations] Add support of deferred migrations (#153117)
* Add deferred migrations parameter.
* Update outdated documents query to take into account deferred migrations.
* Update outdated documents query to take into account the core migration version.
* Update read operations in the saved objects repository to perform deferred migrations.
2023-05-22 11:17:41 +02:00
Dzmitry Lemechko
e55a92eab0
[performance] enable journey run against cloud deployments (#156720)
## Summary

This PR adds changes and instructions how to run existing performance
journeys against ESS instances.

As previously discussed with @pheyos , there are few manual steps to be
done before running the actual journey:
1. Create cloud deployment and re-configure it the way APM traces are
reported the monitoring cluster
2. Check out the branch matching deployment version (main ->
8.9.0-SNAPSHOT), create user with `superuser` role (we don't test
functional features, only performance metrics)

Then you can run the journey like a regular cloud test suite:
```
export TEST_KIBANA_URL=https://<username>:<password>@<kibana_url>
export TEST_ES_URL=https://<username>:<password>@j<elasticsearch_url>:<port>
export TEST_CLOUD=1
node scripts/functional_test_runner.js --config x-pack/performance/journeys/$YOUR_JOURNEY_NAME.ts
```

<img width="1357" alt="image"
src="https://user-images.githubusercontent.com/10977896/236499836-2738fecb-a5a9-4e58-a10b-915b962af037.png">

---------

Co-authored-by: Jon <jon@budzenski.me>
2023-05-08 23:35:43 -04:00
Jean-Louis Leysens
f86913dbea
[HTTP] Add example of using version header public side (#156833)
## Summary

Added an example to the HTTP versioning tutorial of how a version can be
sent using `http.fetch`.

Also changed the example to use a more realistic version like
`2023-10-31`.

<img width="996" alt="Screenshot 2023-05-05 at 13 56 08"
src="https://user-images.githubusercontent.com/8155004/236451506-cc1838e3-6406-4890-932e-6c700a9cf681.png">
2023-05-05 08:15:08 -04:00
Jean-Louis Leysens
55b9fd2353
[Dev docs] Added final section to HTTP versioning tutorial (#154901)
## Summary

Adds the final section to the HTTP versioning tutorial about using the
route versioning specification.
2023-04-18 15:39:29 +02:00
Michael Dokolin
17876df41a
[Saved Objects] Update the migrationVersion property to hold a plain string value (#150075)
* Update document migrator to rely on `typeMigrationVersion` instead of `migrationVersion`.
* Refactor document migrator to extract migration pipeline logic.
* Add `core` migration type.
2023-03-24 13:45:30 +01:00
Jean-Louis Leysens
62cbac7854
[HTTP] Dev doc for HTTP API versioning (#152739)
## Summary

This contribution adds a new tutorial for how plugin developers must
approach developing and maintaining versionable HTTP APIs.


## How to review
1. Pull down the changes
2. Run `./scripts/dev_docs.sh`
3. Open http://localhost:3000 in your browser
4. Go to "Versioning HTTP APIs" in the side nav
2023-03-07 08:09:49 -05:00
Jean-Louis Leysens
570eb381c5
[Versioned APIs] Versioned interfaces dev docs guide (#150705)
## Summary

Adds a dev docs guide for the core-approved versioning strategy. This
strategy is subject to some iteration but is based on the work we did
for the Saved Objects Management plugin in
https://github.com/elastic/kibana/pull/149495.

Closes https://github.com/elastic/kibana/issues/149929

## How to test

1. Run `./scripts/dev_docs.sh`
2. Navigate to "Versioning interfaces" in the side nav menu

---------

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>
2023-03-01 16:45:43 +01:00
Christiane (Tina) Heiligers
f7b25f5e46
[Saved Objects] Provide ability to remove SO type from global SO HTTP API without hiding from the client (#149166)
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
resolves https://github.com/elastic/kibana/issues/147150
2023-01-23 15:04:24 -07:00
spalger
eda059707c
[docs] escape code with curly brackets to fix docs build 2023-01-18 13:16:07 -07:00
Dzmitry Lemechko
363f4b7583
Update perf docs (#147533)
This PR updates docs around Kibana performance effort:

- how to create single user performance journeys, custom metrics with
EBT and review test results
- how to create api capacity test and where to find its test results
2023-01-18 17:56:05 +01:00
Thomas Neirynck
0b6d3baf9d
[Performance] Add saved object load performance metric (#147324)
Adds performance metric to track saved objects load time. Also add boilerplate search journey.

Partially address https://github.com/elastic/kibana/issues/145627
2022-12-27 12:33:49 -05:00
Michael Dokolin
167797cae1
[Saved Objects] Add documentation covering hidden saved object types (#144647) 2022-11-08 16:42:02 +01:00
Rudolf Meijering
191bfbc97e
Saved objects: improve typesafety (#140099)
* Remove SavedObjectAttributes from examples

* Remove SavedObjectAttributes from dev_docs

* Deprecate SavedObjectAttributes type

* Remove SavedObjectAttributes from kibana_usage_collection plugin

* Remove low hanging SavedObjectAttributes in security_solution

* Remove low hanging SavedObjectAttributes in upgrade_assistant

* Remove low hanging SavedObjectAttributes in lens

* Stricter types for SavedObjectsServiceSetup.registerType

* Review feedback

* Some more low hanging fruit

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-09-13 09:56:29 +02:00
Constance
98f73d674a
Upgrade EUI to v63.0.6 - updates to new EuiPageTemplate and deprecates old page components (#139524)
* Update all usages of EuiPageTemplate to EuiPageTemplate_Deprecated

* EuiPageContent_Deprecated as EuiPageContent

* EuiPageContentBody_Deprecated as EuiPageContentBody

* EuiPageContentHeader_Deprecated as EuiPageContentHeader

* EuiPageContentHeaderSection_Deprecated as EuiPageContentHeaderSection

* EuiPageSideBar_Deprecated as EuiPageSideBar

* EuiPageContent__Deprecated to EuiPageContent_Deprecated

* Fix rogue semi-colons

* WIP: NoDataConfigPage & NoDataPage converted to new template

- `withSolutionNav` not yet handled

* WIP: KibanaPageTemplateInner converted to use new template

- Pushes existing `pageHeader` prompts onto created EuiPageTemplate.PageHeader
- Uses `isEmptyState` to push `pageHeader` props to EuiPageTemplate.EmptyPrompt instead (if `children` are not supplied)

* WIP: `withSolutionNav` now renders the sidebar content properly

- Collapsing isn’t working (minWidth isn’t updating)

* Fixing stickiness of sidebar

* [Security] Fixed SecuritySolutionTemplateWrapper’s usage

- Moved `bottomBar` to EuiPageTemplate.BottomBar (now contained in just the page contents)
- Change EuiPanel children wrapper with EuiPageTemplate.Section

* [O11y] Wrap `children` with EuiPageTemplate.Section

* Fix getting_started usage

* WIP: Fixing types

* Removing `template` pass through

* Set EUI to 63.0.0

* [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix'

* More import fixes

* Sidebar component update

* Expand `KibanaPageTemplate` to all namespaced EUI counterparts

- Updated `docs/tutorials` mdx page
- Fixed SolutionNav prop types

* Updated the tutorial mdx page

* [Stack Management] Updated app layout to new template

- Some temporary props applied for BWC until all other pages can be converted
- Converted `API Keys` page’s layout (and especially prompt usags) to new paradigm

* Fix circular dep

* Fix new circular dependency

- copying and pasting types from KibanaPageTemplateProps, but ah well

* [Security Solution] Remove `template` prop - no longer a prop on Kibana/EuiPageTemplate

* [O11y] Allow customizing EuiPageTemplate.Section wrapper

- converts pageBodyProps
- fixes non-centered loading template

* [Enterprise Search] Update page templates

- fix layouts by auto-wrapping an EuiPageSection for padding, while adding a `customPageSections` prop for more custom sections/layouts

- re-center 404 errors

- update tests

* Update KibanaPageTemplate tests

* Update snapshots

* Fix FTR test with removed EUI classNames

* Fix FTR tests with changed kbn classNames

* Update failing dashboard snapshots

- drop shadow changed slightly in EUI

* Fix failing Security Cypress test

* [O11y] Fix Inventory page using deprecated CSS hooks

* [O11y][Uptime] Fix missing bottom bars

- Modifies ObservabilityPageTemplate to accept a `bottomBar` prop (a la the old EuiPageTemplate behavior)

NOTE: This opinionated page layout structure is starting to feel like it could be potentially limiting / have all the same pitfalls the previous EuiPageTemplate did. If so, consider something closer to the Enterprise Search page template conversion (`customPageSections`).

- Misc cleanup: Use `KibanaPageTemplate` over `EuiPageTemplate`

* [O11y] Fix route template typing

- Since theObservabilityPageTemplate is using the new Eui/KibanaPageTemplate, its child templates and types need to be updated accordingly

* Fix broken minWidth behavior

- was an EUI issue that required a patch release
+ update snapshots

* [Security Solution] Type fixes, restore empty state

- Fix empty state logic removed in a previous commit
- bogarts KibanaPageTemplate's `isEmptyState` prop instead of using `template="noData"`

- extend template wrappers to past ...rest to underlying Kibana/EuiPageTemplate

+ replace EuiPageTemplate with KibanaPageTemplate for consistency

* Fix failing synthetics selector

* Grab EUI v63.0.6

- for deprecation tags and section tag support

* Fix Kibana Overview plugin layout

- needs to use KibanaPageTemplate.Section to get padding back

- use `bottomBorder` prop over horizontal rules

- restore previous page color via panelled=false

* Convert Home plugin to new KibanaPageTemplate

- use KibanaPageTemplate.Section instead to preserve page width/paddings

- use `bottomBorder` instead of `EuiHorizontalRule`

- NOTE: This causes margins to decrease slightly from xxl to xl (largest padding available for EuiPageSection) - this can be restored by CSS overrides if desired

- update CSS to preserve previous looks, + convert to logical properties

* [O11y] Fix non-centered empty/loading states

* [O11y] Restore subdued background on various empty state prompts

* [O11y] Fix all instances of views that require a scrollable full-height child

+ restore comment for inventory view

* [O11y][ux] Fix broken sidebar

- The entire app was missing a wrapping EuiProvider, and as such breakpoint utils were not working, and the sidebar was missing

+ misc cleanup
  - remove unnecessary fragment
  - remove role="main" attr - now that EuiPageTemplate sets a `main` tag, they'll conflict
  - add isEmptyState to center loading component

* [APM Cypress tests] harden flaky test

* [APM Cypress tests] Fix failing Cypress test, again

Co-authored-by: cchaos <caroline.horn@elastic.co>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2022-09-07 15:35:23 -05:00
Liza Katz
a93f5d9986
Performance journey docs (#140034)
* journey docs

* link

* code review

* cc

* cc
2022-09-06 12:58:57 +03:00
Liza Katz
b98fe995b9
Report performance metrics docs followup (#139852)
* doc

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Baturalp Gurdin <9674241+suchcodemuchwow@users.noreply.github.com>

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Baturalp Gurdin <9674241+suchcodemuchwow@users.noreply.github.com>

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Baturalp Gurdin <9674241+suchcodemuchwow@users.noreply.github.com>

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Baturalp Gurdin <9674241+suchcodemuchwow@users.noreply.github.com>

* docs

* event name

Co-authored-by: Baturalp Gurdin <9674241+suchcodemuchwow@users.noreply.github.com>
2022-09-01 16:24:11 +03:00
Baturalp Gurdin
ec7af1a00b
add docs for how to report performance metrics (#139197)
* add docs for how to report performance metrics

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

* add dashboard loaded event example

* add note/reminder for free field values

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-08-29 17:27:15 +03:00
Jonathan Budzenski
946e094637
[cft] Add support for creating a new deployment (#138243)
* [cft] Add support for creating a new redeployment

- Adds a new label `ci:cloud-redeploy` that will always create a fresh deployment
- Deprecates `ci:deploy-cloud` in favor of namespacing `ci:cloud-deploy`

* booleans
2022-08-11 14:56:44 -05:00
Spencer
6c438b331c
[api-docs] follow the correct schema for frontmatter (#138348)
* [api-docs] follow the correct schema for frontmatter

* rename non-generated summary: usage

* fix yaml comment syntax
2022-08-10 17:17:50 -05:00
Spencer
03f1a218c5
[core] remove root index.ts file (#137001)
* [core] remove root index.ts file

* remove support for `kibana/*` imports, replace instances in docs
2022-07-22 15:04:23 -07:00
Tiago Costa
7cc4eaee28
docs(NA): drop windows native development support (#135964)
* docs(NA): drop support for windows native development

* docs(NA): improve previous written instructions around windows de

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-07-21 14:37:18 +01:00
Shivindera Singh
bcc17e178b
update docs for hasData service (#134899)
* update docs for hasData service

* fix typo

* change wording from primitive to managed
2022-06-22 18:35:02 +02:00
Tiago Costa
1599cd8d2a
docs(NA): windows wsl development (#134589)
* docs(NA): windows wsl development

* docs(NA): update titles for the documentation created

* chore(NA): update dev_docs/tutorials/development_windows.mdx

Co-authored-by: Jonathan Budzenski <jon@budzenski.me>

* docs(NA): updated guide to include info around GUI apps support

* docs(NA): updated guide to include info around GUI apps support

* docs(NA): include win10 GUI workaround

* docs(NA): run a first sudo command before running others

* docs(NA): added remote code wsl extension

* docs(NA): mentioned NVIDIA does now includes vGPU drivers for WSL within the common drivers

* docs(NA): update sudo commands separation

* docs(NA): added hardware virtualization prerequisite awareness into the guide

* docs(NA): update wording on guide recomendation for win11

Co-authored-by: Jonathan Budzenski <jon@budzenski.me>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-06-21 00:45:08 +01:00
Joe Portner
d732ebec91
Migrate defaultIndex attribute for config saved object (#133339) 2022-06-07 08:19:53 -07:00
Anton Dosov
e603d92552
Remove data_enhanced plugin (#122075)
Code moved into `data` plugin
2022-04-29 16:43:59 +02:00
Michael Dokolin
3627b866a3
[Screenshotting] Documentation (#129794)
* Provide defaults for the screenshotting options to make usage closer to the zero-conf
* Add screenshotting example integration
* Add integration tests to cover screenshotting example
* Add screenshotting plugin readme
* Add tutorial to the developer guide
2022-04-15 08:29:05 +02:00
srinjon
4a0b376ad4
Update endpoints.mdx (#128114)
Fixed a sentence formation

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-03-22 11:10:39 -04:00
Liza Katz
c97bfc8e3a
Debugging with apm - fixes and tutorial (#127892)
* fixes + tutorial

* cors config

* omit secretToken so its not sent to FE
Add config tests

* lint

* empty

* swallow errors when parsing configs

* read config test adjustment

* apm docs review

* new line

* doc review

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-03-22 14:56:37 +02:00
Jonathan Budzenski
2a2ce7e683
[dev_docs] Add CI tutorial (#124577)
* [dev_docs] Add CI tutorial

* typo

* add comments

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-02-17 17:12:57 -06:00
Tyler Smalley
435b772786
[ci] Splits Jest integration tests (#125454) 2022-02-14 17:12:42 +01:00
Christiane (Tina) Heiligers
ec323617b5
Adds section on Advanced Settings (#124915)
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-02-08 14:37:22 -07:00
Stacey Gammon
6c4c5e1299
Some updates to our dev docs (#120981)
* Master -> main update branching strategy with make it minor

* Follow the new dev docs process and keep nav inside this repo

* add back nav links that are in a different repo

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-12-13 11:47:03 -05:00
Michael Dokolin
01f7f71551
[Data] Fix public API exports (#120793) 2021-12-09 17:58:32 +01:00
Joe Portner
89b1f9056c
Prevent endless loop for saved object migrations (#120146) 2021-12-03 08:42:54 -05:00
Matthew Kime
eb2ddcd7c6
[data views] data view api docs - index patterns => data views (#119415)
* initial pass at changing urls and anchors

* update api.asciidoc

* upate a few more anchor tags

* upate a few more anchor tags

* update data view api docs

* Update delete.asciidoc

* Update default-get.asciidoc

* add redirects

* fix redirects

* remove duplicate redirect

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-12-01 07:32:05 -06:00
Pierre Gayvallet
f3aa761252
Improve the HTTP and routing doc with more examples (#119591)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-12-01 14:11:44 +01:00
Anton Dosov
b8a7370156
[Search] Add cancelation logic to search example (#118176) 2021-11-30 12:35:07 +01:00
Lucas F. da Costa
1b82502dbb
[User Experience] Add error boundary to prevent UX dashboard from crashing the application (#117583)
* wrap UX dashboard into an error boundary (fixes #117543)

* refactor APM root app tests to reuse coreMock

Before this change, the tests for the root application component of the
APM app were manually mocking the `coreStart` objects required to render
the component.

After this change, these tests will now reuse the relevant `coreMock`
methods.

* refactor: fix typo on createAppMountParameters test utility

Co-authored-by: Lucas Fernandes da Costa <lucas.fernandesdacosta@elastic.co>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-11-08 19:10:59 +00:00
Tyler Smalley
c4815d319e
Updates Github link references from master to main (#116789)
Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
2021-10-29 09:53:08 -07:00
Rudolf Meijering
2e4c87211c
[docs] Fix anchor link to saved objects migrations testing (#116427) 2021-10-28 10:36:57 +02:00
Lukas Olson
eb74b86ca4
[data.search.session] Use locators instead of URL generators (#115681)
* [data.search.session] Use locators instead of URL generators

* Add migration

* Fix/update tests

* Fix types

* Fix test setup

* Update docs

* Fix version :)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-10-26 12:30:11 -07:00
garanews
58f6d9002a
Fix typos in docs & dev_docs (#113746) 2021-10-07 14:30:32 -04:00
Pierre Gayvallet
855d2f1094
Migrate routing and navigation docs to new developer guide (#113919)
* Migrate routing and navigation doc to new doc system

* address feedback
2021-10-07 12:45:15 +02:00
Stacey Gammon
eddbc8db6f
Update doc slugs to improve analytic tracking, move to appropriate folders (#113630)
* Update the slugs to improve google analytics drilldown tracking

* more slug updates

* Fix some formatting issues in building blocks

* update paths

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-10-04 13:36:45 -04:00
Dzmitry Lemechko
b324ca3115
[jest] update config files to get coverage per plugin (#111299)
* [jest] update config files to get coverage per plugin

* [docs] add details about plugin coverage collection

* fix path for newsfeed jest config

* fix lint error

* update documentation

* fix lint errors again

* update doc

* fix another lint error

* Update src/plugins/telemetry_management_section/jest.config.js

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* Update src/plugins/telemetry_management_section/jest.config.js

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* [kibana_legacy] fix path

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-09-09 08:14:56 +02:00
Caroline Horn
59ec89bfbe
[NoDataPage] Updating the default messages (#108799)
* [NoDataPage] Updating the default messages and reusing `title` as default `button` label
  * Update default description for agent
* Overview page i18n and snaps
2021-08-17 17:59:15 -04:00
Matthew Kime
2e68ce1a05
Developer guide - index patterns key concepts (#96017)
* add index patterns key concepts
2021-08-15 08:48:51 -05:00