Commit Graph

96 Commits

Author SHA1 Message Date
Hendrik Muhs cf08c0e6ab
[Transform] refactor cat transform to show more useful information (#68232)
Refactoring of cat transform to show more relevant information. The current cat transform shows a
lot of configuration details, however cat should show operationally useful information. This PR
changes the defaults and also adds when transform did a search last.
2021-02-02 07:29:20 +01:00
Przemysław Witek d78f39c2ad
[Transform] Add support for search-time runtime fields. (#67643) 2021-01-21 13:27:42 +01:00
James Rodewig 518d71d1e3
[DOCS] Document hidden data streams and naming restrictions (#65862) 2021-01-13 09:09:15 -05:00
James Rodewig 10b036e934
[DOCS] Fix timeout parameter defaults (#66111) 2020-12-21 09:02:06 -05:00
Lisa Cawley d5892c50cd
[DOCS] Drafts API changes for transform latest function (#66481) 2020-12-18 09:50:09 -08:00
James Rodewig 8dc3fa98f7
[DOCS] Add `require_alias` to Bulk API (#66259) 2020-12-14 10:57:17 -05:00
bellengao 424ceb13ba
[DOCS] Fix `search_timeout` parameter docs (#66075)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2020-12-09 13:22:33 -05:00
Hendrik Muhs 9b47889153
[Transform] use ISO dates in output instead of epoch millis (#65584)
Transform writes dates as epoch millis, this does not work for historic data in some cases or is
unsupported. Dates should be written as such. With this PR transform starts writing dates in ISO
format, but as existing transform might rely on the format it provides backwards compatibility for
old jobs as well as a setting to write dates as epoch millis.

fixes #63787
2020-12-07 15:34:28 +01:00
bellengao e198bb233e
[DOCS] Correct the default value of `wait_for_completion` query param (#65800)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2020-12-04 15:52:35 -05:00
István Zoltán Szabó 6f323ad0b1
[DOCS] Changes wording of pivot parameter in PUT transforms API docs. (#65731) 2020-12-02 14:07:17 +01:00
James Rodewig 630cb18b79
[DOCS] Add `require_alias` query param to reindex API (#65608) 2020-11-30 09:30:40 -05:00
debadair 92efa3a0f3
[DOCS] Make system & hidden index info more prominent. (#64839)
* [DOCS] Make system & hidden index info more prominent.

* Update docs/reference/api-conventions.asciidoc
2020-11-11 10:35:02 -08:00
James Rodewig cb26c542ce
[DOCS] Document get pipeline API as multi-target (#64816) 2020-11-09 16:11:13 -05:00
Hendrik Muhs 208b69ccaa
[Transform] add support for median absolute deviation (#64634)
add median_absolute_deviation to the list of supported aggs in transform
2020-11-05 14:38:15 +01:00
James Rodewig 1ea83359bb
[DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00
James Rodewig 71aaa4ae0a
[DOCS] EQL: Update `allow_no_indices` default (#63748)
Co-authored-by: Adam Locke <adam.locke@elastic.co>
2020-10-19 12:14:23 -04:00
István Zoltán Szabó ccc820a972
[DOCS] Clarifies destination index mappings for Transforms. (#63794) 2020-10-16 15:24:33 +02:00
Hendrik Muhs d1e39e8269
[Transform] add support for "missing" aggregation (#63651)
add support for the missing (bucket) aggregation (counts docs with a configured missing field value)
in transform. The output is mapped to name:count, the mapping type is long.
2020-10-15 08:41:33 +02:00
Christoph Büscher b44a03d837
[Docs] Correct default scroll_size for update by query (#63656)
The current _update_by_query documentation mentions a scroll_size default of 100 and later another default of 1000.
We use the default of 1000 defined in AbstractBulkByScrollRequest and this PR changes the documentation accordingly.

Closes #63637
2020-10-14 16:42:21 +02:00
Gordon Brown 91f4b58bf7
Deprecate REST access to System Indices (#60945)
This PR adds deprecation warnings when accessing System Indices via the REST layer. At this time, these warnings are only enabled for Snapshot builds by default, to allow projects external to Elasticsearch additional time to adjust their access patterns.

Deprecation warnings will be triggered by all REST requests which access registered System Indices, except for purpose-specific APIs which access System Indices as an implementation detail a few specific APIs which will continue to allow access to system indices by default:

- `GET _cluster/health`
- `GET {index}/_recovery`
- `GET _cluster/allocation/explain`
- `GET _cluster/state`
- `POST _cluster/reroute`
- `GET {index}/_stats`
- `GET {index}/_segments`
- `GET {index}/_shard_stores`
- `GET _cat/[indices,aliases,health,recovery,shards,segments]`

Deprecation warnings for accessing system indices take the form:
```
this request accesses system indices: [.some_system_index], but in a future major version, direct access to system indices will be prevented by default
```
2020-10-06 11:13:48 -06:00
James Rodewig 5c5acfddef
[DOCS] Clarify `allow_no_indices` def (#63209) 2020-10-05 12:31:44 -04:00
James Rodewig 95b8a4feaf
[DOCS] Split delete index template API docs (#62074) (#62168)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

Co-authored-by: Zaeem <zaeemarshad@users.noreply.github.com>
2020-09-09 10:13:13 -04:00
James Rodewig 441c3a21b1
[DOCS] Update my-index examples (#60132)
Changes the following example index names to `my-index-000001` for consistency:

* `my-index`
* `my_index`
* `myindex`
2020-07-27 14:46:39 -04:00
debadair db0adfd2b8
[DOCS] Refactored index-templates topic. (#59737)
* [DOCS] Refactored index-templates topic.

* [DOCS] Add separate files.

* [DOCS] Add delete component template.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* [DOCS] Incorporated review comments
2020-07-23 19:02:11 -07:00
bellengao a9e52194ad
[DOCS] Correct the default value of `ignore_throttled` param (#60036) 2020-07-22 16:34:50 -04:00
James Rodewig 1d8143deae
[DOCS] Fix `requests_per_second` reindex param (#59871)
Corrects the `requests_per_second` query parameter used in the reindex,
delete by query, and update by query API docs.

The parameter defaults to `-1` (no throttle). `0` is not an allowed value.
2020-07-20 09:42:01 -04:00
Benjamin Trent f72b893fd3
Adding new `require_alias` option to indexing requests (#58917)
This commit adds the `require_alias` flag to requests that create new documents.

This flag, when `true` prevents the request from automatically creating an index. Instead, the destination of the request MUST be an alias.

When the flag is not set, or `false`, the behavior defaults to the `action.auto_create_index` settings.

This is useful when an alias is required instead of a concrete index.

closes https://github.com/elastic/elasticsearch/issues/55267
2020-07-17 08:45:46 -04:00
István Zoltán Szabó 907a7d6b29
[DOCS] Sorts agg and grouping names alphabetically in PUT Transforms API docs. (#59688) 2020-07-16 12:43:45 +02:00
James Rodewig 2be9db01c8
[DOCS] Replace `datatype` with `data type` (#58972) 2020-07-07 13:52:10 -04:00
James Rodewig 48f4a8db0d
[DOCS] Add data streams to bulk, delete, and index API docs (#58340)
Updates existing docs for the bulk, delete and index APIs to make them
aware of data streams.
2020-06-23 09:18:28 -04:00
James Rodewig 0d081de7ad
[DOCS] Fix source-related search API params (#57691)
Cleans up the reference documentation for the following
search API parameters:

* `_source` query parameter
* `_source_excludes` query parameter
* `_source_includes` query parameter
* `_source` request body parameter
* `hits._source` response property
2020-06-09 12:44:57 -04:00
Lisa Cawley 8b9293b3bf
[DOCS] Replace docdir attribute with es-repo-dir (#57489) 2020-06-01 15:55:05 -07:00
Benjamin Trent 484de0cd02
Adding transform docs for geotile_grid (#57000)
transforms and composite aggs support geotile_grid as a source. This adds documentation explaining that support.
2020-06-01 15:32:18 -04:00
Christoph Büscher 3d4f9fedaf
Check for negative "from" values in search request body (#54953)
Today we already disallow negative values for the "from" parameter in the search
API when it is set as a request parameter and setting it on the
SearchSourceBuilder, but it is still parsed without complaint from a search
body, leading to differing exceptions later. This PR changes this behavior to be
the same regardless of setting the value directly, as url parameter or in the
search body. While we silently accepted "-1" as meaning "unset" and used the
default value of 0 so far, any negative from-value is now disallowed.

Closes #54897
2020-05-28 16:25:19 +02:00
Gordon Brown 741b64695f
Add expand_wildcards to _cat/indices and _cat/aliases docs (#56964)
This commit adds the `expand_wildcards` parameter documentation to the
`_cat/indices` and `_cat/aliases` docs, as those APIs now support
`expand_wildcards`. Additionally, clarifies the `expand_wildcards` docs with
respect to hidden indices.
2020-05-21 16:27:43 -06:00
Benjamin Trent fd812d2ada
[Transform] add support for terms agg in transforms (#56696)
This adds support for `terms` and `rare_terms` aggs in transforms. 

The default behavior is that the results are collapsed in the following manner:
`<AGG_NAME>.<BUCKET_NAME>.<SUBAGGS...>...`
Or if no sub aggs exist
`<AGG_NAME>.<BUCKET_NAME>.<_doc_count>`

The mapping is also defined as `flattened` by default. This is to avoid field explosion while still providing (limited) search and aggregation capabilities.
2020-05-15 07:11:46 -04:00
Lisa Cawley d7735d9ef2
[DOCS] Add throttling based on configuration parameter (#56653) 2020-05-14 08:38:57 -07:00
David Turner 9c5687fbd9
Clarify doc count stats (#56665)
Today we report some statistics in terms of Lucene-level documents, which
differ from Elasticsearch-level documents in a number of ways and include
things like document tombstones which users cannot directly observe. This
commit clarifies the internal nature of these statistics.

Closes #56497
2020-05-13 15:07:15 +01:00
Hendrik Muhs a73511e4c7
[DOC] document transform settings and docs_per_second (#56178)
add documentation for throttling, added in #56007
2020-05-11 09:21:36 +02:00
Adrien Grand b614412569
Repurpose `ignore_throttled` to be only about frozen indices. (#55047)
This has no practical impact on users since frozen indices are the only
throttled indices today. However this has an impact on upcoming features
that would use search throttling.

Filtering out throttled indices made sense a couple years ago, but as
we're now improving support for slow requests with `_async_search` and
exploring ways to reduce storage costs, this feature has most likely
become a trap, that we'd like to not have with upcoming features that
would use search throttling.

Relates #54058
2020-04-28 13:43:35 +02:00
Lisa Cawley 16c7edeeee
[DOCS] Collapses sections in put snapshot lifecycle policy API (#54834) 2020-04-06 12:10:47 -07:00
Lisa Cawley 5d590b5be6
[DOCS] Add processing details to get transforms stats API (#54368) 2020-04-01 09:50:57 -07:00
Benjamin Trent 3c81082fdf
[Transform] fixing naming in HLRC and _cat to match API content (#54300)
Fixing the naming of the HLRC values to match the ToXContent field names (i.e. the field names returned from an API call).

Also fixes the names in the _cat API as well.

closes #53946
2020-03-30 08:10:15 -04:00
Lisa Cawley 6fceef73e4
[DOCS] Augments cat transforms API (#53776)
Co-Authored-By: Benjamin Trent <ben.w.trent@gmail.com>
2020-03-25 12:35:01 -07:00
Lisa Cawley 0dddfa4ed2
[DOCS] Updates list of transform aggs (#53820) 2020-03-20 10:25:21 -07:00
Ryan Earle 12e24852af
[DOCS] Remove `force` as valid value for `version_type` (#53428)
The `force` value for the `version_type` parameter was deprecated in 6.8.

This removes the value from the parameter definition.
2020-03-16 16:41:05 -04:00
Julie Tibshirani 19197ddde1
Correct the name of the search timeout parameter. (#52733)
The request body parameter is called 'timeout', not 'search_timeout'.
2020-02-24 14:57:49 -08:00
James Rodewig a687b1f180
[DOCS] Document `indices` cluster stats (#50527)
Documents the header and `indices` response parameters returned by the
`_cluster/stats` API.

Co-Authored-By: David Turner <david.turner@elastic.co>
2020-01-28 10:57:45 -05:00
Jay Modi 173c3bdac4
Introduce hidden indices (#50452)
This change introduces a new feature for indices so that they can be
hidden from wildcard expansion. The feature is referred to as hidden
indices. An index can be marked hidden through the use of an index
setting, `index.hidden`, at creation time. One primary use case for
this feature is to have a construct that fits indices that are created
by the stack that contain data used for display to the user and/or
intended for querying by the user. The desire to keep them hidden is
to avoid confusing users when searching all of the data they have
indexed and getting results returned from indices created by the
system.

Hidden indices have the following properties:
* API calls for all indices (empty indices array, _all, or *) will not
  return hidden indices by default.
* Wildcard expansion will not return hidden indices by default unless
  the wildcard pattern begins with a `.`. This behavior is similar to
  shell expansion of wildcards.
* REST API calls can enable the expansion of wildcards to hidden
  indices with the `expand_wildcards` parameter. To expand wildcards
  to hidden indices, use the value `hidden` in conjunction with `open`
  and/or `closed`.
* Creation of a hidden index will ignore global index templates. A
  global index template is one with a match-all pattern.
* Index templates can make an index hidden, with the exception of a
  global index template.
* Accessing a hidden index directly requires no additional parameters.

Relates #50251
2020-01-17 09:16:31 -07:00
Peter Dyson f77ff8ba09 [DOCS] Array of index patterns is also valid source indices with transform (#50777) 2020-01-13 15:44:35 -08:00