Commit graph

31 commits

Author SHA1 Message Date
Liam Thompson
4c56567ece
[DOCS] Update ESQL docs (#183617)
Related PR:
https://github.com/elastic/elasticsearch/pull/108715#issuecomment-2114866817
2024-05-17 14:50:05 +02:00
Matthew Kime
acdaf0127e
[data views] cache field caps requests (#168910)
## Summary

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

Field caps request caching - implement `stale-while-revalidate` cache
headers and etags with 304 responses as appropriate.

This PR accomplishes
- Adds 304 Not Modified to http server
- Adds refresh button to data view management that force refreshes field
list
- Adds `/internal/data_views/fields` endpoint which supports caching. 
- This is necessary since `fields_for_wildcard` doesn't support caching
due to POST requests
- Adds `stale-while-revalidate` header directive UNLESS field list is
empty.
- Uses Vary header with hash of user id to force requests when user has
changed.
- Unchanged field list responses won't recreate data view field list

### How to test
1. Pop open the dev tools to the network tab and make sure 'Disable
cache' is unchecked. filter for 'fields' requests
2. Load more than one data set (sample data is fine)
3. Go to discover
4. Switch selected data views. Notice status code on first load vs
subsequent loads
5. Open a new window, notice loading from cache
6. Push document that changes field list. You'll need to wait for cache
to expire for it to load. The default is 5s.
7. Notice that field list loads after cache is old properly result in
304 response.
8. Set `data_views:cache_max_age`, shift reload. No field requests will
be cached.

#### Note on Safari

Safari doesn't support the `stale-while-revalidate` directive.
Additionally, the Safari dev console shows 304 responses as 200's. I
figured this out by adding console statements to the fields endpoint. As
best I can tell, Safari won't be performant on slow clusters but its
also no slower than it was before this PR. Safari does respect the
disabling of cache headers.

## Release note

Data View field list requests are now cached with a
`stale-while-revalidate` strategy. This means that after the initial
field list request, all subsequent requests return the cached response
which is very fast. If the cache is determined to be stale then the
cache will update in the background and new data will be available on
the next request.

This behavior can be modified via the `data_views:cache_max_age` Kibana
advanced setting. Setting it to zero will disable the cache. All other
values (in seconds) will be used to determine whether the cache is
stale. The default value is 5 seconds.

The field list can be manually updated via the refresh button in data
view management or a hard refresh with your browser.

Note for Safari: The `stale-while-revalidate` cache directive is
unsupported, therefore it makes additional requests. If this is
impacting Kibana performance then try Chrome or Firefox.

Data View Management

<img width="1064" alt="Screenshot 2024-01-09 at 1 36 20 PM"
src="f272c19f-81b4-4697-9303-b1f8f150e2b9">

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Matthias Wilhelm <matthias.wilhelm@elastic.co>
Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Co-authored-by: Julia Rechkunova <julia.rechkunova@elastic.co>
Co-authored-by: Julia Rechkunova <julia.rechkunova@gmail.com>
2024-01-16 06:54:38 -06:00
amyjtechwriter
e352943ee8
[DOCS] Update tech preview to warn against using ES|QL in production (#174109)
## Summary
Adds the sentence "Do not use ES|QL on production environments." to the
ES|QL tech preview banner on pages:

https://www.elastic.co/guide/en/kibana/current/esql.html
https://www.elastic.co/guide/en/kibana/current/try-esql.html

Relates to:
[#103797](https://github.com/elastic/elasticsearch/pull/103797)
2024-01-03 14:19:18 +00:00
amyjtechwriter
2a4a6e890e
[DOCS] ES|QL pages in Kibana guide (#170226)
## Summary

Two pages about ES|QL added to the Kibana guide. One page (titled ES|QL)
under the 'Kibana concepts' heading, which is an overview page. One page
added to the 'Discover' section (titled Try ES|QL) which is a short
tutorial.

Relates to:
[#244](https://github.com/elastic/platform-docs-team/issues/244)

---------

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-11-02 13:45:17 +00:00
James Rodewig
9caea77ee4
[DOCS] Deprecate rollups (#169670) 2023-10-25 16:51:49 -04:00
James Rodewig
ae12744b96
[DOCS] Cross-link to ES CCS docs (#165406)
Cross-links to [Excluding clusters or indices from cross-cluster search](https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-cross-cluster-search.html#exclude-problematic-clusters) from [Use data views with cross-cluster search](https://www.elastic.co/guide/en/kibana/current/data-views.html#management-cross-cluster-search).

This was originally part of https://github.com/elastic/kibana/pull/164904
2023-08-31 16:26:32 -04:00
Nathan Reese
4b02740b32
update data view docs for excluding cluster (#164904)
https://github.com/elastic/elasticsearch/pull/97865 expands
index-pattern expressions to include a cluster alias for purposes of
excluding an entire cluster from a cross-cluster search. This allows
users to put the minus sign in front of the cluster name
(`-cluster_one:*`). The advantage to this change is that it avoids
sending any network calls to that cluster. Compare this to the existing
syntax for excluding clusters, where the minus sign is in front of the
index name (`cluster_one:-*`). The older syntax has to send the request
to the remote cluster, which if it is down (and skip_unavailable=false),
will cause the search to fail.

This PR updates the docs to reflect the new syntax.

---------

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2023-08-31 08:27:03 -06:00
Lukas Olson
be35641e17
[docs] [kql] Update KQL docs to include info about errors with multiple field types (#158035)
## Summary

We received feedback that the given example would result in errors,
since it targets both
[string](https://www.elastic.co/guide/en/ecs/current/ecs-http.html#field-http-response-body-content)
and
[numeric](https://www.elastic.co/guide/en/ecs/current/ecs-http.html#field-http-response-bytes)
fields, so we've updated the example with something that won't result in
an error, and updated the docs with a note that explains when/why these
errors may occur.

### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2023-05-23 12:29:47 -04:00
gchaps
7cab4edab7
[DOCS] Adds drag & drop to Discover (#157340)
## Summary

This PR adds documentation for:

- Drag and drop from Available Fields list
- Wildcards in field searches
- All sources and matching sources in Create Data View
2023-05-16 15:35:47 -07:00
gchaps
8d6c63472c
[DOCS] Updates Discover docs (#151953)
## Summary

This PR updates the Discover docs for 8.7.
2023-03-08 07:05:25 -08:00
gchaps
28751ac0ae
[DOCS] Adds content on ad-hoc data views (#146250)
## Summary

This PR updates the data view doc to include more information about
temporary data views.

Closes #144582

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-12-06 08:24:08 -08:00
gchaps
f95414f76f
[DOCS] Adds content on nested queries (#146829)
## Summary

This PR adds content on nested queries.

Preview:

[https://kibana_146829.docs-preview.app.elstc.co/guide/en/kibana/master/kuery-query.html](https://kibana_146829.docs-preview.app.elstc.co/guide/en/kibana/master/kuery-query.html)
2022-12-01 14:11:28 -08:00
gchaps
5e7989844d
[DOCS] Improves examples in KQL doc (#144072)
* [DOCS] Improves examples in KQL doc

* Update docs/concepts/kuery.asciidoc

Co-authored-by: Lukas Olson <olson.lukas@gmail.com>

Co-authored-by: Lukas Olson <olson.lukas@gmail.com>
2022-11-07 09:12:05 -08:00
gchaps
411c261e53
[DOCS] Adds content on ad hoc data view (#142290)
* [DOCS] Adds content on ad hoc data view

* [DOCS] Breaks data into two steps

* Update docs/concepts/data-views.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* [DOCS] Tweaks message re: unsaved data views

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-10-10 09:58:48 -07:00
gchaps
062c06d46f
[DOCS] Updates Discover docs with data view changes (#138337)
* [DOCS] Updates Discover docs with data view changes

* [DOCS] Updates settings for Discover in Advanced Settings

* Update docs/discover/document-explorer.asciidoc

Co-authored-by: Matthias Wilhelm <ankertal@gmail.com>

* Update docs/management/advanced-options.asciidoc

* Update docs/management/advanced-options.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/management/advanced-options.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/user/discover.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Matthias Wilhelm <ankertal@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-08-17 09:33:50 -07:00
gchaps
0620c75d4a
[DOCS] Updates concept docs (#133833)
* [DOCS] Updates concept docs

* Update docs/concepts/index.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* [DOCS] Incorporates review comments

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-06-09 10:43:27 -07:00
Kaarina Tungseth
1dcdc7b0de
[DOCS] Adds advanced settings for data views (#130294)
* Adds advanced settings for data views

* Update docs/concepts/data-views.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-04-20 09:48:19 -05:00
gchaps
d64fc1ce00
[DOCS] Adds date math to KQL doc (#125880)
* [DOCS] Adds date math to KQL doc

* [DOCS] Adds examples of date math expressions
2022-02-17 09:52:37 -08:00
gchaps
888d144802
[DOCS] Updates Discover docs for 8.1 (#125706)
* [DOCS] Updates Discover docs for 8.1

* [DOCS] Updates screenshots

* Update docs/user/discover.asciidoc

Co-authored-by: Matthias Wilhelm <ankertal@gmail.com>

* [DOCS] Addresses review comments

* [DOCS] Minor editors

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Matthias Wilhelm <ankertal@gmail.com>
2022-02-17 07:18:52 -08:00
gchaps
1e12a39cd2
[DOCS] Fixes inconsistency with role management link (#121351)
* [DOCS] Fixes inconsistency with role management link

* Update docs/redirects.asciidoc

Co-authored-by: Lisa Cawley <lcawley@elastic.co>

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2021-12-15 14:45:23 -08:00
gchaps
badc730264
[DOCS] Fixes index pattern page (#119904) 2021-11-30 08:25:59 -08:00
gchaps
50c02645cf
[DOCS] Changes index pattern to data views in intro docs (#119403)
* [DOCS] Changes index pattern to data views in intro docs

* [DOCS] Updates image of data views UI

* [DOCS] Removes faulty sentence

* [DOCS] removes sentence about index patterns

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-11-29 11:46:58 -08:00
Matthew Kime
e53771df2d
[docs] index pattern => data view (#110421) (#115497)
* [user docs - index patterns] index pattern => data view (#110421)
2021-11-02 11:34:59 -05:00
gchaps
c1808ee1c9
[DOCS] Updates create index pattern (#106935)
* [DOCS] Updates create index pattern

* [DOCS] Adds info on refresh

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* [DOCS] Addresses more review comments

* [DOCS] Updates images

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-08-23 14:31:36 -07:00
Lukas Olson
196eb7b6a9
[data.search.autocomplete] Move autocomplete method to UI settings (#106331)
* [data.search.autocomplete] Move autocomplete method to UI settings

* Use select rather than boolean

* Add ftue tour

* Make a select rather than text box

* Only show when focused and first time page is loaded

* Add docs link

* Reverse order of sections

* Update docs/concepts/index.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/concepts/index.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Docs updates

* setting

* telemetry

* Add links to docs

* Fix translations

* Fix failing test

* Fix test

* Fix tests

* Revert changes to querybar service

* Fix discover query

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Liza K <liza.katz@elastic.co>
2021-07-27 20:57:12 -07:00
gchaps
404337514e
[DOCS] Updates screenshots to show new theme (#104998)
* [DOCS] Updates screenshots to show new theme

* [DOCS] Updates more screenshots in Discover docs

* [DOCS] Updates screenshot for license management

* [DOCS] Attempt to make the screenshots more readable
2021-07-19 08:41:19 -07:00
Kaarina Tungseth
28a7bd31fd
[DOCS] Dashboard changes for 7.13 (#99681)
* [DOCS] Dashboard changes for 7.13

* Review comments

* Review comments

* Fixes link

* Fixes lens link
2021-05-24 15:14:37 -05:00
Kaarina Tungseth
4a56a01a08
[DOCS] Adds runtime fields (#99395)
* [DOCS] Runtime fields

* [DOCS] Runtime fields

* Adds examples and Lens changes

* Review comments

* Adds redirects

* Review comments

* Revert "Review comments"

This reverts commit 537732a5cf.

* Review comments

* Fixes broken link

* Removes duplicate link

Co-authored-by: Kaarina Tungseth <kaarinatungseth@Kaarinas-MacBook-Pro.local>
2021-05-12 15:48:13 -05:00
Nathan Reese
ff8f4fb2a5
[Maps] 7.13 doc updates (#98687)
* [Maps] 7.13 doc updates

* tooltip updates

* clean up

* Update docs/maps/search.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/maps/search.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/maps/vector-tooltips.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* review feedback

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-04-30 08:45:31 -06:00
gchaps
e6e36102f0
[DOCS] Reorganizes concepts and discover sections (#97019)
* [DOCS] Reorganizes concepts and discover sections

* [DOCS] Updates time filter and saved query sections

* Update docs/discover/save-search.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* [DOCS] Updates time filter and saved query doc

* [DOCS] Updates images

* [DOCS] Adds missing images

* [DOCS] Minor edits

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
2021-04-21 11:02:00 -07:00
gchaps
417776d9b6
[DOCS] Adds concepts section for analysts (#96675)
* [DOCS] Adds concepts section for analysts

* [DOCS] Minor tweaks to concepts doc

* Update docs/concepts/index.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/concepts/save-query.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
2021-04-13 07:49:38 -07:00