Merge pull request #64 from o19s/rename

Renaming to UBI
o19s · Feb 26, 2024 · 645ef7e · 645ef7e
2 parents 16262e0 + f1c6adb
commit 645ef7e
Show file tree

Hide file tree

Showing 23 changed files with 100 additions and 80 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 FROM opensearchproject/opensearch:2.11.1
 
-COPY ./build/distributions/opensearch-ubl.zip /tmp/
+COPY ./build/distributions/opensearch-ubi.zip /tmp/
 
-RUN /usr/share/opensearch/bin/opensearch-plugin install file:/tmp/opensearch-ubl.zip
+RUN /usr/share/opensearch/bin/opensearch-plugin install file:/tmp/opensearch-ubi.zip
diff --git a/README.md b/README.md
@@ -1,6 +1,4 @@
-# OpenSearch User Behavior Logging
-
-This project is getting a new name! See the voting - https://forum.opensearch.org/t/vote-user-behavior-logging-and-insights/17838
+# OpenSearch User Behavior Insights
 
 OpenSearch RFC - https://github.com/opensearch-project/OpenSearch/issues/12084
 
@@ -23,13 +21,13 @@ Start the containers:
 Initialize the `awesome` UBL store:
 
 ```
-curl -X PUT http://localhost:9200/_plugins/ubl/awesome
+curl -X PUT http://localhost:9200/_plugins/ubi/awesome
 ```
 
 Send an event to the `awesome` store:
 
 ```
-curl -X POST http://localhost:9200/_plugins/ubl/awesome -H "Content-Type: application/json" -d @./scripts/instant-search.json
+curl -X POST http://localhost:9200/_plugins/ubi/awesome -H "Content-Type: application/json" -d @./scripts/instant-search.json
 ```
 
 Get events:
@@ -51,5 +49,5 @@ curl -s http://localhost:9200/.awesome_queries/_search -H "X-ubi-store: awesome"
 Delete the store:
 
 ```
-curl -X DELETE http://localhost:9200/_plugins/ubl/awesome
+curl -X DELETE http://localhost:9200/_plugins/ubi/awesome
 ```
diff --git a/build.gradle b/build.gradle
@@ -5,9 +5,9 @@ apply plugin: 'opensearch.yaml-rest-test'
 apply plugin: 'maven-publish'
 
 opensearchplugin {
-    name 'opensearch-ubl'
-    description 'OpenSearch User Behavior Logging Plugin'
-    classname 'org.opensearch.ubl.UserBehaviorLoggingPlugin'
+    name 'opensearch-ubi'
+    description 'OpenSearch User Behavior Insights Plugin'
+    classname 'org.opensearch.ubi.UserBehaviorInsightsPlugin'
     licenseFile rootProject.file('LICENSE.txt')
     noticeFile rootProject.file('NOTICE.txt')
 }
