[DOCS] More edits in datafeed resource (elastic/x-pack-elasticsearch#1221)

Original commit: elastic/x-pack-elasticsearch@ea6abc163f
This commit is contained in:
Lisa Cawley 2017-04-26 11:18:51 -07:00 committed by lcawley
parent b54de1bb91
commit 577fa559f6
3 changed files with 73 additions and 44 deletions

View File

@ -5,8 +5,8 @@
A data feed resource has the following properties: A data feed resource has the following properties:
`aggregations`:: `aggregations`::
(object) When set the datafeed performs aggregation searches. (object) If set, the data feed performs aggregation searches.
For syntax information, see {ref}search-aggregations.html[Aggregations]. For syntax information, see {ref}/search-aggregations.html[Aggregations].
Support for aggregations is limited: TBD. Support for aggregations is limited: TBD.
For example: For example:
`{"@timestamp": {"histogram": {"field": "@timestamp", `{"@timestamp": {"histogram": {"field": "@timestamp",
@ -15,43 +15,46 @@ A data feed resource has the following properties:
"field": "events_per_min"}}}}}`. "field": "events_per_min"}}}}}`.
`chunking_config`:: `chunking_config`::
(object) The chunking configuration, which specifies how data searches (object) The chunking configuration, which specifies how data searches are
will be chunked. See <<ml-datafeed-chunking-config,chunking configuration objects>>. chunked. See <<ml-datafeed-chunking-config>>.
For example: {"mode": "manual", "time_span": "3h"} For example: {"mode": "manual", "time_span": "3h"}
`datafeed_id`:: `datafeed_id`::
(string) A numerical character string that uniquely identifies the data feed. (string) A numerical character string that uniquely identifies the data feed.
`frequency`:: `frequency`::
(time units) Interval at which scheduled queries should be made while the datafeed (time units) The interval at which scheduled queries are made while the data
runs in real-time. The default is either the bucket span for short bucket spans, or, feed runs in real time. The default value is either the bucket span for short
for longer bucket spans, a sensible fraction of the bucket span. bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
For example: "150s" span. For example: "150s"
`indexes` (required):: `indexes` (required)::
(array) An array of index names. For example: ["it_ops_metrics"] (array) An array of index names. For example: ["it_ops_metrics"]
`job_id` (required):: `job_id` (required)::
(string) The id of the job to which the datafeed will send data. (string) The unique identifier for the job to which the data feed sends data.
`query`:: `query`::
(object) Elasticsearch query DSL. Corresponds to the query object in an Elasticsearch (object) The Elasticsearch query domain-specific language (DSL). This value
search POST body. All options supported by Elasticsearch may be used, as this object corresponds to the query object in an Elasticsearch search POST body. All the
is passed verbatim to Elasticsearch. If not specified the default is “match_all”: {} options that are supported by Elasticsearch can be used, as this object is
By default, this property has the following value: `{"match_all": {"boost": 1}}`. passed verbatim to Elasticsearch. By default, this property has the following
value: `{"match_all": {"boost": 1}}`. If this property is not specified, the
default value is `“match_all”: {}`.
`query_delay`:: `query_delay`::
(time units) How many seconds behind real-time should data be queried. For example, (time units) The number of seconds behind real-time that data is queried. For
if data from 10:04am may not be searchable in Elasticsearch until 10:06am then set this to 120 seconds. example, if data from 10:04 a.m. might not be searchable in Elasticsearch
The default is 60 seconds. For example: "60s" until 10:06 a.m., set this property to 120 seconds. The default value is 60
seconds. For example: "60s".
`scroll_size`:: `scroll_size`::
(unsigned integer) The `size` parameter to be used in elasticsearch searches. (unsigned integer) The `size` parameter that is used in Elasticsearch searches.
The default value is `1000`. The default value is `1000`.
`types` (required):: `types` (required)::
(array) List of types to search for within the specified indexes. (array) A list of types to search for within the specified indices.
For example: ["network","sql","kpi"] For example: ["network","sql","kpi"].
[[ml-datafeed-chunking-config]] [[ml-datafeed-chunking-config]]
===== Chunking Configuration Objects ===== Chunking Configuration Objects
@ -59,15 +62,15 @@ A data feed resource has the following properties:
A chunking configuration object has the following properties: A chunking configuration object has the following properties:
`mode` (required):: `mode` (required)::
There are 3 available modes: + There are three available modes: +
`auto`::: the chunk size will be dynamically calculated. `auto`::: The chunk size will be dynamically calculated.
`manual`::: chunking will be applied according to the specified `time_span`. `manual`::: Chunking will be applied according to the specified `time_span`.
`off`::: no chunking will be applied. `off`::: No chunking will be applied.
`time_span`:: `time_span`::
(time units) The time span that each search will be querying. (time units) The time span that each search will be querying.
This setting is only applicable when the mode is set to `manual`. This setting is only applicable when the mode is set to `manual`.
For example: "3h" For example: "3h".
[float] [float]
[[ml-datafeed-counts]] [[ml-datafeed-counts]]

