From 9fc6c90f7732da0c20a19b1d93041a209f12e047 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 7 Mar 2019 17:14:24 -0800 Subject: [PATCH 1/7] Adds anomaly detection jobs to the Glossary --- docs/en/glossary/glossary.asciidoc | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/en/glossary/glossary.asciidoc b/docs/en/glossary/glossary.asciidoc index 36e47e3ef..9d16ead95 100644 --- a/docs/en/glossary/glossary.asciidoc +++ b/docs/en/glossary/glossary.asciidoc @@ -54,8 +54,15 @@ Also see <> and <>. + //Source: Elasticsearch endif::elasticsearch-terms[] -ifdef::cloud-terms[] +ifdef::xpack-terms[] +[[glossary-anomaly-detection-job]] {anomaly-job} :: +{anomaly-jobs-cap} contain the configuration information and metadata +necessary to perform an analytics task. ++ +//Source: X-Pack +endif::xpack-terms[] +ifdef::cloud-terms[] [[glossary-zone]] availability zone :: Contains resources available to a {ece} installation that are isolated from @@ -69,7 +76,6 @@ entire availability zone. Also see //Source: Cloud endif::cloud-terms[] ifdef::cloud-terms[] - [[glossary-beats-runner]] beats runner :: Used to send Filebeat and Metricbeat information to the logging cluster. @@ -82,7 +88,7 @@ ifdef::xpack-terms[] The {ml-features} use the concept of a bucket to divide the time series into batches for processing. The _bucket span_ is part of the -configuration information for a job. It defines the time interval that is used +configuration information for {anomaly-jobs}. It defines the time interval that is used to summarize and model the data. This is typically between 5 minutes to 1 hour and it depends on your data characteristics. When you set the bucket span, take into account the granularity at which you want to analyze, the frequency @@ -207,8 +213,8 @@ ifdef::xpack-terms[] [[glossary-ml-detector]] detector :: -As part of the configuration information that is associated with an -{anomaly-job}, detectors define the type of analysis that needs to be done. They +As part of the configuration information that is associated with {anomaly-jobs}, +detectors define the type of analysis that needs to be done. They also specify which fields to analyze. You can have more than one detector in a job, which is more efficient than running multiple jobs against the same data. + From 6bca810dae6f7064c5af004e22775db37efaa54b Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 7 Mar 2019 17:29:43 -0800 Subject: [PATCH 2/7] Adds rollup jobs to glossary --- docs/en/glossary/glossary.asciidoc | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/en/glossary/glossary.asciidoc b/docs/en/glossary/glossary.asciidoc index 9d16ead95..feeaf0efc 100644 --- a/docs/en/glossary/glossary.asciidoc +++ b/docs/en/glossary/glossary.asciidoc @@ -409,7 +409,7 @@ file, syslog, redis, and beats. endif::logstash-terms[] ifdef::xpack-terms[] -[[glossary-ml-job]] job :: +[[glossary-ml-job]][[glossary-job]] job :: Machine learning jobs contain the configuration information and metadata necessary to perform an analytics task. There are two types: {anomaly-jobs} and @@ -649,6 +649,14 @@ by making sure that only authorized hosts become part of the installation. + //Source: Cloud endif::cloud-terms[] +ifdef::xpack-terms[] + +[[glossary-rollup-job]] rollup job:: + +Rollup jobs contain the configuration information and metadata necessary to roll +up specific indices. See {ref}/xpack-rollup.html[Rolling up historical data]. +//Source: X-Pack +endif::xpack-terms[] ifdef::elasticsearch-terms[] [[glossary-routing]] routing :: From 35b7683dec92faefed7f343fb077501751a44763 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 7 Mar 2019 17:39:09 -0800 Subject: [PATCH 3/7] Adds placeholder for dataframe jobs --- docs/en/glossary/glossary.asciidoc | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/en/glossary/glossary.asciidoc b/docs/en/glossary/glossary.asciidoc index feeaf0efc..14a5f3c74 100644 --- a/docs/en/glossary/glossary.asciidoc +++ b/docs/en/glossary/glossary.asciidoc @@ -58,7 +58,8 @@ ifdef::xpack-terms[] [[glossary-anomaly-detection-job]] {anomaly-job} :: {anomaly-jobs-cap} contain the configuration information and metadata -necessary to perform an analytics task. +necessary to perform an analytics task. See +{stack-ov}/ml-jobs.html[{ml-jobs-cap}]. + //Source: X-Pack endif::xpack-terms[] @@ -210,6 +211,12 @@ Alternatively you can post data from any source directly to a {ml} API. //Source: X-Pack endif::xpack-terms[] ifdef::xpack-terms[] +[[glossary-dataframe-job]] {dfanalytics-job} :: + +TBD +//Source: X-Pack +endif::xpack-terms[] +ifdef::xpack-terms[] [[glossary-ml-detector]] detector :: From eaf03903d3517c7e6cea64a512e0b440d94dac17 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 2 Jan 2020 13:05:57 -0800 Subject: [PATCH 4/7] [DOCS] Adds data frame analytics job definition --- docs/en/glossary/glossary.asciidoc | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/en/glossary/glossary.asciidoc b/docs/en/glossary/glossary.asciidoc index 14a5f3c74..ae691fe74 100644 --- a/docs/en/glossary/glossary.asciidoc +++ b/docs/en/glossary/glossary.asciidoc @@ -59,7 +59,8 @@ ifdef::xpack-terms[] {anomaly-jobs-cap} contain the configuration information and metadata necessary to perform an analytics task. See -{stack-ov}/ml-jobs.html[{ml-jobs-cap}]. +{ml-docs}/ml-jobs.html[{ml-jobs-cap}] and the +{ref}/ml-put-job.html[create {anomaly-job} API]. + //Source: X-Pack endif::xpack-terms[] @@ -188,7 +189,7 @@ ifdef::xpack-terms[] [[glossary-ccr]] {ccr} (CCR):: The {ccr} feature enables you to replicate indices in remote clusters to your -local cluster. For more information, see {stack-ov}/xpack-ccr.html[{ccr-cap}]. +local cluster. For more information, see {ref}/xpack-ccr.html[{ccr-cap}]. + //Source: X-Pack endif::xpack-terms[] @@ -213,7 +214,11 @@ endif::xpack-terms[] ifdef::xpack-terms[] [[glossary-dataframe-job]] {dfanalytics-job} :: -TBD +{dfanalytics-jobs-cap} contain the configuration information and metadata +necessary to perform {ml} analytics tasks on a source index and store the +outcome in a destination index. See +{ml-docs}//ml-dfa-overview[{dfanalytics-cap} overview] and the +{ref}/put-dfanalytics.html[create {dfanalytics-job} API]. //Source: X-Pack endif::xpack-terms[] ifdef::xpack-terms[] @@ -419,8 +424,9 @@ ifdef::xpack-terms[] [[glossary-ml-job]][[glossary-job]] job :: Machine learning jobs contain the configuration information and metadata -necessary to perform an analytics task. There are two types: {anomaly-jobs} and -{dfanalytics-jobs}. +necessary to perform an analytics task. There are two types: +<> and +<>. + //Source: X-Pack endif::xpack-terms[] @@ -658,10 +664,11 @@ by making sure that only authorized hosts become part of the installation. endif::cloud-terms[] ifdef::xpack-terms[] -[[glossary-rollup-job]] rollup job:: +[[glossary-rollup-job]] {rollup-job}:: -Rollup jobs contain the configuration information and metadata necessary to roll -up specific indices. See {ref}/xpack-rollup.html[Rolling up historical data]. +A {rollup-job} contains all the details about how the job should run, when it +indexes documents, and what future queries will be able to execute against the +rollup index. See {ref}/xpack-rollup.html[Rolling up historical data]. //Source: X-Pack endif::xpack-terms[] ifdef::elasticsearch-terms[] From e518075f1ba9e2005d38400a4db3da7ed8a2b082 Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 3 Jan 2020 10:00:30 -0800 Subject: [PATCH 5/7] [DOCS] Fixes broken link --- docs/en/glossary/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/glossary/glossary.asciidoc b/docs/en/glossary/glossary.asciidoc index ae691fe74..f46d1492a 100644 --- a/docs/en/glossary/glossary.asciidoc +++ b/docs/en/glossary/glossary.asciidoc @@ -217,7 +217,7 @@ ifdef::xpack-terms[] {dfanalytics-jobs-cap} contain the configuration information and metadata necessary to perform {ml} analytics tasks on a source index and store the outcome in a destination index. See -{ml-docs}//ml-dfa-overview[{dfanalytics-cap} overview] and the +{ml-docs}//ml-dfa-overview.html[{dfanalytics-cap} overview] and the {ref}/put-dfanalytics.html[create {dfanalytics-job} API]. //Source: X-Pack endif::xpack-terms[] From 8f58df95200352ce5eae54e753c40f0df2e61b4c Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 9 Jan 2020 09:54:39 -0800 Subject: [PATCH 6/7] Link from job to rollup job in glossary --- docs/en/glossary/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/glossary/glossary.asciidoc b/docs/en/glossary/glossary.asciidoc index 94322be73..be726904c 100644 --- a/docs/en/glossary/glossary.asciidoc +++ b/docs/en/glossary/glossary.asciidoc @@ -391,7 +391,7 @@ ifdef::xpack-terms[] Machine learning jobs contain the configuration information and metadata necessary to perform an analytics task. There are two types: <> and -<>. +<>. See also <>. + //Source: X-Pack endif::xpack-terms[] From a1577d46d26373d559fc85bf10fac7239b7f8cf2 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 15 Jan 2020 09:42:35 -0800 Subject: [PATCH 7/7] Update docs/en/glossary/glossary.asciidoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: István Zoltán Szabó --- docs/en/glossary/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/glossary/glossary.asciidoc b/docs/en/glossary/glossary.asciidoc index be726904c..6d63e0b9c 100644 --- a/docs/en/glossary/glossary.asciidoc +++ b/docs/en/glossary/glossary.asciidoc @@ -388,7 +388,7 @@ ifdef::xpack-terms[] [[glossary-ml-job]][[glossary-job]] job :: -Machine learning jobs contain the configuration information and metadata +{ml-cap} jobs contain the configuration information and metadata necessary to perform an analytics task. There are two types: <> and <>. See also <>.