Commit graph

56 commits

Author SHA1 Message Date
Martijn van Groningen
8716b396fe
Enable GeoIP downloader by default (#74600)
Backporting #74323 to 7.x branch.

This change will enable geoip downloader by default again. It also brings back relevant documentation.

Co-authored-by: Przemko Robakowski <przemko.robakowski@elastic.co>
2021-06-28 10:01:51 +02:00
James Rodewig
d0453010df
[DOCS] Add missing xpack role (#74331) (#74366)
Co-authored-by: Yang Cheng <chengyang2048@163.com>
2021-06-21 10:13:35 -04:00
Przemko Robakowski
b8387b1c76
Disable GeoIP downloader (#72716) (#72879)
Due to problems discovered in #72572 we have to disable geoip downloader for now. We use ingest.geoip.downloader.enabled.default as feature flag.
This change also reverts changes to docs.
2021-05-10 14:19:37 +02:00
Przemko Robakowski
d7f7cbb776
[7.x] Update GeoIP processor documentation (#71211) (#71757)
* Update GeoIP processor documentation (#71211)

This PR adds documentation for GeoIPv2 auto-update feature.
It also changes related settings names from geoip.downloader.* to ingest.geoip.downloader to have the same convention as current setting.

Relates to #68920

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-04-15 20:55:48 +02:00
James Rodewig
2676c47783 [DOCS] Fix create enrich policy API title 2021-04-08 17:54:01 -04:00
James Rodewig
71daaba676
[DOCS] Fix create enrich policy API title (#71494) (#71496) 2021-04-08 15:50:54 -04:00
James Rodewig
8522b87ce9
[DOCS] Document ingest processor description (#70899) (#70914) 2021-03-26 10:09:12 -04:00
James Rodewig
994811584a
[DOCS] Move enrich policy object def to API docs (#70825) (#70866) 2021-03-25 09:32:29 -04:00
James Rodewig
f1666ed990
[DOCS] Fix simulate pipeline API's request parameter docs (#70678) (#70740) 2021-03-23 09:52:44 -04:00
James Rodewig
da4c2716f4
[DOCS] Document on_failure param for create pipeline API (#70679) (#70736) 2021-03-23 09:35:06 -04:00
James Rodewig
fcfff1711f
[DOCS] Add additional example to ingest pipeline docs (#70677) (#70721) 2021-03-23 08:09:21 -04:00
James Rodewig
df04664472 [DOCS] Fix heading in create ingest pipeline API docs 2021-03-22 14:06:35 -04:00
James Rodewig
7bac3f9154 [DOCS] Streamline create pipeline API parameter defs 2021-03-22 13:03:11 -04:00
James Rodewig
302341a526
[DOCS] Replace put with create or update in API names (#70330) (#70421)
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2021-03-15 17:16:13 -04:00
James Rodewig
b95afd9ddf
[DOCS] Refactor ingest pipeline docs (#70253) (#70409) 2021-03-15 14:12:11 -04:00
James Rodewig
e1a63390b5
[DOCS] Add security privileges to ingest API docs (#67845) (#67900) 2021-01-25 08:58:50 -05:00
James Rodewig
674210f5df
[DOCS] Make cat API verbose query param explicit (#67300) (#67305) 2021-01-12 08:33:50 -05:00
James Rodewig
e4c1051c29
[DOCS] Document get pipeline API as multi-target (#64816) (#64827) 2020-11-09 16:28:09 -05:00
James Rodewig
aea83909d9
[DOCS] Fix case for 'Boolean' (#64299) (#64341) 2020-10-29 10:04:20 -04:00
Jake Landis
d2e5f2f532
[7.x] Enhance the ingest node simulate verbose output (#60433) (#60678)
This commit enhances the verbose output for the
`_ingest/pipeline/_simulate?verbose` api. Specifically
this adds the following:
* the pipeline processor is now included in the output
* the conditional (if) and result is now included in the output iff it was defined
* a status field is always displayed. the possible values of status are
  * `success` - if the processor ran with out errors
  * `error` - if the processor ran but threw an error that was not ingored
  * `error_ignored` - if the processor ran but threw an error that was ingored
  * `skipped` - if the process did not run (currently only possible if the if condition evaluates to false)
  * `dropped` - if the the `drop` processor ran and dropped the document
* a `processor_type` field for the type of processor (e.g. set, rename, etc.)
* throw a better error if trying to simulate with a pipeline that does not exist

closes #56004
2020-08-27 16:53:09 -05:00
James Rodewig
b302b09b85
[DOCS] Reformat snippets to use two-space indents (#59973) (#59994) 2020-07-21 15:49:58 -04:00
Lisa Cawley
db5bf92acf
[7.x][DOCS] Replace docdir attribute with es-repo-dir (#57489) (#57494) 2020-06-01 16:42:53 -07:00
Thiago Souza
1feb0a95b5 [DOCS] Correct get enrich policy API request example (#56207) 2020-05-05 12:37:54 -04:00
James Rodewig
af987fb2d4
[DOCS] Reduce content reuse in enrich docs (#53460)
Restructures the 'Update an enrich policy' section to:

* Migrate the content to the section. It was previously stored in the
  Put Enrich Policy API docs.
* Remove the warning tag admonition from the section content.
* Replace a reused section earlier in the "Set up an enrich processor"
  page with a link.

No substantive changes were made to the content.
2020-03-12 05:57:23 -04:00
Orhan Toy
ad2f630795 [DOCS] Fix formatting of simulate ingest pipeline API docs (#52754) 2020-03-02 11:46:27 -05:00
Russ Cam
62da077beb Specify name on enrich.get_policy as list type (#50217)
This commit updates the enrich.get_policy API to specify name
as a list, in line with other URL parts that accept a comma-separated
list of values.

In addition, update the get enrich policy API docs
to align the URL part name in the documentation with
the name used in the REST API specs.

(cherry picked from commit 94f6f946ef)
2020-02-20 11:39:28 +10:00
Martijn van Groningen
02dfd71efa
Backport: Add pipeline name to ingest metadata (#51050)
Backport: #50467

This commit adds the name of the current pipeline to ingest metadata.
This pipeline name is accessible under the following key: '_ingest.pipeline'.

Example usage in pipeline:
PUT /_ingest/pipeline/2
{
    "processors": [
        {
            "set": {
                "field": "pipeline_name",
                "value": "{{_ingest.pipeline}}"
            }
        }
    ]
}

Closes #42106
2020-01-16 10:50:47 +01:00
Lisa Cawley
26beb486c7 [DOCS] Fixes security links (#49563) 2019-11-25 13:02:26 -08:00
James Rodewig
62a3154d0e
[DOCS] [7.x] Add high-level docs for enrich processor and policies (#49194) (#49331) 2019-11-19 16:38:13 -05:00
Shaunak Kashyap
d27a307379 [DOCS] Remove extraneous comma in Enrich Stats API's JSON response (#48539) 2019-10-25 12:35:50 -04:00
Martijn van Groningen
c09b62d5bf
Backport: also validate source index at put enrich policy time (#48311)
Backport of: #48254

This changes tests to create a valid
source index prior to creating the enrich policy.
2019-10-22 07:38:16 +02:00
James Rodewig
3a7c2a4d17 [DOCS] Add wait_for_completion parm to execute enrich policy API docs (#48077) 2019-10-15 13:47:30 -04:00
Martijn van Groningen
7fc9198d46
Change how max_matches affects target_field option. (#47982)
Prior to this change the `target_field` would always be a json array
field in the document being ingested. This to take into account that
multiple enrich documents could be inserted into the `target_field`.

However the default `max_matches` is `1`. Meaning that by default
only a single enrich document would be added to `target_field` json
array field.

This commit changes this; if `max_matches` is set to `1` then the single
document would be added as a json object to the `target_field` and
if it is configured to a higher value then the enrich documents will be
added as a json array (even if a single enrich document happens to be
enriched).
2019-10-14 21:09:48 +02:00
James Rodewig
65f8294378 [DOCS] Add docs for geo_match enrich policy type (#47745) 2019-10-09 09:02:52 -04:00
Martijn van Groningen
f2f2304c75
Merge remote-tracking branch 'es/7.x' into enrich-7.x 2019-10-07 10:07:56 +02:00
James Rodewig
0179f93544
[DOCS] Reformat simulate pipeline API (#47301) (#47398) 2019-10-01 14:49:14 -04:00
James Rodewig
aeb4edce3a
[DOCS] Reformat put pipeline API (#47171) (#47395) 2019-10-01 14:48:18 -04:00
James Rodewig
024d1f2ab9
[DOCS] Reformat delete pipeline API (#47172) (#47294) 2019-09-30 11:38:46 -04:00
Martijn van Groningen
fe937ea4b8
Add config namespace in get policy api response (#47162)
Currently the policy config is placed directly in the json object
of the toplevel `policies` array field. For example:

```
{
    "policies": [
        {
            "match": {
                "name" : "my-policy",
                "indices" : ["users"],
                "match_field" : "email",
                "enrich_fields" : [
                    "first_name",
                    "last_name",
                    "city",
                    "zip",
                    "state"
                ]
            }
        }
    ]
}
```

This change adds a `config` field in each policy json object:

```
{
    "policies": [
        {
            "config": {
                "match": {
                    "name" : "my-policy",
                    "indices" : ["users"],
                    "match_field" : "email",
                    "enrich_fields" : [
                        "first_name",
                        "last_name",
                        "city",
                        "zip",
                        "state"
                    ]
                }
            }
        }
    ]
}
```

This allows us in the future to add other information about policies
in the get policy api response.

The UI will consume this API to build an overview of all policies.
The UI may in the future include additional information about a policy
and the plan is to include that in the get policy api, so that this
information can be gathered in a single api call.

An example of the information that is likely to be added is:
* Last policy execution time
* The status of a policy (executing, executed, unexecuted)
* Information about the last failure if exists
2019-09-30 14:37:23 +02:00
Martijn van Groningen
36215bd33e
fixed docs issue 2019-09-30 08:04:18 +02:00
Martijn van Groningen
7ffe2e7e63
Merge remote-tracking branch 'es/7.x' into enrich-7.x 2019-09-27 14:42:11 +02:00
James Rodewig
3b626c2d56
[DOCS] Reformat get pipeline API (#47131) (#47163) 2019-09-26 08:51:12 -04:00
James Rodewig
618fb31be8 [DOCS] Minor editorial changes to enrich docs 2019-09-23 13:25:34 -04:00
Michael Basnight
f1c7ed647b Allow comma separated ids in get enrich policy API (#46351)
This commit changes the GET REST api so it will accept an optional comma
separated list of enrich policy ids. This change also modifies the
behavior of the GET API in that it will not error if it is passed a bad
enrich id anymore, but will instead just return an empty list.
2019-09-20 10:06:58 -05:00
James Rodewig
b6da5fa2f7 [DOCS] Correct <enrich-policy> parm description for comma-sep list (#46682) 2019-09-18 08:30:50 -04:00
James Rodewig
411d4e9a93 [DOCS] Change // CONSOLE comments to [source,console] (#46669) 2019-09-12 10:27:35 -04:00
James Rodewig
35bf92cdac [DOCS] Reformat enrich stats API (#46600) 2019-09-11 13:52:50 -04:00
Martijn van Groningen
a4b0f66919
Add enrich stats api (#46462)
The enrich api returns enrich coordinator stats and
information about currently executing enrich policies.

The coordinator stats include per ingest node:
* The current number of search requests in the queue.
* The total number of outstanding remote requests that
  have been executed since node startup. Each remote
  request is likely to include multiple search requests.
  This depends on how much search requests are in the
  queue at the time when the remote request is performed.
* The number of current outstanding remote requests.
* The total number of search requests that `enrich`
  processors have executed since node startup.

The current execution policies stats include:
* The name of policy that is executing
* A full blow task info object that is executing the policy.

Relates to #32789
2019-09-11 13:40:24 +02:00
James Rodewig
a27d075db4
[DOCS] Update "Enrich your data" tutorials (#46417)
* Move enrich docs to separate file

* Rewrite enrich processor tutorial
2019-09-11 13:08:48 +02:00
James Rodewig
d74d995382
[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-11 13:08:28 +02:00