[FEATURE] Add OpenSearch datasource and log query plugin with PPL support by Oliver-ke · Pull Request #641 · perses/plugins

Oliver-ke · 2026-04-27T03:13:46Z

Description

Adds an OpenSearch datasource + log query plugin

These changes includes:

Plugin scaffold — OpenSearchDatasource + OpenSearchLogQuery plugins (TypeScript, React, Module Federation via rsbuild).
PPL client (opensearch-client.ts) - POSTs to /_plugins/_ppl, handles relative datasource URLs, throws a typed OpenSearchPPLError(status, body) on non-200.
Time bounding + row mapping (get-opensearch-log-data.ts) - wraps user PPL with a where clause on the configured timestamp field; maps rows to LogEntry and surfaces
remaining columns (e.g. traceId) as labels.
Field-name overrides - timestampField / messageField on the query spec for indexes that don't use @timestamp / message (e.g. OpenTelemetry's body).
Editor (OpenSearchLogQueryEditor.tsx) - datasource picker, index pattern, timestamp/message field overrides, and a PPL textarea.
Trace-to-logs pivot - relies on the existing replaceVariables path, so a $traceId dashboard variable substitutes into the PPL before send. Example dashboard at
opensearch/docs/examples/trace-to-logs.json (Tempo + OpenSearch; Jaeger swap documented).
CUE schema (schemas/queries/opensearch-log-query/query.cue) - mirrors the TS spec including the new optional fields.
Go SDK (sdk/go/query/log) - PluginSpec + TimestampField() / MessageField() options for dashboards-as-code.
Tests - 26 TS tests (PPL bounder, row mapper with overrides + fallbacks, $traceId substitution + dependsOn, PPL client URL/headers/error, editor inputs)
and 2 Go tests (builder JSON shape + omitempty for optional fields).

Screenshots

DataSource

Checklist

Pull request has a descriptive title and context useful to a reviewer.
Pull request title follows the [<catalog_entry>] <commit message> naming convention using one of the
following catalog_entry values: FEATURE, ENHANCEMENT, BUGFIX, BREAKINGCHANGE, DOC,IGNORE.
All commits have DCO signoffs.

UI Changes

Changes that impact the UI include screenshots and/or screencasts of the relevant changes.
Code follows the UI guidelines.

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

@timestamp

The bound was being appended at the end of the user query, which fails once the user pipeline drops @timestamp from the schema (stats, fields, top). Tests now describe the intended ordering. Implementation follows. Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

…cker file Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

…search-plugin chore(plugins): update with remote main branch

ibakshay · 2026-05-11T11:41:34Z

Hi @Oliver-ke,
Great work! 👏
Could you please write down on how one can test this plugin locally?

Oliver-ke · 2026-05-13T07:45:49Z

Hi @Oliver-ke, Great work! 👏 Could you please write down on how one can test this plugin locally?

Sure, I'd share my testing.md file shortly

Oliver-ke · 2026-05-14T03:07:58Z

@ibakshay

TESTING.md

Testing the OpenSearch plugin

Manual QA steps. Verifies datasource, log query, and trace → logs pivot.

Prerequisites

Node 18.17+ (Jest needs os.availableParallelism)
npm
Go 1.21+ (for the SDK tests)
Docker (for local OpenSearch)
Perses dev server running locally (see top-level README.md)
percli on $PATH (built from the perses repo: make build produces bin/percli)

1. Run unit tests

Install once at the workspace root so react/react-dom hoist correctly. Running
npm install inside the plugin directory creates a duplicate React install and
breaks the component tests with Cannot read properties of null (reading 'useState').

cd plugins
npm install
cd opensearch
npm test
npm run type-check
npm run lint

Validate the plugin schemas with percli (built from the perses repo):

cd plugins/opensearch
percli plugin lint
percli plugin test-schemas

Go SDK:

cd plugins/opensearch
go test ./sdk/...

Expect all green. No skipped suites.

2. Start a local OpenSearch

Use the bundled compose file (also boots OpenSearch Dashboards on :5601).
The compose file enables CORS so the Perses UI (running on :3000) can hit
the cluster directly when the datasource uses directUrl. Without these
headers the browser preflight is blocked and queries fail silently with no
status code in the network tab.

cd docs/examples
docker compose up -d
docker compose logs -f opensearch    # watch boot, Ctrl+C once "started" appears

Wait until ready:

curl -s http://localhost:9200/_cluster/health | jq .status

Expect "green" or "yellow".

Teardown when done:

docker compose down -v

3. Seed sample log data

Index two log documents with a shared traceId:

curl -X POST "http://localhost:9200/otel-logs-2026.04.29/_doc" \
  -H 'Content-Type: application/json' -d '{
    "@timestamp": "2026-04-29T10:00:00Z",
    "body": "request received",
    "traceId": "abc123",
    "severity": "INFO"
  }'

curl -X POST "http://localhost:9200/otel-logs-2026.04.29/_doc" \
  -H 'Content-Type: application/json' -d '{
    "@timestamp": "2026-04-29T10:00:01Z",
    "body": "request failed",
    "traceId": "abc123",
    "severity": "ERROR"
  }'

curl -X POST "http://localhost:9200/otel-logs-2026.04.29/_refresh"

Sanity-check PPL endpoint directly:

curl -X POST "http://localhost:9200/_plugins/_ppl" \
  -H 'Content-Type: application/json' \
  -d '{"query":"source=otel-logs-* | where traceId='\''abc123'\''"}'

Expect 2 datarows in response.

4. Build and serve the plugin

cd plugins/opensearch
npm run dev

Dev server listens on http://localhost:3135 (configured in rsbuild.config.ts).
The module-federation manifest is served at http://localhost:3135/mf-manifest.json;
point Perses at that URL when registering the plugin. Keep the dev server running.

5. Register the datasource in Perses

The current Perses UI does not accept raw YAML for datasource creation, so create
the resource one of two ways.

Option A — via the UI form

Navigate to Admin → Global Datasources → Add Datasource. Fill in:

Name: opensearch
Plugin Options → Source: OpenSearch Datasource
Direct URL: http://localhost:9200

Save.

Option B — via `percli` (declarative)

Drop this YAML in a file opensearch-ds.yaml:

kind: GlobalDatasource
metadata:
  name: opensearch
spec:
  default: false
  plugin:
    kind: OpenSearchDatasource
    spec:
      directUrl: http://localhost:9200

Apply it:

percli login http://localhost:8080
percli apply -f opensearch-ds.yaml

Verify

Datasource list shows opensearch with kind OpenSearchDatasource.
Edit form renders without console errors. (Open browser devtools → Console
while clicking through the form. Any red errors here block step 6.)

6. Smoke test the log query editor

Create dashboard, add LogsTable panel, pick OpenSearchLogQuery.

Datasource picker lists opensearch. Select it.
Type query: source=otel-logs-* | where traceId='abc123'.
Hit Apply. Table shows 2 rows. Timestamp + message columns populated.

Edge cases:

Case	Input	Expected
Empty query	``	No request, no error toast
Bad PPL	`source=foo \| invalid`	Error banner with PPL error body (`SyntaxCheckException`)
Wrong index	`source=does-not-exist`	Error banner with `IndexNotFoundException` from OpenSearch (the PPL endpoint returns 404; the plugin surfaces that as an `OpenSearchPPLError`)
Unreachable DS	stop docker, re-run query	Error banner, retry works after restart
Aggregation (stats)	`source=otel-logs-* \| stats count() by service`	Returns one row per service, no error
Field projection	`source=otel-logs-* \| fields service, body \| head 10`	Returns 10 rows with only those two columns

7. Field overrides

Index a doc with non-standard field names:

curl -X POST "http://localhost:9200/legacy-logs/_doc" \
  -H 'Content-Type: application/json' -d '{
    "time": "2026-04-29T10:05:00Z",
    "message": "legacy log line",
    "trace_id": "abc123"
  }'
curl -X POST "http://localhost:9200/legacy-logs/_refresh"

In the query spec, set:

timestampField: time
messageField: message
query: source=legacy-logs | where trace_id='abc123'

Expect row to render with time as timestamp and message as body. Without
the overrides, the row still renders without crashing: missing timestamp falls
back to epoch 0, and missing message falls back to a JSON dump of the row.

8. Trace → logs pivot

Load docs/examples/trace-to-logs.json as a dashboard. Requires a Tempo (or Jaeger) datasource also configured.

Set traceId variable to abc123.
Logs panel re-runs and shows the 2 seeded rows.
Change variable to xyz999. Logs panel goes empty without error.
Swap Tempo panel for Jaeger per docs/examples/README.md. Logs panel unchanged.

9. Cleanup

cd plugins/opensearch/docs/examples
docker compose down -v

horovits · 2026-05-19T06:12:47Z

@ibakshay

TESTING.md

Testing the OpenSearch plugin

Manual QA steps. Verifies datasource, log query, and trace → logs pivot.

Prerequisites

Node 18.17+ (Jest needs os.availableParallelism)

npm

Go 1.21+ (for the SDK tests)

Docker (for local OpenSearch)

Perses dev server running locally (see top-level README.md)

percli on $PATH (built from the perses repo: make build produces bin/percli)

1. Run unit tests

Install once at the workspace root so react/react-dom hoist correctly. Running npm install inside the plugin directory creates a duplicate React install and breaks the component tests with Cannot read properties of null (reading 'useState').
cd plugins
npm install
cd opensearch
npm test
npm run type-check
npm run lint
Validate the plugin schemas with percli (built from the perses repo):
cd plugins/opensearch
percli plugin lint
percli plugin test-schemas
Go SDK:
cd plugins/opensearch
go test ./sdk/...
Expect all green. No skipped suites.

2. Start a local OpenSearch

Use the bundled compose file (also boots OpenSearch Dashboards on :5601). The compose file enables CORS so the Perses UI (running on :3000) can hit the cluster directly when the datasource uses directUrl. Without these headers the browser preflight is blocked and queries fail silently with no status code in the network tab.
cd docs/examples
docker compose up -d
docker compose logs -f opensearch    # watch boot, Ctrl+C once "started" appears
Wait until ready:
curl -s http://localhost:9200/_cluster/health | jq .status
Expect "green" or "yellow".

Teardown when done:
docker compose down -v
3. Seed sample log data

Index two log documents with a shared traceId:
curl -X POST "http://localhost:9200/otel-logs-2026.04.29/_doc" \
  -H 'Content-Type: application/json' -d '{
    "@timestamp": "2026-04-29T10:00:00Z",
    "body": "request received",
    "traceId": "abc123",
    "severity": "INFO"
  }'

curl -X POST "http://localhost:9200/otel-logs-2026.04.29/_doc" \
  -H 'Content-Type: application/json' -d '{
    "@timestamp": "2026-04-29T10:00:01Z",
    "body": "request failed",
    "traceId": "abc123",
    "severity": "ERROR"
  }'

curl -X POST "http://localhost:9200/otel-logs-2026.04.29/_refresh"
Sanity-check PPL endpoint directly:
curl -X POST "http://localhost:9200/_plugins/_ppl" \
  -H 'Content-Type: application/json' \
  -d '{"query":"source=otel-logs-* | where traceId='\''abc123'\''"}'
Expect 2 datarows in response.

4. Build and serve the plugin
cd plugins/opensearch
npm run dev
Dev server listens on http://localhost:3135 (configured in rsbuild.config.ts). The module-federation manifest is served at http://localhost:3135/mf-manifest.json; point Perses at that URL when registering the plugin. Keep the dev server running.

5. Register the datasource in Perses

The current Perses UI does not accept raw YAML for datasource creation, so create the resource one of two ways.

Option A — via the UI form

Navigate to Admin → Global Datasources → Add Datasource. Fill in:

Name: opensearch

Plugin Options → Source: OpenSearch Datasource

Direct URL: http://localhost:9200

Save.

Option B — via percli (declarative)

Drop this YAML in a file opensearch-ds.yaml:
kind: GlobalDatasource
metadata:
  name: opensearch
spec:
  default: false
  plugin:
    kind: OpenSearchDatasource
    spec:
      directUrl: http://localhost:9200
Apply it:
percli login http://localhost:8080
percli apply -f opensearch-ds.yaml
Verify

Datasource list shows opensearch with kind OpenSearchDatasource.

Edit form renders without console errors. (Open browser devtools → Console
while clicking through the form. Any red errors here block step 6.)

6. Smoke test the log query editor

Create dashboard, add LogsTable panel, pick OpenSearchLogQuery.

Datasource picker lists opensearch. Select it.

Type query: source=otel-logs-* | where traceId='abc123'.

Hit Apply. Table shows 2 rows. Timestamp + message columns populated.

Edge cases:

Case Input Expected
Empty query `` No request, no error toast
Bad PPL source=foo | invalid Error banner with PPL error body (`SyntaxCheckException`)
Wrong index `source=does-not-exist` Error banner with `IndexNotFoundException` from OpenSearch (the PPL endpoint returns 404; the plugin surfaces that as an `OpenSearchPPLError`)
Unreachable DS stop docker, re-run query Error banner, retry works after restart
Aggregation (stats) `source=otel-logs-* | stats count() by service` Returns one row per service, no error
Field projection `source=otel-logs-* | fields service, body | head 10` Returns 10 rows with only those two columns

7. Field overrides

Index a doc with non-standard field names:
curl -X POST "http://localhost:9200/legacy-logs/_doc" \
  -H 'Content-Type: application/json' -d '{
    "time": "2026-04-29T10:05:00Z",
    "message": "legacy log line",
    "trace_id": "abc123"
  }'
curl -X POST "http://localhost:9200/legacy-logs/_refresh"
In the query spec, set:
timestampField: time
messageField: message
query: source=legacy-logs | where trace_id='abc123'
Expect row to render with time as timestamp and message as body. Without the overrides, the row still renders without crashing: missing timestamp falls back to epoch 0, and missing message falls back to a JSON dump of the row.

8. Trace → logs pivot

Load docs/examples/trace-to-logs.json as a dashboard. Requires a Tempo (or Jaeger) datasource also configured.

Set traceId variable to abc123.

Logs panel re-runs and shows the 2 seeded rows.

Change variable to xyz999. Logs panel goes empty without error.

Swap Tempo panel for Jaeger per docs/examples/README.md. Logs panel unchanged.

9. Cleanup
cd plugins/opensearch/docs/examples
docker compose down -v

looks like a comprehensive test plan

ibakshay · 2026-05-22T12:43:17Z

Hi @Oliver-ke, first of all great work!

I have tested against a local OpenSearch with the opensearch_dashboards_sample_data_logs sample. I did not review the source-code. I have only tested the functionality and below are my findings.

Bugs/Improvements

With Timestamp field blank, querying opensearch_dashboards_sample_data_logs returns 400: Invalid Query

Screenshot 1

Screenshot 2

Working after I add timestamp in the @timestamp input field

Timestamp field (optional) placeholder @timestamp implies the plugin will fall back gracefully if left blank. it doesn't

Index pattern is silently ignored when PPL Query already contains source=.... Two visible inputs, only one wins, no signal to the user.
The plugin's auto-generated where @timestamp` >= ...` clause is always prepended, even when the user writes their own time bound. No escape hatch.
Run Query with an empty PPL Query is a silent no-op — no request fires, panel just shows No logs to display.
UX
Run Query button is always enabled, even when the form has nothing runnable.

6.. PPL Query field is a plain textarea. It has no syntax highlighting, no autocomplete, no Query Examples disclosure (Please compare ClickHouse query editor in the same panel type).

No way to discover indices or field names from the editor. User must know them in advance.

http://localhost:9200/_cat/indices?v
health status index                                       uuid                   pri rep docs.count docs.deleted store.size pri.store.size
green  open   otel-v1-apm-service-map-sample              Nio8tHEHTWK3uNI4PHmyXA   1   0         49            0     17.7kb         17.7kb
yellow open   otel-logs-2026.04.29                        _3tNZKIVTU2eseJhMHb_cw   1   1          4            0       17kb           17kb
green  open   otel-v1-apm-span-sample                     14q5nFcqQq-OwewznwFAZQ   1   0      13061            0      6.1mb          6.1mb
green  open   .ql-datasources                             KdnzV0EoT96Y1XpY9NfQ7A   1   0          0            0       208b           208b
green  open   top_queries-2026.05.22-84957                hi43N36cRxqNUGtFImwVSg   1   0         16            2    104.1kb        104.1kb
green  open   ss4o_metrics-otel-sample                    2Z4CkH5JTGWQXW6NZgHc7A   1   0      39923            0        4mb            4mb
green  open   .kibana_1                                   uKgkLwTLThyWFoSS5ztn2Q   1   0        246            1    155.6kb        155.6kb
green  open   ss4o_logs-otel-sample                       EkQueqJiQJmMWszbrNRe-Q   1   0      16286            0      5.5mb          5.5mb
green  open   .plugins-ml-config                          QmvGWldgQ_-5TnMuA35KeQ   1   0          1            0        4kb            4kb
green  open   .opensearch-observability                   BqmQfOVnSNaeth8GcjBEkw   1   0          0            0       208b           208b
green  open   opensearch_dashboards_sample_data_logs      OgFiObqIR4GAuT_GPovfFA   1   0      14074            0      7.4mb          7.4mb
green  open   opensearch_dashboards_sample_data_flights   1jp6tGfmSuqBK1YUjKYmNA   1   0      13059            0      5.5mb          5.5mb
green  open   opensearch_dashboards_sample_data_ecommerce dxMt1PfqSP-9-4G5Cd-WbQ   1   0       4675            0      3.9mb          3.9mb

Add second Query on an OpenSearch panel defaults to ClickHouse Log Query

Error banner reads OpenSearch PPL request failed (400): Invalid Query — the actual details field from the response (e.g. can't resolve Symbol(name=@timestamp)) is dropped, removing the important info.
No logs to display is shown for at least four distinct states (empty query, zero hits, missing index, time-range miss). Each wants its own message.
Docs / discoverability
PPL is not introduced anywhere in the editor — no link to OpenSearch PPL syntax docs, no mention that the OpenSearch PPL plugin must be enabled cluster-side for any of this to work.
keyboard shortcut should be using the @tanstack/react-hotkeys like the other plugins.

Oliver-ke · 2026-05-23T02:21:33Z

Hi @Oliver-ke, first of all great work!

I have tested against a local OpenSearch with the opensearch_dashboards_sample_data_logs sample. I did not review the source-code. I have only tested the functionality and below are my findings.

Bugs/Improvements

With Timestamp field blank, querying opensearch_dashboards_sample_data_logs returns 400: Invalid Query

Screenshot 1
#### Screenshot 2 Working after I add `timestamp` in the `@timestamp` input field
Timestamp field (optional) placeholder @timestamp implies the plugin will fall back gracefully if left blank. it doesn't

Index pattern is silently ignored when PPL Query already contains source=.... Two visible inputs, only one wins, no signal to the user.

The plugin's auto-generated where @timestamp >= ... clause is always prepended, even when the user writes their own time bound. No escape hatch.

Run Query with an empty PPL Query is a silent no-op — no request fires, panel just shows No logs to display.
UX

Run Query button is always enabled, even when the form has nothing runnable.

6.. PPL Query field is a plain textarea. It has no syntax highlighting, no autocomplete, no Query Examples disclosure (Please compare ClickHouse query editor in the same panel type).

No way to discover indices or field names from the editor. User must know them in advance.
http://localhost:9200/_cat/indices?v
health status index                                       uuid                   pri rep docs.count docs.deleted store.size pri.store.size
green  open   otel-v1-apm-service-map-sample              Nio8tHEHTWK3uNI4PHmyXA   1   0         49            0     17.7kb         17.7kb
yellow open   otel-logs-2026.04.29                        _3tNZKIVTU2eseJhMHb_cw   1   1          4            0       17kb           17kb
green  open   otel-v1-apm-span-sample                     14q5nFcqQq-OwewznwFAZQ   1   0      13061            0      6.1mb          6.1mb
green  open   .ql-datasources                             KdnzV0EoT96Y1XpY9NfQ7A   1   0          0            0       208b           208b
green  open   top_queries-2026.05.22-84957                hi43N36cRxqNUGtFImwVSg   1   0         16            2    104.1kb        104.1kb
green  open   ss4o_metrics-otel-sample                    2Z4CkH5JTGWQXW6NZgHc7A   1   0      39923            0        4mb            4mb
green  open   .kibana_1                                   uKgkLwTLThyWFoSS5ztn2Q   1   0        246            1    155.6kb        155.6kb
green  open   ss4o_logs-otel-sample                       EkQueqJiQJmMWszbrNRe-Q   1   0      16286            0      5.5mb          5.5mb
green  open   .plugins-ml-config                          QmvGWldgQ_-5TnMuA35KeQ   1   0          1            0        4kb            4kb
green  open   .opensearch-observability                   BqmQfOVnSNaeth8GcjBEkw   1   0          0            0       208b           208b
green  open   opensearch_dashboards_sample_data_logs      OgFiObqIR4GAuT_GPovfFA   1   0      14074            0      7.4mb          7.4mb
green  open   opensearch_dashboards_sample_data_flights   1jp6tGfmSuqBK1YUjKYmNA   1   0      13059            0      5.5mb          5.5mb
green  open   opensearch_dashboards_sample_data_ecommerce dxMt1PfqSP-9-4G5Cd-WbQ   1   0       4675            0      3.9mb          3.9mb
Add second Query on an OpenSearch panel defaults to ClickHouse Log Query

9. Error banner reads OpenSearch PPL request failed (400): Invalid Query — the actual details field from the response (e.g. can't resolve Symbol(name=@timestamp)) is dropped, removing the important info. 10. No logs to display is shown for at least four distinct states (empty query, zero hits, missing index, time-range miss). Each wants its own message. Docs / discoverability 11. PPL is not introduced anywhere in the editor — no link to OpenSearch PPL syntax docs, no mention that the OpenSearch PPL plugin must be enabled cluster-side for any of this to work. 12. keyboard shortcut should be using the `@tanstack/react-hotkeys` like the other plugins.

@ibakshay Thanks for the feedback.
I'd address those and update the PR.

Copilot

Pull request overview

Adds a new OpenSearch plugin module to Perses plugins, including an OpenSearch datasource, a PPL-backed log query plugin, schemas, Go SDK helpers, tests, and trace-to-logs examples.

Changes:

Adds TypeScript OpenSearch datasource/client and log query implementation with time-range PPL bounding, variable replacement, and row-to-log mapping.
Adds CUE schemas, Go SDK builders/options, and unit/schema fixtures for datasource and log query specs.
Adds plugin module packaging/build config plus docs and example dashboards/docker compose.

Reviewed changes

Copilot reviewed 50 out of 53 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`opensearch/package.json`	Defines npm package metadata, scripts, peer deps, and Perses plugin registrations.
`opensearch/README.md`	Documents installation, development, trace-to-logs usage, and field overrides.
`opensearch/rsbuild.config.ts`	Configures module federation exposes and shared dependencies.
`opensearch/jest.config.ts`	Adds Jest configuration for the plugin.
`opensearch/tsconfig.json`	Adds TypeScript config.
`opensearch/tsconfig.build.json`	Adds declaration-build TypeScript config.
`opensearch/go.mod`	Adds Go module for OpenSearch SDK code.
`opensearch/go.sum`	Adds Go dependency checksums.
`opensearch/cue.mod/module.cue`	Adds CUE module metadata.
`opensearch/src/index.ts`	Exports plugin module APIs.
`opensearch/src/index-federation.ts`	Adds federation bootstrap entry.
`opensearch/src/bootstrap.tsx`	Adds empty React bootstrap used by module federation.
`opensearch/src/env.d.ts`	Adds rsbuild type references.
`opensearch/src/getPluginModule.ts`	Builds plugin module metadata from package.json.
`opensearch/src/setup-tests.ts`	Sets up Testing Library and echarts mock.
`opensearch/src/model/index.ts`	Re-exports OpenSearch model utilities.
`opensearch/src/model/opensearch-client.ts`	Implements PPL POST client and typed HTTP error.
`opensearch/src/model/opensearch-client-types.ts`	Defines PPL response/error/header types.
`opensearch/src/model/opensearch-client.test.ts`	Tests PPL client URL, headers, and error behavior.
`opensearch/src/model/opensearch-selectors.ts`	Adds datasource selector helpers.
`opensearch/src/datasources/index.ts`	Re-exports datasource plugin.
`opensearch/src/datasources/opensearch-datasource/index.ts`	Re-exports datasource implementation/types/editor.
`opensearch/src/datasources/opensearch-datasource/OpenSearchDatasource.tsx`	Adds datasource plugin and client factory.
`opensearch/src/datasources/opensearch-datasource/OpenSearchDatasourceEditor.tsx`	Adds HTTP settings editor defaults.
`opensearch/src/datasources/opensearch-datasource/opensearch-datasource-types.ts`	Defines datasource spec.
`opensearch/src/queries/index.ts`	Re-exports query plugin.
`opensearch/src/queries/constants.ts`	Adds datasource and default field constants.
`opensearch/src/queries/query-editor-model.ts`	Adds shared query editor state hook.
`opensearch/src/queries/opensearch-log-query/index.ts`	Re-exports log query implementation.
`opensearch/src/queries/opensearch-log-query/OpenSearchLogQuery.tsx`	Registers log query plugin and dependencies.
`opensearch/src/queries/opensearch-log-query/OpenSearchLogQueryEditor.tsx`	Adds datasource/index/field/query editor UI.
`opensearch/src/queries/opensearch-log-query/OpenSearchLogQueryEditor.test.tsx`	Tests editor rendering and field updates.
`opensearch/src/queries/opensearch-log-query/get-opensearch-log-data.ts`	Adds PPL bounding, execution, and log conversion.
`opensearch/src/queries/opensearch-log-query/get-opensearch-log-data.test.ts`	Tests query execution, variable dependencies, bounding, and row mapping.
`opensearch/src/queries/opensearch-log-query/log-query-plugin-interface.ts`	Adds local log query plugin interface.
`opensearch/src/queries/opensearch-log-query/opensearch-log-query-types.ts`	Defines log query spec/response types.
`opensearch/schemas/datasources/opensearch.cue`	Adds datasource CUE schema.
`opensearch/schemas/datasources/tests/valid/opensearch.json`	Adds valid datasource fixture.
`opensearch/schemas/queries/opensearch-log-query/query.cue`	Adds log query CUE schema.
`opensearch/schemas/queries/opensearch-log-query/tests/valid/basic.json`	Adds valid log query fixture.
`opensearch/schemas/queries/opensearch-log-query/tests/invalid/empty-query.json`	Adds invalid empty query fixture.
`opensearch/schemas/queries/opensearch-log-query/tests/invalid/empty-index.json`	Adds invalid empty index fixture.
`opensearch/schemas/queries/opensearch-log-query/tests/invalid/empty-timestamp-field.json`	Adds invalid empty timestamp field fixture.
`opensearch/schemas/queries/opensearch-log-query/tests/invalid/empty-message-field.json`	Adds invalid empty message field fixture.
`opensearch/sdk/go/datasource/datasource.go`	Adds Go datasource builder/spec.
`opensearch/sdk/go/datasource/options.go`	Adds Go datasource options.
`opensearch/sdk/go/query/log/log.go`	Adds Go log query builder/spec.
`opensearch/sdk/go/query/log/options.go`	Adds Go log query options.
`opensearch/sdk/go/query/log/log_test.go`	Tests Go log query JSON shape and validation.
`opensearch/docs/examples/README.md`	Documents trace-to-logs example and field conventions.
`opensearch/docs/examples/trace-to-logs.json`	Adds example dashboard wiring Tempo traces to OpenSearch logs.
`opensearch/docs/examples/docker-compose.yml`	Adds local OpenSearch example stack.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Nexucis · 2026-05-29T12:49:13Z

@@ -0,0 +1,68 @@
+{
+  "name": "@perses-dev/opensearch-plugin",


Copilot is right. Please add your plugin in the workspace list in the root package.json. Then the CI will be able to build the plugin

+type OpenSearchQueryEditorProps = OptionsEditorProps<OpenSearchLogQuerySpec>;
+
+export function OpenSearchLogQueryEditor(props: OpenSearchQueryEditorProps): ReactElement {


Nexucis · 2026-05-29T12:49:59Z

+    "@perses-dev/components": "^0.53.1",
+    "@perses-dev/core": "^0.53.0",
+    "@perses-dev/dashboards": "^0.53.1",
+    "@perses-dev/explore": "^0.53.1",
+    "@perses-dev/plugin-system": "^0.53.1",


we have indeed updated the various package and remove the usage of the package @perses-dev/core. Please update accordingly your package.json.

before that I would advise to merge the main branch into yours, so you have the latest changes with the up to date package in the repo

Nexucis · 2026-05-29T12:51:29Z

@@ -0,0 +1,4479 @@
+{


this file is not needed. Please remove it and once you have added opensearch in the workspace list, you can run npm install at the root of the repository

Acknowledge, I would make all changes today

Signed-off-by: Kelechi Oliver Azorji <kelechioliver96@gmail.com>

…ins into feature/opensearch-plugin chore: update with remote branch

feat: add opensearch plugin

bc65cad

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

Oliver-ke force-pushed the feature/opensearch-plugin branch from 05cd7bf to bc65cad Compare April 27, 2026 03:24

Oliver-ke mentioned this pull request Apr 27, 2026

Plugin request: OpenSearch perses/perses#2501

Open

Oliver-ke added 6 commits May 10, 2026 05:34

chore: fix test run

f8832da

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

test(opensearch): cover stats/fields/top/no-pipe time-bound shapes

b890fec

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

test(opensearch): cover multi-source, 'search' keyword, ws around =

888bf57

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

fix(opensearch): inject time-bound after source clause

41d5253

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

test(opensearch): complete manuel e2e checks, add cors fix to test do…

496c296

…cker file Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

Oliver-ke force-pushed the feature/opensearch-plugin branch from 0963d7f to 496c296 Compare May 10, 2026 04:35

Oliver-ke added 6 commits May 10, 2026 08:18

fix(opensearch): trim OpenSearchPPLError.message to error.reason

3b8e8cf

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

refactor(opensearch): drop unreachable queryError prop from log editor

c0ea43f

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

fix(opensearch): reject empty index/timestampField/messageField in CUE

dc912a9

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

feat(opensearch): validate empty Query in log query Go SDK

ece7082

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

docs(opensearch): explain parseTimestamp's seconds-vs-ms threshold

46d55e0

Signed-off-by: Azorji Kelechi Oliver <kelechioliver96@gmail.com>

Merge branch 'main' of github.com:Oliver-ke/plugins into feature/open…

49dd80f

…search-plugin chore(plugins): update with remote main branch

Oliver-ke marked this pull request as ready for review May 10, 2026 17:13

Oliver-ke requested review from a team, AntoineThebaud and Nexucis as code owners May 10, 2026 17:13

Oliver-ke requested review from jgbernalp and removed request for a team May 10, 2026 17:13

Merge branch 'main' into feature/opensearch-plugin

09f5607

Nexucis requested a review from Copilot May 29, 2026 12:38

Copilot started reviewing on behalf of Nexucis May 29, 2026 12:38 View session

Copilot AI reviewed May 29, 2026

View reviewed changes

Nexucis reviewed May 29, 2026

View reviewed changes

Oliver-ke added 3 commits May 30, 2026 13:24

Merge branch 'perses:main' into feature/opensearch-plugin

0d25e92

[FEATURE] register opensearch plugin in workspace and align deps

2221e12

Signed-off-by: Kelechi Oliver Azorji <kelechioliver96@gmail.com>

Merge branch 'feature/opensearch-plugin' of github.com:Oliver-ke/plug…

f4f9700

…ins into feature/opensearch-plugin chore: update with remote branch

		type OpenSearchQueryEditorProps = OptionsEditorProps<OpenSearchLogQuerySpec>;

		export function OpenSearchLogQueryEditor(props: OpenSearchQueryEditorProps): ReactElement {

Conversation

Oliver-ke commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Screenshots

Checklist

UI Changes

Uh oh!

ibakshay commented May 11, 2026

Uh oh!

Oliver-ke commented May 13, 2026

Uh oh!

Oliver-ke commented May 14, 2026

Testing the OpenSearch plugin

Prerequisites

1. Run unit tests

2. Start a local OpenSearch

3. Seed sample log data

4. Build and serve the plugin

5. Register the datasource in Perses

Option A — via the UI form

Option B — via percli (declarative)

Verify

6. Smoke test the log query editor

7. Field overrides

8. Trace → logs pivot

9. Cleanup

Uh oh!

horovits commented May 19, 2026

Testing the OpenSearch plugin

Prerequisites

1. Run unit tests

2. Start a local OpenSearch

3. Seed sample log data

4. Build and serve the plugin

5. Register the datasource in Perses

Option A — via the UI form

Option B — via percli (declarative)

Verify

6. Smoke test the log query editor

7. Field overrides

8. Trace → logs pivot

9. Cleanup

Uh oh!

ibakshay commented May 22, 2026

Bugs/Improvements

Screenshot 1

Screenshot 2

Uh oh!

Oliver-ke commented May 23, 2026

Bugs/Improvements

Screenshot 1

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Nexucis May 29, 2026

Choose a reason for hiding this comment

Uh oh!

Nexucis May 29, 2026

Choose a reason for hiding this comment

Uh oh!

Nexucis May 29, 2026

Choose a reason for hiding this comment

Uh oh!

Nexucis May 29, 2026

Choose a reason for hiding this comment

Uh oh!

Oliver-ke May 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

Oliver-ke commented Apr 27, 2026 •

edited

Loading

Option B — via `percli` (declarative)

Option B — via `percli` (declarative)