ppl-reference

Author PPL queries for OpenSearch observability data with commands and functions.

34|32|Updated Jan 28, 2026
One-click install
npx skills add https://github.com/opensearch-project/observability-stack --skill ppl-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ppl-reference
Source: https://github.com/opensearch-project/observability-stack/tree/main/claude-code-observability-plugin/skills/ppl-reference
Command: npx skills add https://github.com/opensearch-project/observability-stack --skill ppl-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

PPL reference provides authoritative guidance for building, debugging, and optimizing PPL queries against OpenSearch observability data.

Core Features & Use Cases

  • Comprehensive command, function, and endpoint reference for PPL used with OpenSearch indices in logs and traces.
  • Practical examples across OTEL-informed datasets to accelerate query authoring, troubleshooting, and performance tuning.
  • Use Case: A data engineer quickly constructs a PPL pipeline to source a dataset, filter by status, and produce aggregated results for dashboards.

Quick Start

Create a simple PPL query against your OpenSearch indices to count spans per service.

Frequently Asked Questions about ppl-reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write OpenSearch PPL queries for observability logs and traces?

OpenSearch PPL queries for observability logs and traces are written using a pipeline syntax to source datasets, filter by fields, and aggregate results. This reference provides command, function, and endpoint guidance for OTEL traces and indices.

Can I use PPL commands to aggregate and parse OpenSearch indices?

PPL commands can aggregate and parse OpenSearch indices using built-in functions. You can apply search, stats, timechart, and parse commands against your observability data to produce aggregated results for dashboards and troubleshooting.

What is the best way to count spans per service using PPL?

The best way to count spans per service using PPL is to source your OpenSearch indices and apply the stats command to aggregate the results. This skill provides practical examples for quickly constructing these pipeline queries.

Does PPL work with OTEL informed datasets in OpenSearch?

PPL works with OTEL informed datasets in OpenSearch to enable observability query authoring. It supports field handling and usage patterns specifically tailored for searching and analyzing OTEL traces and log data.

How do I troubleshoot and optimize PPL query performance for OpenSearch observability?

To troubleshoot and optimize PPL query performance for OpenSearch observability, use the reference's practical examples to refine command syntax and field handling. This ensures efficient searches, stats, and timechart generation against large datasets.

Why are my PPL search and stats commands returning incorrect field results?

PPL search and stats commands may return incorrect field results due to improper field handling or syntax errors in the pipeline. Use this reference to validate command usage, API endpoints, and parsing logic against your OpenSearch indices.