This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

PPL

Piped Processing Language (PPL) is a query language that focuses on processing data in a sequential, step-by-step manner. PPL uses the pipe (|) operator to combine commands to find and retrieve data. It is the primary language used with observability in OpenSearch and supports multi-data queries.

PPL syntax

The following example shows the basic PPL syntax:

  1. search source=<index-name> | <command_1> | <command_2> | ... | <command_n>

copy

See Syntax for specific PPL syntax examples.

PPL commands

PPL filters, transforms, and aggregates data using a series of commands. See Commands for a description and an example of each command.

Using PPL within OpenSearch

To use PPL, you must have installed OpenSearch Dashboards. PPL is available within the Query Workbench tool. See the Query Workbench documentation for a tutorial on using PPL within OpenSearch.

Developer documentation

Developers can find information in the following resources: