You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,12 +11,14 @@ UBI and this plugin project was originally proposed in the [OpenSearch UBI RFC](
11
11
Please note that this repository is the implementation of the UBI plugin for OpenSearch.
12
12
13
13
> [!IMPORTANT]
14
-
> This release targets to the 1.0.0 version of the UBI Specification.
14
+
> This release targets to the 1.3.0 version of the UBI Specification.
15
15
16
16
For details on the JSON Schema used by UBI to send and receive queries and events please see the [UBI](https://github.com/o19s/ubi) repository and the links below.
Visit [https://ubisearch.dev](https://ubisearch.dev) to learn more about UBI.
20
22
21
23
## UBI, Data Prepper, and Open Telemetry
22
24
@@ -34,7 +36,7 @@ The UBI plugin can store UBI query data in one of three ways:
34
36
35
37
## Useful Commands
36
38
37
-
The `scripts/` directory contains example UBI requests for common use cases.
39
+
The `src/test/scripts/` directory contains example UBI requests for common use cases.
38
40
39
41
## User Quick Start
40
42
@@ -43,7 +45,7 @@ The `scripts/` directory contains example UBI requests for common use cases.
43
45
To get started, download the plugin zip file from the [releases](https://github.com/opensearch-project/user-behavior-insights/releases). Next, install the plugin into OpenSearch with the following command:
You will be prompted while installing the plugin because the plugin defines additional security permissions. These permissions allow the plugin to serialize query requests to JSON for storing and to allow the plugin to send query requests to Data Prepper. You can skip the prompt by adding the `--batch` argument to the above command.
0 commit comments