View File

@ -25,33 +25,46 @@ data feed to each job.
===== Request Body ===== Request Body
`aggregations`:: `aggregations`::
(object) TBD. (object) If set, the data feed performs aggregation searches.
For more information, see <<ml-datafeed-resource>>.
`chunking_config`:: `chunking_config`::
(object) TBD. (object) The chunking configuration, which specifies how data searches are
For example: {"mode": "manual", "time_span": "30000000ms"} chunked. See <<ml-datafeed-chunking-config>>.
`frequency`:: `frequency`::
TBD: For example: "150s" (time units) The interval at which scheduled queries are made while the data
feed runs in real time. The default value is either the bucket span for short
bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
span. For example: "150s".
`indexes` (required):: `indexes` (required)::
(array) An array of index names. For example: ["it_ops_metrics"] (array) An array of index names. For example: ["it_ops_metrics"].
`job_id` (required):: `job_id` (required)::
(string) A numerical character string that uniquely identifies the job. (string) A numerical character string that uniquely identifies the job.
`query`:: `query`::
(object) The query that retrieves the data. (object) The Elasticsearch query domain-specific language (DSL). This value
By default, this property has the following value: `{"match_all": {"boost": 1}}`. corresponds to the query object in an Elasticsearch search POST body. All the
options that are supported by Elasticsearch can be used, as this object is
passed verbatim to Elasticsearch. By default, this property has the following
value: `{"match_all": {"boost": 1}}`. If this property is not specified, the
default value is `“match_all”: {}`.
`query_delay`:: `query_delay`::
TBD. For example: "60s" (time units) The number of seconds behind real-time that data is queried. For
example, if data from 10:04 a.m. might not be searchable in Elasticsearch
until 10:06 a.m., set this property to 120 seconds. The default value is 60
seconds. For example: "60s".
`scroll_size`:: `scroll_size`::
TBD. For example, 1000 (unsigned integer) The `size` parameter that is used in Elasticsearch searches.
The default value is `1000`.
`types` (required):: `types` (required)::
TBD. For example: ["network","sql","kpi"] (array) A list of types to search for within the specified indices.
For example: ["network","sql","kpi"].
For more information about these properties, For more information about these properties,
see <<ml-datafeed-resource, Data Feed Resources>>. see <<ml-datafeed-resource, Data Feed Resources>>.

View File

@ -20,33 +20,46 @@ The update data feed API enables you to update certain properties of a data feed
The following properties can be updated after the data feed is created: The following properties can be updated after the data feed is created:
`aggregations`:: `aggregations`::
(object) TBD. (object) If set, the data feed performs aggregation searches.
For more information, see <<ml-datafeed-resource>>.
`chunking_config`:: `chunking_config`::
(object) TBD. (object) The chunking configuration, which specifies how data searches are
For example: {"mode": "manual", "time_span": "30000000ms"} chunked. See <<ml-datafeed-chunking-config>>.
`frequency`:: `frequency`::
() TBD: For example: "150s" (time units) The interval at which scheduled queries are made while the data
feed runs in real time. The default value is either the bucket span for short
bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
span. For example: "150s".
`indexes` (required):: `indexes` (required)::
(array) An array of index names. For example: ["it_ops_metrics"] (array) An array of index names. For example: ["it_ops_metrics"].
`job_id`:: `job_id`::
(string) A numerical character string that uniquely identifies the job. (string) A numerical character string that uniquely identifies the job.
`query`:: `query`::
(object) The query that retrieves the data. (object) The Elasticsearch query domain-specific language (DSL). This value
By default, this property has the following value: `{"match_all": {"boost": 1}}`. corresponds to the query object in an Elasticsearch search POST body. All the
options that are supported by Elasticsearch can be used, as this object is
passed verbatim to Elasticsearch. By default, this property has the following
value: `{"match_all": {"boost": 1}}`. If this property is not specified, the
default value is `“match_all”: {}`.
`query_delay`:: `query_delay`::
() TBD. For example: "60s" (time units) The number of seconds behind real-time that data is queried. For
example, if data from 10:04 a.m. might not be searchable in Elasticsearch
until 10:06 a.m., set this property to 120 seconds. The default value is 60
seconds. For example: "60s".
`scroll_size`:: `scroll_size`::
() TBD. For example, 1000 (unsigned integer) The `size` parameter that is used in Elasticsearch searches.
The default value is `1000`.
`types` (required):: `types` (required)::
() TBD. For example: ["network","sql","kpi"] (array) A list of types to search for within the specified indices.
For example: ["network","sql","kpi"].
For more information about these properties, For more information about these properties,
see <<ml-datafeed-resource, Data Feed Resources>>. see <<ml-datafeed-resource, Data Feed Resources>>.