OpenSearch plugin - initial commit by richbenwell · Pull Request #27 · squaredup/plugins

richbenwell · 2026-02-11T03:20:14Z

🔌 Plugin overview

Plugin name: OpenSearch
Purpose / problem solved: Query data from OpenSearch databases
Primary audience (e.g. platform teams, SREs, product teams): Platform/SRE
Authentication method(s) (e.g. OAuth, Username/Password, API Key): Username/Password

🖼️ Plugin screenshots

Plugin configuration

Default dashboards

No default dashboards

🧪 Testing

Tested against a deployment of OpenSearch environment for OpenTelemetry logging.

⚠️ Known limitations

Currently only supports 'cloud' connection mode, not 'hybrid'
Support for 'raw' Query DSL JSON only.

📚 Checklist

Plugin, datastream and UI naming follow SquaredUp guidelines
Logo added
[N/A] One or more dashboards added
README added including configuration guidance
No secrets or credentials included
I agree to the Code of Conduct

Copilot

Pull request overview

Adds an initial community plugin for querying OpenSearch, built on the WebAPI base plugin, with UI configuration plus search/index data streams.

Changes:

Introduces OpenSearch plugin metadata, configuration UI, and icon.
Adds data streams for listing indices and performing _search, including a post-processing script.
Adds initial documentation content for setup/usage.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
plugins/OpenSearch/v1/ui.json	Adds data source configuration fields (instance URL, auth mode, basic creds, TLS ignore).
plugins/OpenSearch/v1/metadata.json	Declares plugin metadata and WebAPI base configuration.
plugins/OpenSearch/v1/icon.svg	Adds plugin icon asset.
plugins/OpenSearch/v1/docs/setup.md	Adds setup guidance content (currently not in the standard docs location).
plugins/OpenSearch/v1/dataStreams/search.json	Adds `_search` data stream with index selection + JSON query body.
plugins/OpenSearch/v1/dataStreams/scripts/search.js	Adds response shaping for aggregations vs hits.
plugins/OpenSearch/v1/dataStreams/indices.json	Adds hidden indices data stream used for index autocomplete.
plugins/OpenSearch/v1/README.md	Adds a short top-level README (not in the standard embedded docs path).

plugins/OpenSearch/v1/ui.json

plugins/OpenSearch/v1/metadata.json

plugins/OpenSearch/v1/docs/setup.md

plugins/OpenSearch/v1/dataStreams/indices.json

Copilot · 2026-02-11T03:25:29Z

plugins/OpenSearch/v1/dataStreams/search.json

+    "name": "search",
+    "displayName": "Search",
+    "baseDataSourceName": "httpRequestUnscoped",


Data stream displayName should be noun-based per repo guidelines; Search reads as a verb/action. Consider renaming to something like "Search results"/"Results" (whatever best matches the returned shape).

plugins/OpenSearch/v1/dataStreams/scripts/search.js

plugins/OpenSearch/v1/ui.json

Copilot · 2026-02-11T03:25:30Z

plugins/OpenSearch/v1/metadata.json

+    "author": {
+        "name": "SquaredUp Labs",
+        "type": "labs"
+    },


author.type is set to "labs", but repository guidance and existing plugins use "community" for community-authored plugins. Please update author.type to community and set author.name to a GitHub username (e.g. @username) or an organisation name.

Copilot · 2026-02-11T03:25:30Z

plugins/OpenSearch/v1/README.md

+## Overview
+
+Query OpenSearch databases using DSL. This plugin is primarily a wrapper around the `_search` API endpoint that allows for a range of queries.


This plugin adds a top-level README.md, but other plugins typically provide end-user help in docs/README.md (and metadata links point there). Consider moving this content into docs/README.md; also avoid starting with an "Overview" heading per repo doc guidance for embedded help.

Suggested change

## Overview

Query OpenSearch databases using DSL. This plugin is primarily a wrapper around the `_search` API endpoint that allows for a range of queries.

# Before you start

Refer to `docs/README.md` in this plugin folder for full setup and usage instructions for the OpenSearch plugin.

Copilot

Pull request overview

Copilot reviewed 7 out of 8 changed files in this pull request and generated 7 comments.

plugins/OpenSearch/v1/dataStreams/indices.json

plugins/OpenSearch/v1/dataStreams/search.json

Copilot · 2026-02-12T01:41:12Z

plugins/OpenSearch/v1/dataStreams/scripts/search.js

@@ -0,0 +1,32 @@
+if (data.aggregations && data.aggregations.length > 0) {


data.aggregations in OpenSearch responses is an object, not an array, so data.aggregations.length > 0 will always be false and aggregation results will never be returned. Use Object.keys(data.aggregations).length (or similar) to detect/handle aggregations before selecting the last aggregation.

Suggested change

if (data.aggregations && data.aggregations.length > 0) {

if (data.aggregations && Object.keys(data.aggregations).length > 0) {

Copilot · 2026-02-12T01:41:12Z

plugins/OpenSearch/v1/docs/setup.md

+# Configuration
+
+## Instance URL


Docs are provided as docs/setup.md, but the repo convention (and in-product rendering) is docs/README.md. Also, the top heading here is # Configuration, whereas other plugins start with task-focused headings like # Before you start (e.g. plugins/UniFi/v1/docs/README.md:1). Please rename to docs/README.md and align the heading structure so setup guidance is what users see in SquaredUp.

Copilot · 2026-02-12T01:41:13Z

plugins/OpenSearch/v1/README.md

+## Overview
+
+Query OpenSearch databases using DSL. This plugin is primarily a wrapper around the `_search` API endpoint that allows for a range of queries.
+
+See the [OpenSearch API docs](https://docs.opensearch.org/latest/api-reference/search-apis/search/) for more information.
+


This file is named README.md under the plugin version folder, but other plugins keep end-user setup docs under docs/README.md and don’t include a top-level README.md. Additionally, the PR description/checklist says the README includes configuration guidance, but this file is only an overview. Consider moving/merging this content into docs/README.md so users can find both overview + configuration in one place.

Copilot · 2026-02-12T01:41:13Z

plugins/OpenSearch/v1/metadata.json

+    "links": [
+        {
+            "category": "documentation",
+            "url": "https://github.com/squaredup/plugins/blob/main/plugins/OpenSearch/v1/docs/setup.md",
+            "label": "Help adding this plugin"


The documentation link points to docs/setup.md, but other plugins consistently link category: documentation to docs/README.md (e.g. plugins/UniFi/v1/metadata.json:31-35). SquaredUp also only renders docs/README.md in-product, so this should be renamed/moved to docs/README.md and the URL updated accordingly.

Copilot · 2026-02-12T01:41:13Z

plugins/OpenSearch/v1/metadata.json

+{
+    "name": "open-search",
+    "displayName": "OpenSearch",
+    "version": "1.0.3",


Consider adding an explicit CODEOWNERS entry for this new plugin so future changes request review from the plugin author (see .github/CODEOWNERS, which lists each existing plugin).

Suggested change

"version": "1.0.3",

"version": "1.0.4",

Copilot

Pull request overview

Copilot reviewed 7 out of 8 changed files in this pull request and generated 9 comments.

Copilot · 2026-02-13T18:35:01Z

plugins/OpenSearch/v1/ui.json

+        "name": "instanceUrl",
+        "label": "Instance URL",
+        "validation": { "required": true },
+        "placeholder": "Enter the OpenSearch URL"


According to the custom guidelines, ui.json placeholders should use example values where a value follows a fixed pattern. For a URL field, consider providing a more specific example placeholder that shows the expected format, such as "https://your-opensearch-host:9200" instead of the generic instruction "Enter the OpenSearch URL".

Copilot · 2026-02-13T18:35:02Z

plugins/OpenSearch/v1/dataStreams/scripts/search.js

+  result = data.hits.hits.map(hit => hit._source);
+


The script assumes that when there are no aggregations, data.hits.hits will always exist and have a _source property. However, if the OpenSearch query fails or returns an unexpected structure, this could cause a runtime error. Consider adding defensive checks to handle cases where data.hits or data.hits.hits might be undefined, or where individual hits might not have a _source property.

Suggested change

result = data.hits.hits.map(hit => hit._source);

const hits = data && data.hits && Array.isArray(data.hits.hits) ? data.hits.hits : [];

result = hits

.filter(hit => hit && Object.prototype.hasOwnProperty.call(hit, '_source'))

.map(hit => hit._source);

Copilot · 2026-02-13T18:35:02Z

plugins/OpenSearch/v1/ui.json

+    {
+        "name": "authMode",
+        "type": "radio",
+        "label": "Authentication",
+        "help": "**Basic:** Authenticate with username and password.  \n**Anonymous access:** No authentication required",
+        "defaultValue": "basic",
+        "validation": {
+            "required": true
+        },
+        "options": [
+            {
+                "label": "Basic",
+                "value": "basic"
+            },
+            {
+                "label": "Anonymous access",
+                "value": "none"
+            }
+
+        ]
+    },


According to the custom guidelines, API tokens or OAuth are preferred over username/password authentication where possible. OpenSearch supports API key authentication as an alternative to basic authentication. Consider adding support for API key authentication to provide a more secure authentication option. If basic authentication is the only viable option for your use case, this is acceptable, but API keys would be preferred.

Copilot · 2026-02-13T18:35:02Z

plugins/OpenSearch/v1/metadata.json

+    "author": {
+        "name": "SquaredUp Labs",
+        "type": "labs"
+    },


According to the custom guidelines, for community-authored plugins, the author type should be set to "community" and the name should typically be a GitHub username prefixed with @ (e.g., "@username") or an organization name. The PR description indicates this is a community contribution, but the metadata shows "SquaredUp Labs" with type "labs". Please update to reflect the actual community author, for example:

"author": { "name": "@yourusername", "type": "community" }

Copilot · 2026-02-13T18:35:02Z

plugins/OpenSearch/v1/dataStreams/search.json

+    "name": "search",
+    "displayName": "Search",


According to the custom guidelines, dataStreams should have a description field that is typically one sentence only with no full stop at the end. Consider adding a description to this data stream, such as "Query OpenSearch indices using DSL syntax" to help users understand what this data stream does.

Copilot · 2026-02-13T18:35:03Z

plugins/OpenSearch/v1/metadata.json

+        "name": "SquaredUp Labs",
+        "type": "labs"
+    },
+    "description": "Query OpenSearch databases using DSL.",


According to the custom guidelines, the description should focus on what users can build or monitor, avoiding API or implementation language. The current description "Query OpenSearch databases using DSL" is quite technical. Consider rephrasing to something more user-focused, such as "Monitor and analyze data from OpenSearch databases." to better describe what users can achieve with this plugin.

Copilot · 2026-02-13T18:35:03Z

plugins/OpenSearch/v1/dataStreams/search.json

+            "size": 100
+            },
+          "label": "Query body",
+          "help": "The Query DSL JSON. See [OpenSearch API docs](https://docs.opensearch.org/latest/api-reference/search-apis/search/#request-body).",


According to the custom guidelines, help text should "Start with a verb where possible". The current help text "The Query DSL JSON. See [OpenSearch API docs]..." starts with "The" rather than a verb. Consider rephrasing to start with a verb, such as "Specify the Query DSL JSON. See [OpenSearch API docs]..." or "Enter the Query DSL JSON. See [OpenSearch API docs]..." to follow the guideline more closely.

Copilot · 2026-02-13T18:35:03Z

plugins/OpenSearch/v1/ui.json

+        "name": "authMode",
+        "type": "radio",
+        "label": "Authentication",
+        "help": "**Basic:** Authenticate with username and password.  \n**Anonymous access:** No authentication required",


According to the custom guidelines, help text should "Start with a verb where possible". The current help text describes the authentication modes but doesn't start with a verb. Consider rephrasing to start with a verb, such as "Choose Basic to authenticate with username and password, or Anonymous access when no authentication is required." However, given the multi-option format with markdown bold formatting, the current structure may be acceptable for clarity.

Copilot · 2026-02-13T18:35:03Z

plugins/OpenSearch/v1/ui.json

+    {
+        "type": "text",
+        "name": "instanceUrl",
+        "label": "Instance URL",


According to the custom guidelines, for ui.json fields, labels should follow the pattern "First word uppercase, then lowercase" (e.g., "Table name" or "API key"). The current label "Instance URL" has both words capitalized. Consider changing it to "Instance url" to align with the guidelines, though "URL" is commonly capitalized as an acronym. If keeping "URL" capitalized, this should be consistent with other similar fields in the codebase.

richbenwell added 4 commits February 8, 2026 22:11

OpenSearch plugin - initial commit

291b28e

Fix fieldGroup visibility

1fe09dc

Fix authMode default

c60b132

Use visibility field instead of noMatch and add docs

9fb7911

Copilot AI review requested due to automatic review settings February 11, 2026 03:20

Copilot started reviewing on behalf of richbenwell February 11, 2026 03:20 View session

Copilot AI reviewed Feb 11, 2026

View reviewed changes

richbenwell added 2 commits February 11, 2026 16:26

Address Copilot PR review comments

b9cd25c

Remove trailing comma

e080067

Copilot AI review requested due to automatic review settings February 12, 2026 01:35

Copilot started reviewing on behalf of richbenwell February 12, 2026 01:36 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

richbenwell added 2 commits February 13, 2026 13:28

Fix length check

2efb9c2

Remove whitespace

303e981

Copilot AI review requested due to automatic review settings February 13, 2026 18:30

Copilot started reviewing on behalf of richbenwell February 13, 2026 18:30 View session

Copilot AI reviewed Feb 13, 2026

View reviewed changes

		## Overview

		Query OpenSearch databases using DSL. This plugin is primarily a wrapper around the `_search` API endpoint that allows for a range of queries.

		@@ -0,0 +1,32 @@
		if (data.aggregations && data.aggregations.length > 0) {

	if (data.aggregations && data.aggregations.length > 0) {
	if (data.aggregations && Object.keys(data.aggregations).length > 0) {

-  result = data.hits.hits.map(hit => hit._source);
+  const hits = data && data.hits && Array.isArray(data.hits.hits) ? data.hits.hits : [];
+  result = hits
+    .filter(hit => hit && Object.prototype.hasOwnProperty.call(hit, '_source'))
+    .map(hit => hit._source);

Conversation

richbenwell commented Feb 11, 2026

🔌 Plugin overview

🖼️ Plugin screenshots

Plugin configuration

Default dashboards

No default dashboards

🧪 Testing

⚠️ Known limitations

📚 Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment