Merge pull request #106 from open-metadata/fix_event_handlers

Add event handler configuration and make it optional

bootstrap/sql/mysql/v001__create_db_connection_info.sql

@@ -212,10 +212,9 @@ CREATE TABLE IF NOT EXISTS tag_usage (
 );
 
 CREATE TABLE IF NOT EXISTS audit_log (
-    id VARCHAR(36) GENERATED ALWAYS AS (json ->> '$.entityId') STORED NOT NULL,
+    entityId VARCHAR(36) GENERATED ALWAYS AS (json ->> '$.entityId') NOT NULL,
     entityType VARCHAR(256) GENERATED ALWAYS AS (json ->> '$.entityType') NOT NULL,
     username VARCHAR(256) GENERATED ALWAYS AS (json ->> '$.userName') NOT NULL,
     json JSON NOT NULL,
-    timestamp BIGINT,
-    PRIMARY KEY (id)
+    timestamp BIGINT
 );

catalog-rest-service/src/main/java/org/openmetadata/catalog/CatalogApplication.java

@@ -155,8 +155,10 @@ public class CatalogApplication extends Application<CatalogApplicationConfig> {
   }
 
   private void registerEventFilter(CatalogApplicationConfig catalogConfig, Environment environment, DBI jdbi) {
-    ContainerResponseFilter eventFilter = new EventFilter(catalogConfig, jdbi);
-    environment.jersey().register(eventFilter);
+    if (catalogConfig.getEventHandlerConfiguration() != null) {
+      ContainerResponseFilter eventFilter = new EventFilter(catalogConfig, jdbi);
+      environment.jersey().register(eventFilter);
+    }
   }
 
   private void registerResources(CatalogApplicationConfig config, Environment environment, DBI jdbi) {

catalog-rest-service/src/main/java/org/openmetadata/catalog/CatalogApplicationConfig.java

@@ -18,6 +18,7 @@ package org.openmetadata.catalog;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.dropwizard.health.conf.HealthConfiguration;
+import org.openmetadata.catalog.events.EventHandlerConfiguration;
 import org.openmetadata.catalog.security.AuthenticationConfiguration;
 import org.openmetadata.catalog.security.AuthorizerConfiguration;
 import io.dropwizard.Configuration;
@@ -45,6 +46,9 @@ public class CatalogApplicationConfig extends Configuration {
     @JsonProperty("elasticsearch")
     private ElasticSearchConfiguration elasticSearchConfiguration;
 
+    @JsonProperty("eventHandlerConfiguration")
+    private EventHandlerConfiguration eventHandlerConfiguration;
+
     public DataSourceFactory getDataSourceFactory() {
         return dataSourceFactory;
     }
@@ -77,6 +81,13 @@ public class CatalogApplicationConfig extends Configuration {
         this.elasticSearchConfiguration = elasticSearchConfiguration;
     }
 
+    public EventHandlerConfiguration getEventHandlerConfiguration() {
+        return eventHandlerConfiguration;
+    }
+    public void setEventHandlerConfiguration(EventHandlerConfiguration eventHandlerConfiguration) {
+        this.eventHandlerConfiguration = eventHandlerConfiguration;
+    }
+
     @Valid
     @NotNull
     @JsonProperty("health")

catalog-rest-service/src/main/java/org/openmetadata/catalog/events/EventFilter.java

@@ -17,12 +17,15 @@
 package org.openmetadata.catalog.events;
 
 import org.openmetadata.catalog.CatalogApplicationConfig;
+import org.openmetadata.catalog.security.AuthenticationConfiguration;
+import org.openmetadata.catalog.security.CatalogAuthorizer;
 import org.openmetadata.catalog.util.ParallelStreamUtil;
 import org.skife.jdbi.v2.DBI;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import javax.ws.rs.container.ContainerRequestContext;
+import javax.ws.rs.container.ContainerRequestFilter;
 import javax.ws.rs.container.ContainerResponseContext;
 import javax.ws.rs.container.ContainerResponseFilter;
 import javax.ws.rs.ext.Provider;
@@ -30,6 +33,7 @@ import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Set;
 import java.util.concurrent.ForkJoinPool;
 
 @Provider
@@ -48,12 +52,21 @@ public class EventFilter implements ContainerResponseFilter {
     this.jdbi = jdbi;
     this.forkJoinPool = new ForkJoinPool(FORK_JOIN_POOL_PARALLELISM);
     this.eventHandlers = new ArrayList<>();
-    AuditEventHandler auditEventHandler = new AuditEventHandler();
-    auditEventHandler.init(config, jdbi);
-    eventHandlers.add(auditEventHandler);
-    ElasticSearchEventHandler elasticSearchEventHandler = new ElasticSearchEventHandler();
-    elasticSearchEventHandler.init(config, jdbi);
-    eventHandlers.add(elasticSearchEventHandler);
+    registerEventHandlers(config, jdbi);
+  }
+
+  private void registerEventHandlers(CatalogApplicationConfig config, DBI jdbi) {
+    try {
+      Set<String> eventHandlerClassNames = config.getEventHandlerConfiguration().getEventHandlerClassNames();
+      for (String eventHandlerClassName : eventHandlerClassNames) {
+        EventHandler eventHandler = ((Class<EventHandler>) Class.forName(eventHandlerClassName))
+                .getConstructor().newInstance();
+        eventHandler.init(config, jdbi);
+        eventHandlers.add(eventHandler);
+      }
+    } catch (Exception e) {
+        LOG.info("Failed instantiate and regisger event handler {}".format(e.getMessage()));
+    }
   }
 
   @Override

catalog-rest-service/src/main/java/org/openmetadata/catalog/events/EventHandlerConfiguration.java

@@ -0,0 +1,32 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one or more
+ *  contributor license agreements. See the NOTICE file distributed with
+ *  this work for additional information regarding copyright ownership.
+ *  The ASF licenses this file to You under the Apache License, Version 2.0
+ *  (the "License"); you may not use this file except in compliance with
+ *  the License. You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package org.openmetadata.catalog.events;
+
+import java.util.Set;
+
+public class EventHandlerConfiguration {
+  private Set<String> eventHandlerClassNames;
+
+  public Set<String> getEventHandlerClassNames() {
+    return eventHandlerClassNames;
+  }
+
+  public void setEventHandlerClassNames(Set<String> eventHandlerClassNames) {
+    this.eventHandlerClassNames = eventHandlerClassNames;
+  }
+
+}
+

catalog-rest-service/src/test/java/org/openmetadata/catalog/CatalogApplicationTest.java

@@ -32,7 +32,7 @@ public abstract class CatalogApplicationTest {
   public static final DropwizardAppExtension<CatalogApplicationConfig> APP;
 
   static {
-    CONFIG_PATH = ResourceHelpers.resourceFilePath("catalog-secure-test.yaml");
+    CONFIG_PATH = ResourceHelpers.resourceFilePath("openmetadata-secure-test.yaml");
     APP = new DropwizardAppExtension<>(CatalogApplication.class, CONFIG_PATH);
   }
 

catalog-rest-service/src/test/java/org/openmetadata/catalog/resources/EmbeddedMySqlSupport.java

@@ -44,14 +44,15 @@ public class EmbeddedMySqlSupport implements BeforeAllCallback, AfterAllCallback
               .withUser("test", "")
               .build();
 
-      SchemaConfig schemaConfig = SchemaConfig.aSchemaConfig("catalog_test_db").build();
+      SchemaConfig schemaConfig = SchemaConfig.aSchemaConfig("openmetadata_test_db").build();
 
       embeddedMysql = EmbeddedMysql.anEmbeddedMysql(config).addSchema(schemaConfig).start();
       LOG.info("Embedded MySQL is started");
 
       Flyway flyway = Flyway.configure()
               // TODO Remove hardcoding
-              .dataSource("jdbc:mysql://localhost:3307/catalog_test_db?useSSL=false&serverTimezone=UTC", "test", "")
+              .dataSource("jdbc:mysql://localhost:3307/openmetadata_test_db?useSSL=false&serverTimezone=UTC",
+                      "test", "")
               .sqlMigrationPrefix("v")
               .load();
       flyway.clean();

catalog-rest-service/src/test/resources/openmetadata-secure-test.yaml

@@ -93,8 +93,8 @@ logging:
   appenders:
     - type: console
     - type: file
-      currentLogFilename: './logs/catalog.log'
-      archivedLogFilenamePattern: './logs/catalog-%d-%i.log.gz'
+      currentLogFilename: './logs/openmetadata.log'
+      archivedLogFilenamePattern: './logs/openmetadata-%d-%i.log.gz'
       archive: true
       archivedFileCount: 7
       maxFileSize: '1MiB'
@@ -106,7 +106,7 @@ database:
   user: test
   password:
   # the JDBC URL; the database is called washvalet
-  url: jdbc:mysql://localhost:3307/catalog_test_db?useSSL=false&serverTimezone=UTC
+  url: jdbc:mysql://localhost:3307/openmetadata_test_db?useSSL=false&serverTimezone=UTC
 
 elasticsearch:
   host: localhost
@@ -138,3 +138,8 @@ authenticationConfiguration:
   authority: "https://accounts.google.com"
   clientId: "261867039324-neb92r2147i6upchb78tv29idk079bps.apps.googleusercontent.com"
   callbackUrl: "http://localhost:8585/callback"
+
+
+eventHandlerConfiguration:
+  eventHandlerClassNames:
+    - "org.openmetadata.catalog.events.AuditEventHandler"

conf/openmetadata-security.yaml

@@ -138,6 +138,12 @@ elasticsearch:
   host: localhost
   port: 9200
 
+
+eventHandlerConfiguration:
+  eventHandlerClassNames:
+    - "org.openmetadata.catalog.events.AuditEventHandler"
+    - "org.openmetadata.catalog.events.ElasticSearchEventHandler"
+
 health:
   delayedShutdownHandlerEnabled: true
   shutdownWaitPeriod: 1s

conf/openmetadata.yaml

@@ -99,8 +99,8 @@ logging:
     - type: file
       threshold: TRACE
       logFormat: "%level [%d{HH:mm:ss.SSS}] [%t] %logger{5} - %msg %n"
-      currentLogFilename: ./logs/catalog.log
-      archivedLogFilenamePattern: ./logs/catalog-%d{yyyy-MM-dd}-%i.log.gz
+      currentLogFilename: ./logs/openmetadata.log
+      archivedLogFilenamePattern: ./logs/openmetadata-%d{yyyy-MM-dd}-%i.log.gz
       archivedFileCount: 7
       timeZone: UTC
       maxFileSize: 50MB
@@ -119,6 +119,11 @@ elasticsearch:
   host: localhost
   port: 9200
 
+eventHandlerConfiguration:
+  eventHandlerClassNames:
+    - "org.openmetadata.catalog.events.AuditEventHandler"
+    - "org.openmetadata.catalog.events.ElasticSearchEventHandler"
+
 health:
   delayedShutdownHandlerEnabled: true
   shutdownWaitPeriod: 1s

ingestion/pipelines/mysql.json

@@ -7,7 +7,7 @@
       "service_name": "local_mysql",
       "service_type": "MySQL",
       "include_pattern": {
-        "filter": ["mysql.*", "information_schema.*"]
+        "excludes": ["mysql.*", "information_schema.*"]
       }
     }
   },