usage.asciidoc 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. [role="xpack"]
  2. [[transform-usage]]
  3. = When to use {transforms}
  4. {es} aggregations are a powerful and flexible feature that enable you to
  5. summarize and retrieve complex insights about your data. You can summarize
  6. complex things like the number of web requests per day on a busy website, broken
  7. down by geography and browser type. If you use the same data set to try to
  8. calculate something as simple as a single number for the average duration of
  9. visitor web sessions, however, you can quickly run out of memory.
  10. Why does this occur? A web session duration is an example of a behavioral
  11. attribute not held on any one log record; it has to be derived by finding the
  12. first and last records for each session in our weblogs. This derivation requires
  13. some complex query expressions and a lot of memory to connect all the data
  14. points. If you have an ongoing background process that fuses related events from
  15. one index into entity-centric summaries in another index, you get a more useful,
  16. joined-up picture. This new index is sometimes referred to as a _{dataframe}_.
  17. You might want to consider using {transforms} instead of aggregations when:
  18. * You need a complete _feature index_ rather than a top-N set of items.
  19. +
  20. In {ml}, you often need a complete set of behavioral features rather just the
  21. top-N. For example, if you are predicting customer churn, you might look at
  22. features such as the number of website visits in the last week, the total number
  23. of sales, or the number of emails sent. The {stack} {ml-features} create models
  24. based on this multi-dimensional feature space, so they benefit from the full
  25. feature indices that are created by {transforms}.
  26. +
  27. This scenario also applies when you are trying to search across the results of
  28. an aggregation or multiple aggregations. Aggregation results can be ordered or
  29. filtered, but there are
  30. {ref}/search-aggregations-bucket-terms-aggregation.html#search-aggregations-bucket-terms-aggregation-order[limitations to ordering]
  31. and
  32. {ref}/search-aggregations-pipeline-bucket-selector-aggregation.html[filtering by bucket selector]
  33. is constrained by the maximum number of buckets returned. If you want to search
  34. all aggregation results, you need to create the complete {dataframe}. If you
  35. need to sort or filter the aggregation results by multiple fields, {transforms}
  36. are particularly useful.
  37. * You need to sort aggregation results by a pipeline aggregation.
  38. +
  39. {ref}/search-aggregations-pipeline.html[Pipeline aggregations] cannot be used
  40. for sorting. Technically, this is because pipeline aggregations are run during
  41. the reduce phase after all other aggregations have already completed. If you
  42. create a {transform}, you can effectively perform multiple passes over the data.
  43. * You want to create summary tables to optimize queries.
  44. +
  45. For example, if you
  46. have a high level dashboard that is accessed by a large number of users and it
  47. uses a complex aggregation over a large dataset, it may be more efficient to
  48. create a {transform} to cache results. Thus, each user doesn't need to run the
  49. aggregation query.