Browse Source

Add complete examples to some ingest docs

These examples should make it more clear what the plugins do and they
test that the snippets actually work.

Relates to #18160
Nik Everett 9 years ago
parent
commit
f204ad026c
2 changed files with 69 additions and 2 deletions
  1. 33 1
      docs/plugins/ingest-attachment.asciidoc
  2. 36 1
      docs/plugins/ingest-user-agent.asciidoc

+ 33 - 1
docs/plugins/ingest-attachment.asciidoc

@@ -52,10 +52,13 @@ The node must be stopped before removing the plugin.
 | `properties`           | no        | all              | Properties to select to be stored. Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`
 |======
 
+For example, this:
+
 [source,js]
 --------------------------------------------------
+PUT _ingest/pipeline/attachment
 {
-  "description" : "...",
+  "description" : "Extract attachment information",
   "processors" : [
     {
       "attachment" : {
@@ -64,7 +67,36 @@ The node must be stopped before removing the plugin.
     }
   ]
 }
+PUT my_index/my_type/my_id?pipeline=attachment
+{
+  "data": "e1xydGYxXGFuc2kNCkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0DQpccGFyIH0="
+}
+GET my_index/my_type/my_id
+--------------------------------------------------
+// CONSOLE
+
+Returns this:
+
+[source,js]
+--------------------------------------------------
+{
+  "found": true,
+  "_index": "my_index",
+  "_type": "my_type",
+  "_id": "my_id",
+  "_version": 1,
+  "_source": {
+    "data": "e1xydGYxXGFuc2kNCkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0DQpccGFyIH0=",
+    "attachment": {
+      "content_type": "application/rtf",
+      "language": "ro",
+      "content": "Lorem ipsum dolor sit amet",
+      "content_length": "28"
+    }
+  }
+}
 --------------------------------------------------
+// TESTRESPONSE
 
 NOTE: Extracting contents from binary data is a resource intensive operation and
       consumes a lot of resources. It is highly recommended to run pipelines

+ 36 - 1
docs/plugins/ingest-user-agent.asciidoc

@@ -51,8 +51,9 @@ Here is an example that adds the user agent details to the `user_agent` field ba
 
 [source,js]
 --------------------------------------------------
+PUT _ingest/pipeline/user_agent
 {
-  "description" : "...",
+  "description" : "Add user agent information",
   "processors" : [
     {
       "user_agent" : {
@@ -61,7 +62,41 @@ Here is an example that adds the user agent details to the `user_agent` field ba
     }
   ]
 }
+PUT my_index/my_type/my_id?pipeline=user_agent
+{
+  "agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36"
+}
+GET my_index/my_type/my_id
+--------------------------------------------------
+// CONSOLE
+
+Which returns
+
+[source,js]
+--------------------------------------------------
+{
+  "found": true,
+  "_index": "my_index",
+  "_type": "my_type",
+  "_id": "my_id",
+  "_version": 1,
+  "_source": {
+    "agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
+    "user_agent": {
+      "name": "Chrome",
+      "major": "51",
+      "minor": "0",
+      "patch": "2704",
+      "os_name": "Mac OS X",
+      "os": "Mac OS X 10.10.5",
+      "os_major": "10",
+      "os_minor": "10",
+      "device": "Other"
+    }
+  }
+}
 --------------------------------------------------
+// TESTRESPONSE
 
 ===== Using a custom regex file
 To use a custom regex file for parsing the user agents, that file has to be put into the `config/ingest-user-agent` directory and