Browse Source

[DOCS] Adds screenshots to Transform examples (#72939)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
István Zoltán Szabó 4 years ago
parent
commit
0bb41ba4f8

+ 29 - 4
docs/reference/transform/examples.asciidoc

@@ -22,10 +22,20 @@ step-by-step example, see <<ecommerce-transforms>>.
 == Finding your best customers
 
 This example uses the eCommerce orders sample data set to find the customers who 
-spent the most in a hypothetical webshop. Let's transform the data such that the 
-destination index contains the number of orders, the total price of the orders, 
-the amount of unique products and the average price per order, and the total 
-amount of ordered products for each customer.
+spent the most in a hypothetical webshop. Let's use the `pivot` type of 
+{transform} such that the destination index contains the number of orders, the 
+total price of the orders, the amount of unique products and the average price 
+per order, and the total amount of ordered products for each customer.
+
+[role="screenshot"]
+image::images/transform-ex1-1.jpg["Finding your best customers with {transforms} in {kib}"]
+
+Alternatively, you can use the <<preview-transform, preview {transform}>> and 
+the <<put-transform, create {transform} API>>.
+
+.API example
+[%collapsible]
+====
 
 [source,console]
 ----------------------------------
@@ -85,6 +95,8 @@ advance, populated with some sample values. For example:
 ----------------------------------
 // NOTCONSOLE
 
+====
+
 
 This {transform} makes it easier to answer questions such as:
 
@@ -354,6 +366,9 @@ Select `timestamp` as the date field that sorts the data chronologically. For
 continuous mode, specify a date field that is used to identify new documents, 
 and an interval between checks for changes in the source index.
 
+[role="screenshot"]
+image::images/transform-ex4-1.jpg["Finding the last log event for each IP address with {transforms} in {kib}"]
+
 Let's assume that we're interested in retaining documents only for IP addresses 
 that appeared recently in the log. You can define a retention policy and specify 
 a date field that is used to calculate the age of a document. This example uses 
@@ -361,12 +376,20 @@ the same date field that is used to sort the data. Then set the maximum age of a
 document; documents that are older than the value you set will be removed from 
 the destination index.
 
+[role="screenshot"]
+image::images/transform-ex4-2.jpg["Defining retention policy for {transforms} in {kib}"]
+
 This {transform} creates the destination index that contains the latest login 
 date for each client IP. As the {transform} runs in continuous mode, the 
 destination index will be updated as new data that comes into the source index. 
 Finally, every document that is older than 30 days will be removed from the 
 destination index due to the applied retention policy.
 
+
+.API example
+[%collapsible]
+====
+
 [source,console]
 ----------------------------------
 PUT _transform/last-log-from-clientip
@@ -424,6 +447,7 @@ POST _transform/last-log-from-clientip/_start
 ----------------------------------
 // TEST[skip:setup kibana sample data]
 
+====
 
 After the {transform} processes the data, search the destination index:
 
@@ -484,6 +508,7 @@ The search result shows you data like this for each client IP:
 ----------------------------------
 // NOTCONSOLE
 
+
 This {transform} makes it easier to answer questions such as:
 
 * What was the most recent log event associated with a specific IP address?

BIN
docs/reference/transform/images/transform-ex1-1.jpg


BIN
docs/reference/transform/images/transform-ex4-1.jpg


BIN
docs/reference/transform/images/transform-ex4-2.jpg