Skip to content

Commit

Permalink
opensearch-project#20 Updating readme for ways to send query data to …
Browse files Browse the repository at this point in the history
…OpenSearch.

Signed-off-by: jzonthemtn <[email protected]>
  • Loading branch information
jzonthemtn committed Sep 30, 2024
1 parent ded5c73 commit 2b61f58
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ For details on the JSON Schema used by UBI to send and receive queries and event

## UBI, Data Prepper, and Open Telemetry

The UBI plugin can store UBI query data in one of two ways:
The UBI plugin can store UBI query data in one of three ways:

- By directly indexing the UBI query data in the `ubi_queries` index in the same OpenSearch cluster as the plugin.
- By sending the UBI query data as JSON to a Data Prepper [http](https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/sources/http/) source. The Data Prepper endpoint is provided via the `ubi.dataprepper.url` setting.
- By sending the UBI query data as Open Telemetry traces. This utilizes the native OpenSearch OTel capabilities which are exposed via the `TelemetryAwarePlugin` interface. As UBI queries are received, trace events will be generated. OpenSearch must be configured as described in [Distributed tracing](https://opensearch.org/docs/latest/observing-your-data/trace/distributed-tracing/) for the events to be sent.

Expand Down

0 comments on commit 2b61f58

Please sign in to comment.