Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ingest: Documentation improvements for ingest node #33188

Closed
10 of 11 tasks
jakelandis opened this issue Aug 27, 2018 · 10 comments
Closed
10 of 11 tasks

ingest: Documentation improvements for ingest node #33188

jakelandis opened this issue Aug 27, 2018 · 10 comments
Assignees
Labels
:Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP >docs General docs changes

Comments

@jakelandis
Copy link
Contributor

jakelandis commented Aug 27, 2018

[1]

POST _ingest/pipeline/_simulate?verbose
{
  "pipeline" :
  {
    "description": "_description",
    "processors": [
      {
        "set" : {
          "tag": "my_set1",
          "field" : "field1",
          "value" : "value1"
        }
      },
      {
        "set" : {
          "tag": "my_set2",
          "field" : "field2",
          "value" : "value1"
        }
      }
    ]
  },
  "docs": [
    {
      "_index": "index",
      "_type": "_doc",
      "_id": "id",
      "_source": {
        "a": "foo-bar",
        "b": "bar"
      }
    }
  ]
}

[2]

POST _ingest/pipeline/_simulate?verbose
{
  "pipeline": {
    "processors": [
      {
        "set": {
          "field": "field1",
          "value": "{{a}}"
        }
      }
    ]
  },
  "docs": [
    {
      "_index": "index",
      "_type": "_doc",
      "_id": "id",
      "_source": {
        "a": "foo-bar"
      }
    }
  ]
}

[3]
https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest-geoip.html
https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest-user-agent.html
https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest-attachment.html
https://www.elastic.co/guide/en/elastic-stack-overview/6.4/field-and-document-access-control.html#set-security-user-processor

[4]
#32286
#32591
https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings

@jakelandis jakelandis added >docs General docs changes :Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP labels Aug 27, 2018
@jakelandis jakelandis self-assigned this Aug 27, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra

@tomcallahan
Copy link
Contributor

This is a great list @jakelandis . Is this issue a good place for @eskibars to discuss some documentation items as well or do you want to keep this one tightly scoped?

@jakelandis
Copy link
Contributor Author

@tomcallahan @eskibars - please add/discuss at will. This is meant to be more of a meta issue and changes will come in multiple pr's.

@eskibars
Copy link
Contributor

I think the documentation for the set_security_user processor may have been lost in the recent x-pack documentation refactoring/shuffle. We should add that in.

@eskibars
Copy link
Contributor

Disregard -- I see you have that in [3]

@eskibars
Copy link
Contributor

Also, cc @zuketo

@jakelandis
Copy link
Contributor Author

added a few items above. @original-brownbear if you pick up any of these please put your name next to it so we don't collide.

original-brownbear added a commit to original-brownbear/elasticsearch that referenced this issue Sep 4, 2018
original-brownbear added a commit to original-brownbear/elasticsearch that referenced this issue Sep 5, 2018
* Added documentation for Pipeline Processor
* Relates elastic#33188
@original-brownbear
Copy link
Member

Added item for drop processor

jakelandis added a commit to jakelandis/elasticsearch that referenced this issue Oct 16, 2018
This change also updates many of the examples to use ecs as the example.
Some additional minor improvements are also included.

Part of elastic#33188
original-brownbear added a commit that referenced this issue Oct 23, 2018
* INGEST: Document Processor Conditional

Relates #33188
jakelandis added a commit that referenced this issue Oct 23, 2018
This change also updates many of the examples to use ecs as the example.
Some additional minor improvements are also included.

Part of #33188
jakelandis pushed a commit that referenced this issue Oct 23, 2018
* Added documentation for Pipeline Processor
* Relates #33188
jakelandis added a commit to jakelandis/elasticsearch that referenced this issue Oct 23, 2018
This change also updates many of the examples to use ecs as the example.
Some additional minor improvements are also included.

Part of elastic#33188
jakelandis pushed a commit to jakelandis/elasticsearch that referenced this issue Oct 23, 2018
* Added documentation for Pipeline Processor
* Relates elastic#33188
jakelandis pushed a commit to jakelandis/elasticsearch that referenced this issue Oct 23, 2018
* INGEST: Document Processor Conditional

Relates elastic#33188
jakelandis added a commit that referenced this issue Oct 24, 2018
This change also updates many of the examples to use ecs as the example.
Some additional minor improvements are also included.

Part of #33188
jakelandis pushed a commit that referenced this issue Oct 24, 2018
* Added documentation for Pipeline Processor
* Relates #33188
jakelandis pushed a commit that referenced this issue Oct 24, 2018
* INGEST: Document Processor Conditional

Relates #33188
jakelandis added a commit to jakelandis/elasticsearch that referenced this issue Oct 29, 2018
jakelandis added a commit to jakelandis/elasticsearch that referenced this issue Oct 29, 2018
kcm pushed a commit that referenced this issue Oct 30, 2018
* INGEST: Document Processor Conditional

Relates #33188
kcm pushed a commit that referenced this issue Oct 30, 2018
This change also updates many of the examples to use ecs as the example.
Some additional minor improvements are also included.

Part of #33188
kcm pushed a commit that referenced this issue Oct 30, 2018
* Added documentation for Pipeline Processor
* Relates #33188
jakelandis added a commit to jakelandis/elasticsearch that referenced this issue Oct 30, 2018
* adds `if`, `on_failure`, and `tag` to table for each processor

part of elastic#33188
jakelandis added a commit that referenced this issue Nov 1, 2018
* adds `if`, `on_failure`, `tag`, and `ignore_failure` to table for each processor

part of #33188

* added ingore_failure

* fix whitespace noise
jakelandis added a commit that referenced this issue Nov 5, 2018
* move the set security user processor to the main documentation
* link to plugin processors

part of #33188
jakelandis added a commit that referenced this issue Nov 6, 2018
* adds `if`, `on_failure`, `tag`, and `ignore_failure` to table for each processor

part of #33188

* added ingore_failure

* fix whitespace noise
jakelandis added a commit that referenced this issue Nov 6, 2018
* move the set security user processor to the main documentation
* link to plugin processors

part of #33188
jakelandis added a commit that referenced this issue Nov 6, 2018
* adds `if`, `on_failure`, `tag`, and `ignore_failure` to table for each processor

part of #33188

* added ingore_failure

* fix whitespace noise
jakelandis added a commit that referenced this issue Nov 6, 2018
* move the set security user processor to the main documentation
* link to plugin processors

part of #33188
jakelandis added a commit that referenced this issue Nov 26, 2018
jakelandis added a commit that referenced this issue Nov 26, 2018
jakelandis added a commit that referenced this issue Nov 26, 2018
@martijnvg
Copy link
Member

@jakelandis What is the status of this meta issue?

@jakelandis
Copy link
Contributor Author

@martijnvg - thanks for the ping. This can be considered done. The outstanding task was documenting the methods via Painless which is done here: https://www.elastic.co/guide/en/elasticsearch/painless/7.2/painless-api-reference-ingest-org-elasticsearch-ingest-common.html#painless-api-reference-ingest-Processors ...That doc could probably be beefed up some, but for now it is good enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP >docs General docs changes
Projects
None yet
Development

No branches or pull requests

6 participants