Plugin Module: opensearch

Datasource plugin for OpenSearch in Perses. Supports log queries using PPL (Piped Processing Language).

This plugin is intended to display logs alongside the traces surfaced by the Tempo plugin, so a user can pivot from a trace to the related logs in OpenSearch.

How to install

This plugin requires react and react-dom 18.

npm install react@18 react-dom@18
npm install @perses-dev/opensearch-plugin

Development

npm install
npm run dev      # start the dev server
npm run build    # build the plugin
npm test         # run unit tests

Trace to logs

This plugin is intended to display logs alongside traces produced by the Tempo or Jaeger plugins. Use a dashboard variable (e.g. $traceId) to share the selected trace between the trace panel and the OpenSearch logs panel.

PPL example:

source=otel-logs-* | where traceId='$traceId'

A complete example dashboard is in docs/examples/trace-to-logs.json. See docs/examples/README.md for field-name conventions and how to swap Tempo for Jaeger.

Field overrides

OpenSearch is schema-flexible; field names vary by exporter. The plugin tries common names by default (@timestamp/timestamp/time for the timestamp; message/log/body for the message). If your index uses different names, set timestampField and messageField on the query spec.