Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/o19s/user-behavior-insights-elasticsearch

User Behavior Insights (UBI) plugin for Elasticsearch
https://github.com/o19s/user-behavior-insights-elasticsearch

elasticsearch ubi

Last synced: 28 days ago
JSON representation

User Behavior Insights (UBI) plugin for Elasticsearch

Host: GitHub
URL: https://github.com/o19s/user-behavior-insights-elasticsearch
Owner: o19s
License: apache-2.0
Created: 2024-10-07T12:45:41.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-10-09T15:03:02.000Z (3 months ago)
Last Synced: 2024-12-01T11:38:21.872Z (about 1 month ago)
Topics: elasticsearch, ubi
Language: Java
Homepage:
Size: 80.1 KB
Stars: 2
Watchers: 4
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# User Behavior Insights plugin for Elasticsearch

This repository contains a User Behavior Insights (UBI) plugin for Elasticsearch. This plugin facilitates the capture of queries to build a better understanding of user behavior. For capturing client-side events, refer to the [o19s/ubi](https://github.com/o19s/ubi) repository. A complete reference implementation is available in [o19s/chorus-opensearch-edition](https://github.com/o19s/chorus-opensearch-edition/) and the concepts illustrated in that repository can apply to an Elasticsearch deployment as well.

This plugin was adapted from the [UBI plugin for OpenSearch](https://github.com/opensearch-project/user-behavior-insights) but it does differ some. This plugin does not support emitting UBI queries as OTel traces. Additionally, this plugin does not yet contain as comprehensive tests.

Join us on the #user-behavior-insights channel of the [Relevance Slack](https://opensourceconnections.com/community/). Please use GitHub issues for suggesting features and identifying bugs.

For more on UBI and its standard for capturing queries and events, see [o19s/ubi](https://github.com/o19s/ubi).

## Using the Plugin in Elasticsearch

Download a release jar or clone and build the project with `./gradlew build`. This will build a jar file under the `./build` directory. Then install the plugin in Elasticsearch:

```
bin/elasticsearch-plugin install --batch file:/path/to/build/elasticsearch-ubi-1.0.0-SNAPSHOT.zip
```

## Building and Running the Plugin for Development and Testing

```
./gradlew build
docker compose build
docker compose up
```

Create an index:

```
curl -X PUT http://localhost:9200/ecommerce
```

Do a search with UBI (there will be no results since no documents have been indexed):

```
curl http://localhost:9200/ecommerce/_search -H "Content-Type: application/json" -d'
{
"query": {
"match_all": {}
},
"ext": {
"ubi": {}
}
}'
```

In your search response you will see UBI information, including a `query_id` since none was provided in the search request.

```
{
"ext": {
"ubi": {
"query_id": "49140554-b9ae-4f12-825e-81bc73f140a8"
}
},
"hits": {
"total": {
"value": 0,
"relation": "eq"
},
"max_score": null,
"hits": []
}
}
```

Now look at the `ubi_queries` index:

```
curl http://localhost:9200/ubi_queries/_search | jq
```

The query will be captured:

```
{
"took": 1,
"timed_out": false,
"_shards": {
"total": 1,
"successful": 1,
"skipped": 0,
"failed": 0
},
"hits": {
"total": {
"value": 1,
"relation": "eq"
},
"max_score": 1.0,
"hits": [
{
"_index": "ubi_queries",
"_id": "H5IQZ5IBK4HD31_NPnXP",
"_score": 1.0,
"_source": {
"query_response_id": "39a29e90-324e-43f5-b449-7f79aee3fde7",
"user_query": "",
"query_id": "49140554-b9ae-4f12-825e-81bc73f140a8",
"query_response_object_ids": [],
"query": "{\"query\":{\"match_all\":{\"boost\":1.0}},\"ext\":{\"query_id\":\"49140554-b9ae-4f12-825e-81bc73f140a8\",\"user_query\":null,\"client_id\":null,\"object_id_field\":null,\"query_attributes\":{}}}",
"query_attributes": {},
"client_id": "",
"timestamp": 1728305970620
}
}
]
}
}
```

Had there been documents indexed and matched the query, the IDs of the documents would have been returned in the `query_response_object_ids` field.