Commit Graph

204 Commits

Author SHA1 Message Date
James Rodewig 30cc10d3ac
[DOCS] Reformat data streams intro and overview (#57954)
Changes:

* Updates 'Data streams' intro page to focus on problem solution and
  benefits.

* Adds 'Data streams overview' page to cover conceptual information,
  based on existing content in the 'Data streams' intro.

* Adds diagrams for data streams and search/indexing request examples.

* Moves API jump list and API docs to a new 'Data streams APIs' section.
  Links to these APIs will be available through tutorials.

* Add xrefs to existing docs for concepts like generation, write index,
  and append-only.
2020-06-11 11:17:21 -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
Tal Levy 79367e43da
Add Normalize Pipeline Aggregation (#56399)
This aggregation will perform normalizations of metrics
for a given series of data in the form of bucket values.

The aggregations supports the following normalizations

- rescale 0-1
- rescale 0-100
- percentage of sum
- mean normalization
- z-score normalization
- softmax normalization

To specify which normalization is to be used, it can be specified
in the normalize agg's `normalizer` field.

For example:

```
{
  "normalize": {
    "buckets_path": <>,
    "normalizer": "percent"
  }
}
```

Closes #51005.
2020-05-14 13:32:42 -07: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
debadair 1412e80266
[DOCS] Extract the cron docs from Watcher docs and add to the API conventions. (#56313)
* [DOCS] Promote cron expressions info from Watcher to a separate topic.

* Fix table error

* Fixed xref

* Apply suggestions from code review

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

* Incorporated review feedback

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2020-05-12 15:32:47 -07:00
James Rodewig 3ebbf895f2
[DOCS] Add clean up snapshot repository API docs (#56519) 2020-05-12 08:56:29 -04:00
Ignacio Vera 4e39184c38
Add moving percentiles pipeline aggregation (#55441)
Similar to what the moving function aggregation does, except merging windows of percentiles 
sketches together instead of cumulatively merging final metrics
2020-05-12 10:30:52 +02: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
Igor Motov e593f3eaeb
Add analytics plugin usage stats to _xpack/usage (#54911)
Adds analytics plugin usage stats to _xpack/usage. 

Closes #54847
2020-04-13 13:16:12 -04:00
Lisa Cawley 16c7edeeee
[DOCS] Collapses sections in put snapshot lifecycle policy API (#54834) 2020-04-06 12:10:47 -07:00
Tanguy Leroux f6feb6c2c8
Merge feature/searchable-snapshots branch into master (#54803)
This commit merges the searchable-snapshots feature branch into master.
See #54803 for the complete list of squashed commits.

Co-authored-by: David Turner <david.turner@elastic.co>
Co-authored-by: Yannick Welsch <yannick@welsch.lu>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
Co-authored-by: Andrei Dan <andrei.dan@elastic.co>
2020-04-06 15:51:05 +02:00
Jason Tedor 06ded13c51
Include autoscaling APIs in API docs (#54603)
This commit adds a top-level link to the autoscaling API reference page
to the API docs. Additionally, we add a conditional guard on the API
pages to only include them in development builds of the docs.
2020-04-01 15:43:44 -04: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 90b723b8f6
Remove xpack actions for the flattened field. (#53076)
The current consensus is that we don't need info actions for smaller items like
field mappers. We can also remove the usage action since the cluster stats API
now tracks information about mappings, like what field types are defined.
2020-03-04 08:35:03 -08:00
Adrien Grand dbe6769525
Remove `constant_keyword` from the info API. (#53071)
I discussed with @rjernst about what kind of functionality should be
reported in the info API, since it doesn't sound sensible to list every
single feature there. As a guideline, Ryan suggested that functionality
that needs to maintain state should definitely be in the info API, but
probably not field mappers like `constant_keyword`.
2020-03-04 09:16:37 +01:00
Adrien Grand 0b2a62822c
Introduce a `constant_keyword` field. (#49713)
This field is a specialization of the `keyword` field for the case when all
documents have the same value. It typically performs more efficiently than
keywords at query time by figuring out whether all or none of the documents
match at rewrite time, like `term` queries on `_index`.

The name is up for discussion. I liked including `keyword` in it, so that we
still have room for a `singleton_numeric` in the future. However I'm unsure
whether to call it `singleton`, `constant` or something else, any opinions?

For this field there is a choice between
 1. accepting values in `_source` when they are equal to the value configured
    in mappings, but rejecting mapping updates
 2. rejecting values in `_source` but then allowing updates to the value that
    is configured in the mapping
This commit implements option 1, so that it is possible to reindex from/to an
index that has the field mapped as a keyword with no changes to the source.
2020-03-02 16:46:46 +01: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
Lisa Cawley 0ff9c6eef1
[DOCS] Adds X-Pack usage API (#52496) 2020-02-20 09:25:57 -08:00
Andrei Stefan f1d1cceaca
Telemetry data initial implementation (#51715) 2020-02-07 23:00:26 +02:00
Jason Tedor 5a12e5856a
Add autoscaling API skelton (#51564)
The main purpose of this commit is to add a single autoscaling REST
endpoint skeleton, for the purpose of starting to build out the build
and testing infrastructure that will surround it. For example, rather
than commiting a fully-functioning autoscaling API, we introduce here
the skeleton so that we can start wiring up the build and testing
infrastructure, establish security roles/permissions, an so on. This
way, in a forthcoming PR that introduces actual functionality, that PR
will be smaller and have less distractions around that sort of
infrastructure.
2020-02-06 19:15:17 -05: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
debadair 0fed96eebc [DOCS] Align with ILM API docs (#48705)
* [DOCS] Reconciled with Snapshot/Restore reorg
2020-01-22 20:44:19 -08:00
Deb Adair 6f3581173b Revert "[DOCS] Align with ILM API docs (#48705)"
This reverts commit ec9437832d.
2020-01-21 22:32:40 -08:00
debadair ec9437832d
[DOCS] Align with ILM API docs (#48705)
* [DOCS] Reconciled with Snapshot/Restore reorg
2020-01-21 19:58:17 -08: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
István Zoltán Szabó b3457154a3
[DOCS] Fine-tunes data frame analytics API docs formatting. (#50799) 2020-01-09 16:21:01 +01:00
István Zoltán Szabó b683f96e23
[DOCS] Moves analysis resources to PUT DFA API docs (#50704)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2020-01-09 13:57:11 +01:00
Lisa Cawley 68e02a19d8
[DOCS] Move machine learning results definitions into APIs (#50257) 2019-12-18 09:50:31 -08:00
Lisa Cawley 6d608e6a0d
[DOCS] Move transform resource definitions into APIs (#50108) 2019-12-17 09:01:31 -08:00
Lisa Cawley 207094cd67
[DOCS] Moves model snapshot resource definitions into APIs (#50157)
Co-Authored-By: Ed Savage <32410745+edsavage@users.noreply.github.com>
2019-12-16 10:42:30 -08:00
István Zoltán Szabó 3857e3d94f
[DOCS] Moves data frame analytics job resource definitions into APIs (#50021) 2019-12-12 10:59:37 +01:00
Lisa Cawley ca482127fa
[DOCS] Move job count resource definitions into API (#50057)
Co-Authored-By: Przemysław Witek <przemyslaw.witek@elastic.co>
Co-Authored-By: David Roberts <dave.roberts@elastic.co>
Co-Authored-By: Ed Savage <32410745+edsavage@users.noreply.github.com>
2019-12-11 11:17:15 -08:00
Lisa Cawley 3d96e6b68e
[DOCS] Move datafeed resource definitions into APIs (#50005)
Co-Authored-By: István Zoltán Szabó <istvan.szabo@elastic.co>
2019-12-11 09:50:41 -08:00
Lisa Cawley 0f51bc2f72
[DOCS] Move anomaly detection job resource definitions into APIs (#49700)
Co-Authored-By: István Zoltán Szabó <istvan.szabo@elastic.co>
2019-12-06 15:32:07 -08:00
Julie Tibshirani 33a7f066e1
Remove include_type_name from the REST API spec and docs. (#48828)
In #48632 we removed support for `include_type_name` in the REST API. This PR
removes it from the API spec and documentation.
2019-11-12 09:42:46 -08:00
Martijn van Groningen 3d2a1bc59f
Include enrich into the info api as feature (#48109)
This commit also fixes a bug, the enrich enabled setting
was not included in the list of settings.
2019-10-16 19:30:27 +02:00
Lee Hinman f9511f477e
Add SLM support to xpack usage and info APIs (#48096)
* Add SLM support to xpack usage and info APIs

This adds the missing xpack usage and info information into the
`/_xpack` and `/_xpack/usage` APIs. The output now looks like:

```
GET /_xpack/usage
{
  ...
  "slm" : {
    "available" : true,
    "enabled" : true,
    "policy_count" : 1,
    "policy_stats" : {
      "retention_runs" : 0,
      ...
    }
  }
```

and

```
GET /_xpack
{
  ...
  "features" : {
    ...
    "slm" : {
      "available" : true,
      "enabled" : true
    },
    ...
  }
}
```

Relates to #43663

* Fix test expectation

* Fix docs test
2019-10-16 09:00:15 -06:00
debadair 3d5d96da07
Added request and response body sections. Closes #16035 (#48032) 2019-10-15 11:27:46 -07:00
Martijn van Groningen abdbd843ad
Merge remote-tracking branch 'es/master' into enrich 2019-10-10 14:41:34 +02:00
James Rodewig 15e2de6db8
[DOCS] Document `bytes` and `time` params in cat API docs (#47672) 2019-10-10 08:29:27 -04:00
Jim Ferenczi 8f9e77e6f1
Fix tag in the search request timeout option docs (#47776)
and add missing parentheses `search_timeout` param
2019-10-10 10:35:09 +02:00
Martijn van Groningen 957f0fad0f
Merge remote-tracking branch 'es/master' into enrich 2019-10-09 08:48:28 +02:00
debadair 07f4ca799b
Reformats term vectors APIs (#47484)
* Reformat termvectors APIs

* Reformats mtermvectors

* Apply suggestions from code review

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Incorporated review feedback.
2019-10-04 20:09:11 -07:00
debadair d5be0404f5
Reformats mget API (#47477)
* Reformats mget API

* Update docs/reference/docs/get.asciidoc

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Incorporated feedback.
2019-10-04 17:55:53 -07:00
Tal Levy 4d3f6816a7 Merge remote-tracking branch 'elastic/master' into enrich 2019-10-04 13:30:57 -07:00
James Rodewig 730c35c4cd
[DOCS] Reformat index recovery API docs (#46493) 2019-10-03 16:13:21 -04:00
James Rodewig 26fef85887 [DOCS] Clarify `actions` parm def for tasks APIs 2019-10-01 11:49:08 -04:00
James Rodewig 9f5f9f19d0
[DOCS] Document cat tasks API (#47321) 2019-10-01 11:47:14 -04:00
Martijn van Groningen 197c1d59d4
Merge remote-tracking branch 'es/master' into enrich 2019-09-30 08:12:07 +02:00
James Rodewig 4568d30ef6
[DOCS] Document missing query parms for cat recovery API (#47181)
Documents the following query parameters for
the /_cat/recovery API:

* `active_only`
* `detailed`
* `index`
2019-09-27 12:19:47 -04:00
Martijn van Groningen f676d9730d
Merge remote-tracking branch 'es/master' into enrich 2019-09-27 13:51:17 +02:00
James Rodewig 223110491b
[DOCS] Reformat get pipeline API (#47131) 2019-09-26 08:26:01 -04:00
James Rodewig 48471b2e9a
[DOCS] Reformat clone index API docs (#46762) 2019-09-25 12:36:23 -04:00
Martijn van Groningen afc16ba518
Merge remote-tracking branch 'es/master' into enrich 2019-09-23 09:34:53 +02:00
Lisa Cawley 4da98c9e46
[DOCS] Update data frame transform URLs (#46940) 2019-09-20 13:26:57 -07:00
István Zoltán Szabó 4e11a19371
[DOCS] Reformats count API (#46377)
* [DOCS] Reformats count API.
Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2019-09-17 09:53:03 +02:00
Lisa Cawley 79c1a6f7fb
[DOCS] Removes data-frames folder (#46760) 2019-09-16 10:23:46 -07:00
lcawl 6145f1765c [DOCS] Fixes formatting of analyzer parameter 2019-09-16 10:02:41 -07:00
Lisa Cawley b3dfd6e6d0
[DOCS] Updates dataframe transform terminology (#46642) 2019-09-16 08:28:19 -07:00
Hendrik Muhs de17140ca0
[Transform] Rename data frame plugin to transform: classes in xpack.core (#46644)
rename classes in xpack.core of transform plugin from "data frame transform" to "transform"
2019-09-15 19:59:21 +02:00
James Rodewig 5c78f606c2
[DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
Martijn van Groningen f97cc7f355
Merge remote-tracking branch 'es/master' into enrich 2019-09-09 08:38:37 +02:00
James Rodewig 8d1ad42625
[DOCS] Correct definition for `allow_no_indices` parameter (#46450) 2019-09-06 14:10:36 -04:00
James Rodewig e43be90e6c
[DOCS] [5 of 5] Change // TESTRESPONSE comments to [source,console-results] (#46449) 2019-09-06 14:05:36 -04:00
James Rodewig 73838499b0
[DOCS] Resort common-parms (#46419) 2019-09-06 09:22:36 -04:00
James Rodewig 565ba9cb88
[DOCS] Reformat index stats API docs (#46322) 2019-09-05 15:03:33 -04:00
James Rodewig a5c60fb59a
[DOCS] Reformat index segments API docs (#46345) 2019-09-05 08:33:17 -04:00
James Rodewig dace374e26
[DOCS] Separate Enrich API Docs (#46286)
* Add enrich policy common parameter

* Add enrich APIs to REST APIs index

* Add put enrich policy API docs

* Add get enrich policy API docs

* Add delete enrich policy API docs

* Add execute enrich policy API docs
2019-09-04 14:11:52 -04:00
James Rodewig bf0b3ce885
[DOCS] Reformat "put index template" API docs (#46297) 2019-09-04 11:47:32 -04:00
James Rodewig 6b010437d2
[DOCS] Add "index template exists" API docs (#46095) 2019-08-29 13:18:47 -04:00
James Rodewig effb6502d7
[DOCS] Separate add index alias API docs (#46086) 2019-08-29 10:38:48 -04:00
Zachary Tong bf71108ab3
Rename `data-science` plugin to `analytics` (#46092)
This renames the "data-science" plugin to "analytics".
Also removes the enabled flag
2019-08-29 10:34:17 -04:00
James Rodewig 947fccbda3
[DOCS] Add get index alias API docs (#46046) 2019-08-29 09:44:58 -04:00
debadair 2dcdbc90f2
[DOCS] Reformats delete by query API (#46051)
* Reformats delete by query API

* Update docs/reference/docs/delete-by-query.asciidoc

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Updated common parms includes.
2019-08-28 19:33:50 -07:00
István Zoltán Szabó 6ba13e9ec3 [DOCS] Adds search-related query parameters to the common parameters. (#46057)
@szabosteve Merging so I can make some additions. Will incorporate the comments from @jrodewig.
2019-08-28 16:44:22 -07:00
Zachary Tong 273c35f79c
Add Cumulative Cardinality agg (and Data Science plugin) (#43661)
This adds a pipeline aggregation that calculates the cumulative
cardinality of a field.  It does this by iteratively merging in the
HLL sketch from consecutive buckets and emitting the cardinality up
to that point.

This is useful for things like finding the total "new" users that have
visited a website (as opposed to "repeat" visitors).

This is a Basic+ aggregation and adds a new Data Science plugin
to house it and future advanced analytics/data science aggregations.
2019-08-26 10:43:24 -04:00
James Rodewig fbecbcf70c
[DOCS] Reformat create index API docs (#45749) 2019-08-26 08:31:31 -04:00
James Rodewig ad8eb03295
[DOCS] Relocate Ingest API docs to REST API section (#45812) 2019-08-23 11:54:40 -04:00
James Rodewig 4e70b379e4
[DOCS] Reformat get index API docs (#45758) 2019-08-23 11:14:51 -04:00
James Rodewig 46d7849032
Change `{var}` convention to `<var>` (#45904) 2019-08-23 10:57:20 -04:00
James Rodewig 00b7dc1950
[DOCS] Reformat get mapping API. Reformat and reuse multi-index params. (#45699) 2019-08-21 09:42:10 -04:00
debadair 9f094d6ecd
[DOCS] Reformat doc delete API reference. (#45422)
* [DOCS] Reformat doc delete API reference.
2019-08-13 09:54:04 -07:00
debadair 009020f569
[DOCS] Reformat index API. (#45415)
* [DOCS] Reformat index API.

* Incorporated review feedback.
2019-08-12 14:50:15 -07:00
István Zoltán Szabó 3830e53f28
[DOCS] Reformats cluster stats API and expands common params (#45270)
Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2019-08-07 16:46:39 +02:00
James Rodewig b010fa8835
[DOCS] Reformats cat nodeattrs API (#45255) 2019-08-07 09:31:07 -04:00
James Rodewig 56a380b1a8
[DOCS] Reformats cat indices API (#45239) 2019-08-07 09:08:09 -04:00
James Rodewig 5bf58c279d
[DOCS] Reformat cat count API (#45160) 2019-08-06 08:36:22 -04:00
James Rodewig 4a81606147
[DOCS] Reformats cat allocation API (#45158) 2019-08-05 11:17:37 -04:00