@@ -44,7 +44,7 @@ publishing {
     repositories {
         maven {
             name = "GitHubPackages"
-            url = uri("https://maven.pkg.github.com/o19s/opensearch-ubl")
+            url = uri("https://maven.pkg.github.com/o19s/opensearch-ubi")
             credentials {
                 username = System.getenv("GITHUB_ACTOR")
                 password = System.getenv("GITHUB_TOKEN")
@@ -54,8 +54,8 @@ publishing {
     publications {
         pluginZip(MavenPublication) { publication ->
             pom {
-                name = "opensearch-ubl"
-                description = "Provides User Behavior Logging for OpenSearch"
+                name = "opensearch-ubi"
+                description = "Provides User Behavior Insights for OpenSearch"
                 groupId = "org.opensearch"
                 licenses {
                     license {
@@ -66,7 +66,7 @@ publishing {
                 developers {
                     developer {
                         name = "OpenSearch"
-                        url = "https://github.com/o19s/opensearch-ubl"
+                        url = "https://github.com/o19s/opensearch-ubi"
                     }
                 }
             }

diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -16,7 +16,7 @@ services:
       http.cors.allow-methods: OPTIONS,HEAD,GET,POST,PUT,DELETE
       http.cors.allow-credentials: true
       http.cors.allow-headers: X-Requested-With,X-Auth-Token,Content-Type,Content-Length,Authorization
-      plugins.ubl.indices: "awesome"
+      plugins.ubi.indices: "awesome"
       logger.level: info
     ulimits:
       memlock:

diff --git a/settings.gradle b/settings.gradle
@@ -7,4 +7,4 @@
  * in the user manual at https://docs.gradle.org/6.5.1/userguide/multi_project_builds.html
  */
 
-rootProject.name = 'user-behavior-logging-plugin'
+rootProject.name = 'user-behavior-insights-plugin'
diff --git a/...a/org/opensearch/ubl/HeaderConstants.java → ...a/org/opensearch/ubi/HeaderConstants.java b/...a/org/opensearch/ubl/HeaderConstants.java → ...a/org/opensearch/ubi/HeaderConstants.java
@@ -6,14 +6,14 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl;
+package org.opensearch.ubi;
 
 public enum HeaderConstants {
 
-    QUERY_ID_HEADER("X-ubl-query-id"),
-    EVENT_STORE_HEADER("X-ubl-store"),
-    USER_ID_HEADER("X-ubl-user-id"),
-    SESSION_ID_HEADER("X-ubl-session-id");
+    QUERY_ID_HEADER("X-ubi-query-id"),
+    EVENT_STORE_HEADER("X-ubi-store"),
+    USER_ID_HEADER("X-ubi-user-id"),
+    SESSION_ID_HEADER("X-ubi-session-id");
 
     private final String header;
 

diff --git a/...org/opensearch/ubl/SettingsConstants.java → ...org/opensearch/ubi/SettingsConstants.java b/...org/opensearch/ubl/SettingsConstants.java → ...org/opensearch/ubi/SettingsConstants.java
@@ -6,11 +6,11 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl;
+package org.opensearch.ubi;
 
 public class SettingsConstants {
 
-    public static final String INDEX_NAMES = "plugins.ubl.indices";
-    public static final String VERSION_SETTING = "index.ublstore.version";
+    public static final String INDEX_NAMES = "plugins.ubi.indices";
+    public static final String VERSION_SETTING = "index.ubistore.version";
 
 }
diff --git a/...search/ubl/UserBehaviorLoggingPlugin.java → ...earch/ubi/UserBehaviorInsightsPlugin.java b/...search/ubl/UserBehaviorLoggingPlugin.java → ...earch/ubi/UserBehaviorInsightsPlugin.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl;
+package org.opensearch.ubi;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -28,11 +28,11 @@
 import org.opensearch.rest.RestHeaderDefinition;
 import org.opensearch.script.ScriptService;
 import org.opensearch.threadpool.ThreadPool;
-import org.opensearch.ubl.action.UserBehaviorLoggingActionFilter;
-import org.opensearch.ubl.action.UserBehaviorLoggingRestHandler;
-import org.opensearch.ubl.backends.Backend;
-import org.opensearch.ubl.backends.OpenSearchBackend;
-import org.opensearch.ubl.events.OpenSearchEventManager;
+import org.opensearch.ubi.action.UserBehaviorInsightsActionFilter;
+import org.opensearch.ubi.action.UserBehaviorInsightsRestHandler;
+import org.opensearch.ubi.backends.Backend;
+import org.opensearch.ubi.backends.OpenSearchBackend;
+import org.opensearch.ubi.events.OpenSearchEventManager;
 import org.opensearch.watcher.ResourceWatcherService;
 
 import java.util.ArrayList;
@@ -44,9 +44,9 @@
 
 import static java.util.Collections.singletonList;
 
-public class UserBehaviorLoggingPlugin extends Plugin implements ActionPlugin {
+public class UserBehaviorInsightsPlugin extends Plugin implements ActionPlugin {
 
-    private static final Logger LOGGER = LogManager.getLogger(UserBehaviorLoggingPlugin.class);
+    private static final Logger LOGGER = LogManager.getLogger(UserBehaviorInsightsPlugin.class);
 
     private Backend backend;
     private ActionFilter userBehaviorLoggingFilter;
@@ -80,7 +80,7 @@ public List<RestHandler> getRestHandlers(final Settings settings,
                                              final IndexNameExpressionResolver indexNameExpressionResolver,
                                              final Supplier<DiscoveryNodes> nodesInCluster) {
 
-        return singletonList(new UserBehaviorLoggingRestHandler(backend));
+        return singletonList(new UserBehaviorInsightsRestHandler(backend));
 
     }
 
@@ -119,7 +119,7 @@ public Collection<Object> createComponents(
     ) {
 
         this.backend = new OpenSearchBackend(client);
-        this.userBehaviorLoggingFilter =  new UserBehaviorLoggingActionFilter(backend, environment.settings(), threadPool);
+        this.userBehaviorLoggingFilter =  new UserBehaviorInsightsActionFilter(backend, environment.settings(), threadPool);
 
         LOGGER.info("Creating scheduled task");
 

diff --git a/...tion/UserBehaviorLoggingActionFilter.java → ...ion/UserBehaviorInsightsActionFilter.java b/...tion/UserBehaviorLoggingActionFilter.java → ...ion/UserBehaviorInsightsActionFilter.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl.action;
+package org.opensearch.ubi.action;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -20,24 +20,24 @@
 import org.opensearch.core.action.ActionResponse;
 import org.opensearch.tasks.Task;
 import org.opensearch.threadpool.ThreadPool;
-import org.opensearch.ubl.HeaderConstants;
-import org.opensearch.ubl.backends.Backend;
-import org.opensearch.ubl.model.QueryRequest;
-import org.opensearch.ubl.model.QueryResponse;
+import org.opensearch.ubi.HeaderConstants;
+import org.opensearch.ubi.backends.Backend;
+import org.opensearch.ubi.model.QueryRequest;
+import org.opensearch.ubi.model.QueryResponse;
 
 import java.util.LinkedList;
 import java.util.List;
 import java.util.UUID;
 
-public class UserBehaviorLoggingActionFilter implements ActionFilter {
+public class UserBehaviorInsightsActionFilter implements ActionFilter {
 
-    private static final Logger LOGGER = LogManager.getLogger(UserBehaviorLoggingActionFilter.class);
+    private static final Logger LOGGER = LogManager.getLogger(UserBehaviorInsightsActionFilter.class);
 
     private final Backend backend;
     private final Settings settings;
     private final ThreadPool threadPool;
 
-    public UserBehaviorLoggingActionFilter(final Backend backend, final Settings settings, ThreadPool threadPool) {
+    public UserBehaviorInsightsActionFilter(final Backend backend, final Settings settings, ThreadPool threadPool) {
         this.backend = backend;
         this.settings = settings;
         this.threadPool = threadPool;
@@ -111,7 +111,7 @@ public void onResponse(Response response) {
                     //}
 
                     final long elapsedTime = System.currentTimeMillis() - startTime;
-                    LOGGER.info("UBL search request filter took {} ms", elapsedTime);
+                    LOGGER.info("UBI search request filter took {} ms", elapsedTime);
 
                 }
 

diff --git a/...ction/UserBehaviorLoggingRestHandler.java → ...tion/UserBehaviorInsightsRestHandler.java b/...ction/UserBehaviorLoggingRestHandler.java → ...tion/UserBehaviorInsightsRestHandler.java
@@ -6,34 +6,30 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl.action;
+package org.opensearch.ubi.action;
 
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.opensearch.action.admin.indices.create.CreateIndexRequest;
-import org.opensearch.action.admin.indices.delete.DeleteIndexRequest;
-import org.opensearch.action.admin.indices.exists.indices.IndicesExistsRequest;
 import org.opensearch.client.node.NodeClient;
 import org.opensearch.core.rest.RestStatus;
-import org.opensearch.rest.action.RestToXContentListener;
-import org.opensearch.ubl.backends.Backend;
 import org.opensearch.rest.BaseRestHandler;
 import org.opensearch.rest.BytesRestResponse;
 import org.opensearch.rest.RestRequest;
+import org.opensearch.ubi.backends.Backend;
 
 import java.util.List;
 import java.util.Set;
 
 import static org.opensearch.rest.RestRequest.Method.*;
 
-public class UserBehaviorLoggingRestHandler extends BaseRestHandler {
+public class UserBehaviorInsightsRestHandler extends BaseRestHandler {
 
-    private static final Logger LOGGER = LogManager.getLogger(UserBehaviorLoggingRestHandler.class);
+    private static final Logger LOGGER = LogManager.getLogger(UserBehaviorInsightsRestHandler.class);
 
     private final Backend backend;
 
-    public UserBehaviorLoggingRestHandler(final Backend backend) {
+    public UserBehaviorInsightsRestHandler(final Backend backend) {
         this.backend = backend;
     }
 
@@ -45,10 +41,10 @@ public String getName() {
     @Override
     public List<Route> routes() {
         return List.of(
-                new Route(PUT, "/_plugins/ubl/{store}"), // Initializes the store.
-                new Route(DELETE, "/_plugins/ubl/{store}"), // Deletes a store.
-                new Route(GET, "/_plugins/ubl"), // Lists all stores
-                new Route(POST, "/_plugins/ubl/{store}")); // Indexes events into the store.
+                new Route(PUT, "/_plugins/ubi/{store}"), // Initializes the store.
+                new Route(DELETE, "/_plugins/ubi/{store}"), // Deletes a store.
+                new Route(GET, "/_plugins/ubi"), // Lists all stores
+                new Route(POST, "/_plugins/ubi/{store}")); // Indexes events into the store.
     }
 
     @Override

diff --git a/.../org/opensearch/ubl/backends/Backend.java → .../org/opensearch/ubi/backends/Backend.java b/.../org/opensearch/ubl/backends/Backend.java → .../org/opensearch/ubi/backends/Backend.java
@@ -6,12 +6,11 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl.backends;
+package org.opensearch.ubi.backends;
 
-import org.opensearch.ubl.model.QueryRequest;
-import org.opensearch.ubl.model.QueryResponse;
+import org.opensearch.ubi.model.QueryRequest;
+import org.opensearch.ubi.model.QueryResponse;
 
-import java.nio.channels.Channel;
 import java.util.Set;
 
 public interface Backend {

diff --git a/...earch/ubl/backends/OpenSearchBackend.java → ...earch/ubi/backends/OpenSearchBackend.java b/...earch/ubl/backends/OpenSearchBackend.java → ...earch/ubi/backends/OpenSearchBackend.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl.backends;
+package org.opensearch.ubi.backends;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -20,11 +20,11 @@
 import org.opensearch.common.settings.Settings;
 import org.opensearch.common.util.io.Streams;
 import org.opensearch.common.xcontent.XContentType;
-import org.opensearch.ubl.SettingsConstants;
-import org.opensearch.ubl.events.Event;
-import org.opensearch.ubl.events.OpenSearchEventManager;
-import org.opensearch.ubl.model.QueryRequest;
-import org.opensearch.ubl.model.QueryResponse;
+import org.opensearch.ubi.SettingsConstants;
+import org.opensearch.ubi.events.Event;
+import org.opensearch.ubi.events.OpenSearchEventManager;
+import org.opensearch.ubi.model.QueryRequest;
+import org.opensearch.ubi.model.QueryResponse;
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;

diff --git a/...arch/ubl/events/AbstractEventManager.java → ...arch/ubi/events/AbstractEventManager.java b/...arch/ubl/events/AbstractEventManager.java → ...arch/ubi/events/AbstractEventManager.java
@@ -6,13 +6,12 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl.events;
+package org.opensearch.ubi.events;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.opensearch.action.index.IndexRequest;
-import org.opensearch.ubl.events.queues.EventQueue;
-import org.opensearch.ubl.events.queues.InternalQueue;
+import org.opensearch.ubi.events.queues.EventQueue;
+import org.opensearch.ubi.events.queues.InternalQueue;
 
 public abstract class AbstractEventManager {
 

diff --git a/...java/org/opensearch/ubl/events/Event.java → ...java/org/opensearch/ubi/events/Event.java b/...java/org/opensearch/ubl/events/Event.java → ...java/org/opensearch/ubi/events/Event.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl.events;
+package org.opensearch.ubi.events;
 
 public class Event {
 

diff --git a/...ch/ubl/events/OpenSearchEventManager.java → ...ch/ubi/events/OpenSearchEventManager.java b/...ch/ubl/events/OpenSearchEventManager.java → ...ch/ubi/events/OpenSearchEventManager.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl.events;
+package org.opensearch.ubi.events;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;

diff --git a/...nsearch/ubl/events/queues/EventQueue.java → ...nsearch/ubi/events/queues/EventQueue.java b/...nsearch/ubl/events/queues/EventQueue.java → ...nsearch/ubi/events/queues/EventQueue.java
@@ -6,10 +6,9 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl.events.queues;
+package org.opensearch.ubi.events.queues;
 
-import org.opensearch.action.index.IndexRequest;
-import org.opensearch.ubl.events.Event;
+import org.opensearch.ubi.events.Event;
 
 import java.util.List;
 

diff --git a/...arch/ubl/events/queues/InternalQueue.java → ...arch/ubi/events/queues/InternalQueue.java b/...arch/ubl/events/queues/InternalQueue.java → ...arch/ubi/events/queues/InternalQueue.java
@@ -6,9 +6,9 @@
  * compatible open source license.
  */
 
-package org.opensearch.ubl.events.queues;
+package org.opensearch.ubi.events.queues;
 
-import org.opensearch.ubl.events.Event;
+import org.opensearch.ubi.events.Event;
 
 import java.util.LinkedList;
 import java.util.List;