honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Clarify wildcard usage in ML datafeed APIs (elastic/x-pack-elasticsearch#1296) 

Original commit: elastic/x-pack-elasticsearch@c18fca323b
This commit is contained in:
Lisa Cawley 2017-05-03 09:07:44 -07:00 committed by GitHub
parent eae7d19d2f
commit cf27cb479a
3 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/en/rest-api/ml/put-datafeed.asciidoc
View File

@ -39,7 +39,8 @@ You must create a job before you create a {dfeed}. You can associate only one
span. 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. Wildcards are supported. For example:
["it_ops_metrics", "server*"].
`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.

2
docs/en/rest-api/ml/start-datafeed.asciidoc
View File

@ -44,7 +44,7 @@ If the system restarts, any jobs that had {dfeeds} running are also restarted.
When a stopped {dfeed} is restarted, it continues processing input data from When a stopped {dfeed} is restarted, it continues processing input data from
the next millisecond after it was stopped. If new data was indexed for that the next millisecond after it was stopped. If new data was indexed for that
exact millisecond, between stopping and starting, it will be ignored. exact millisecond between stopping and starting, it will be ignored.
If you specify a `start` value that is earlier than the timestamp of the latest If you specify a `start` value that is earlier than the timestamp of the latest
processed record, the {dfeed} continues from 1 millisecond after the timestamp processed record, the {dfeed} continues from 1 millisecond after the timestamp
of the latest processed record. of the latest processed record.

10
docs/en/rest-api/ml/update-datafeed.asciidoc
View File

@ -34,7 +34,8 @@ The following properties can be updated after the {dfeed} is created:
span. For example: "150s". span. For example: "150s".
`indexes`:: `indexes`::
(array) An array of index names. For example: ["it_ops_metrics"]. (array) An array of index names. Wildcards are supported. For example:
["it_ops_metrics", "server*"].
`job_id`:: `job_id`::
(string) A numerical character string that uniquely identifies the job. (string) A numerical character string that uniquely identifies the job.
@ -70,8 +71,8 @@ For more information, see <<privileges-list-cluster>>.
===== Examples ===== Examples
The following example updates the query for `datafeed-it-ops-kpi` {dfeed} so that The following example updates the query for the `datafeed-it-ops-kpi` {dfeed}
only log entries of error level are analyzed: so that only log entries of error level are analyzed:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -87,8 +88,9 @@ POST _xpack/ml/datafeeds/datafeed-it-ops-kpi/_update
// CONSOLE // CONSOLE
// TEST[skip:todo] // TEST[skip:todo]
When the {dfeed} is updated, you receive the full datafeed configuration with When the {dfeed} is updated, you receive the full {dfeed} configuration with
with the updated values: with the updated values:
[source,js] [source,js]
---- ----
{ {