docs: add PPL language reference with data-grounded examples#143
Merged
anirudha merged 1 commit intoopensearch-project:mainfrom Mar 28, 2026
Merged
docs: add PPL language reference with data-grounded examples#143anirudha merged 1 commit intoopensearch-project:mainfrom
anirudha merged 1 commit intoopensearch-project:mainfrom
Conversation
Add comprehensive PPL (Piped Processing Language) documentation section targeting Splunk SREs evaluating PPL for OpenSearch observability. New pages: - PPL overview with comparison to KQL and EQL - Command reference summary (50+ commands) - 27 individual command pages with Description, Syntax, Arguments, Usage notes, Basic/Extended examples, and See also - Function reference (200+ functions across 13 categories) - Observability examples with live playground links for OTel data - Masterclass pipelines (service health scorecard, GenAI cost analysis, Envoy log parsing, error pattern discovery, cross-signal correlation) All examples use real OTel data from logs-otel-v1* and otel-v1-apm-span-* indices. Text extraction patterns (grok, rex, parse, spath) verified against actual Envoy access logs and Kafka broker logs. Updated sidebar, main page, investigate page, and README to highlight PPL. Signed-off-by: Anirudha Jadhav <anirudha@nyu.edu> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #143 +/- ##
=======================================
Coverage 18.51% 18.51%
=======================================
Files 3 3
Lines 54 54
Branches 18 18
=======================================
Hits 10 10
Misses 44 44 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
|
[Not related to this PR]. These PPL md files can be reused by PPL skill for progressive loading instead of big skill file in the current state. |
docs/starlight-docs/src/content/docs/agent-health/configuration/index.md
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add comprehensive PPL (Piped Processing Language) documentation section to the Observability Stack docs, targeting Splunk SREs evaluating PPL as a query language for OpenSearch observability.
logs-otel-v1*andotel-v1-apm-span-*indices - no fabricated dataNew pages
ppl/index.mdppl/commands.mdppl/commands/*.mdppl/functions.mdppl/examples.mdPer-command pages
Search & Filter:
search,whereFields & Transformation:
fields,eval,rename,fillnull,expand,flattenAggregation & Statistics:
stats,eventstats,streamstats,timechart,trendlineSorting & Limiting:
sort,head,dedup,top,rareText Extraction:
parse,grok,rex,patterns,spathData Combination:
join,lookupMachine Learning:
mlMetadata:
describeEach command page follows a consistent structure:
Examples page highlights
Data grounding
All text extraction examples (grok, rex, parse, spath) were tested against actual log bodies in the cluster:
frontend-proxy:[timestamp] "METHOD /path HTTP/1.1" status ...[ComponentName id=N] message ...User action product: IDKey PPL behavioral findings documented:
parserequires full-string match (implicitly anchored);rexdoes partial matching%{DATA}cause "Duplicate key" errorsOther changes
Test plan
npm run buildpasses with all internal links validated (starlight-links-validator)!%27for single quotes)my-index,accounts, Apache CLF) remains in any example🤖 Generated with Claude Code