You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2018/07/07 18:38:45 UTC
[GitHub] jerrypeng closed pull request #2098: Add context to source and sink
jerrypeng closed pull request #2098: Add context to source and sink
URL: https://github.com/apache/incubator-pulsar/pull/2098
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/ContextImpl.java b/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/ContextImpl.java
index e2887bf37b..0a1b96503c 100644
--- a/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/ContextImpl.java
+++ b/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/ContextImpl.java
@@ -36,6 +36,8 @@
import org.apache.pulsar.functions.instance.state.StateContextImpl;
import org.apache.pulsar.functions.proto.InstanceCommunication.MetricsData;
import org.apache.pulsar.functions.utils.Reflections;
+import org.apache.pulsar.io.core.SinkContext;
+import org.apache.pulsar.io.core.SourceContext;
import org.slf4j.Logger;
import java.io.IOException;
@@ -56,7 +58,7 @@
/**
* This class implements the Context interface exposed to the user.
*/
-class ContextImpl implements Context {
+class ContextImpl implements Context, SinkContext, SourceContext {
private InstanceConfig config;
private Logger logger;
diff --git a/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/JavaInstance.java b/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/JavaInstance.java
index 3bd563ebf5..496b43f109 100644
--- a/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/JavaInstance.java
+++ b/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/JavaInstance.java
@@ -21,16 +21,9 @@
import lombok.AccessLevel;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
-import org.apache.pulsar.client.api.Consumer;
import org.apache.pulsar.client.api.MessageId;
-import org.apache.pulsar.client.api.PulsarClient;
import org.apache.pulsar.functions.api.Function;
import org.apache.pulsar.functions.proto.InstanceCommunication;
-import org.apache.pulsar.io.core.Source;
-
-import org.apache.pulsar.functions.source.PulsarSource;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
/**
* This is the Java Instance. This is started by the runtimeSpawner using the JavaInstanceClient
@@ -45,19 +38,9 @@
private Function function;
private java.util.function.Function javaUtilFunction;
- public JavaInstance(InstanceConfig config, Object userClassObject,
- ClassLoader clsLoader,
- PulsarClient pulsarClient,
- Source source) {
- // TODO: cache logger instances by functions?
- Logger instanceLog = LoggerFactory.getLogger("function-" + config.getFunctionDetails().getName());
-
- Consumer consumer = null;
- if (source instanceof PulsarSource) {
- consumer = ((PulsarSource) source).getInputConsumer();
- }
+ public JavaInstance(ContextImpl contextImpl, Object userClassObject) {
- this.context = new ContextImpl(config, instanceLog, pulsarClient, clsLoader, consumer);
+ this.context = contextImpl;
// create the functions
if (userClassObject instanceof Function) {
diff --git a/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/JavaInstanceRunnable.java b/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/JavaInstanceRunnable.java
index 5485d72aaa..5b206fbd74 100644
--- a/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/JavaInstanceRunnable.java
+++ b/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/instance/JavaInstanceRunnable.java
@@ -47,6 +47,7 @@
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.LoggerConfig;
+import org.apache.pulsar.client.api.Consumer;
import org.apache.pulsar.client.api.MessageId;
import org.apache.pulsar.client.api.PulsarClient;
import org.apache.pulsar.client.api.SubscriptionType;
@@ -68,6 +69,8 @@
import org.apache.pulsar.io.core.Record;
import org.apache.pulsar.io.core.Sink;
import org.apache.pulsar.io.core.Source;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* A function container implemented using java thread.
@@ -121,7 +124,7 @@ public JavaInstanceRunnable(InstanceConfig instanceConfig,
/**
* NOTE: this method should be called in the instance thread, in order to make class loading work.
*/
- JavaInstance setupJavaInstance() throws Exception {
+ JavaInstance setupJavaInstance(ContextImpl contextImpl) throws Exception {
// initialize the thread context
ThreadContext.put("function", FunctionDetailsUtils.getFullyQualifiedName(instanceConfig.getFunctionDetails()));
ThreadContext.put("functionname", instanceConfig.getFunctionDetails().getName());
@@ -143,13 +146,24 @@ JavaInstance setupJavaInstance() throws Exception {
// start the state table
setupStateTable();
// start the output producer
- setupOutput();
+ setupOutput(contextImpl);
// start the input consumer
- setupInput();
+ setupInput(contextImpl);
// start any log topic handler
setupLogHandler();
- return new JavaInstance(instanceConfig, object, clsLoader, client, this.source);
+ return new JavaInstance(contextImpl, object);
+ }
+
+ ContextImpl setupContext() {
+ Consumer consumer = null;
+ if (source instanceof PulsarSource) {
+ consumer = ((PulsarSource) source).getInputConsumer();
+ }
+ Logger instanceLog = LoggerFactory.getLogger(
+ "function-" + instanceConfig.getFunctionDetails().getName());
+ return new ContextImpl(instanceConfig, instanceLog, client,
+ Thread.currentThread().getContextClassLoader(), consumer);
}
/**
@@ -158,7 +172,8 @@ JavaInstance setupJavaInstance() throws Exception {
@Override
public void run() {
try {
- javaInstance = setupJavaInstance();
+ ContextImpl contextImpl = setupContext();
+ javaInstance = setupJavaInstance(contextImpl);
if (null != stateTable) {
StateContextImpl stateContext = new StateContextImpl(stateTable);
javaInstance.getContext().setStateContext(stateContext);
@@ -438,7 +453,7 @@ private void removeLogTopicHandler() {
config.getRootLogger().removeAppender(logAppender.getName());
}
- public void setupInput() throws Exception {
+ public void setupInput(ContextImpl contextImpl) throws Exception {
SourceSpec sourceSpec = this.instanceConfig.getFunctionDetails().getSource();
Object object;
@@ -484,14 +499,14 @@ public void setupInput() throws Exception {
this.source = (Source) object;
if (sourceSpec.getConfigs().isEmpty()) {
- this.source.open(new HashMap<>());
+ this.source.open(new HashMap<>(), contextImpl);
} else {
this.source.open(new Gson().fromJson(sourceSpec.getConfigs(),
- new TypeToken<Map<String, Object>>(){}.getType()));
+ new TypeToken<Map<String, Object>>(){}.getType()), contextImpl);
}
}
- public void setupOutput() throws Exception {
+ public void setupOutput(ContextImpl contextImpl) throws Exception {
SinkSpec sinkSpec = this.instanceConfig.getFunctionDetails().getSink();
Object object;
@@ -522,10 +537,10 @@ public void setupOutput() throws Exception {
throw new RuntimeException("Sink does not implement correct interface");
}
if (sinkSpec.getConfigs().isEmpty()) {
- this.sink.open(new HashMap<>());
+ this.sink.open(new HashMap<>(), contextImpl);
} else {
this.sink.open(new Gson().fromJson(sinkSpec.getConfigs(),
- new TypeToken<Map<String, Object>>() {}.getType()));
+ new TypeToken<Map<String, Object>>() {}.getType()), contextImpl);
}
}
}
diff --git a/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/sink/PulsarSink.java b/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/sink/PulsarSink.java
index a5610960d7..adb551d150 100644
--- a/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/sink/PulsarSink.java
+++ b/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/sink/PulsarSink.java
@@ -41,6 +41,7 @@
import org.apache.pulsar.functions.utils.Reflections;
import org.apache.pulsar.io.core.RecordContext;
import org.apache.pulsar.io.core.Sink;
+import org.apache.pulsar.io.core.SinkContext;
import java.util.Base64;
import java.util.Map;
@@ -187,7 +188,7 @@ public PulsarSink(PulsarClient client, PulsarSinkConfig pulsarSinkConfig) {
}
@Override
- public void open(Map<String, Object> config) throws Exception {
+ public void open(Map<String, Object> config, SinkContext sinkContext) throws Exception {
// Setup Serialization/Deserialization
setupSerDe();
diff --git a/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/source/PulsarSource.java b/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/source/PulsarSource.java
index 54373ba735..680d754265 100644
--- a/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/source/PulsarSource.java
+++ b/pulsar-functions/instance/src/main/java/org/apache/pulsar/functions/source/PulsarSource.java
@@ -38,6 +38,7 @@
import org.apache.pulsar.functions.utils.Utils;
import org.apache.pulsar.io.core.Record;
import org.apache.pulsar.io.core.Source;
+import org.apache.pulsar.io.core.SourceContext;
import java.util.ArrayList;
import java.util.HashMap;
@@ -61,7 +62,7 @@ public PulsarSource(PulsarClient pulsarClient, PulsarSourceConfig pulsarConfig)
}
@Override
- public void open(Map<String, Object> config) throws Exception {
+ public void open(Map<String, Object> config, SourceContext sourceContext) throws Exception {
// Setup Serialization/Deserialization
setupSerDe();
diff --git a/pulsar-functions/instance/src/test/java/org/apache/pulsar/functions/instance/JavaInstanceTest.java b/pulsar-functions/instance/src/test/java/org/apache/pulsar/functions/instance/JavaInstanceTest.java
index 4c301602f6..f69172ae05 100644
--- a/pulsar-functions/instance/src/test/java/org/apache/pulsar/functions/instance/JavaInstanceTest.java
+++ b/pulsar-functions/instance/src/test/java/org/apache/pulsar/functions/instance/JavaInstanceTest.java
@@ -18,27 +18,15 @@
*/
package org.apache.pulsar.functions.instance;
-import static org.mockito.Mockito.mock;
-import static org.testng.Assert.assertEquals;
-import static org.testng.Assert.assertNotNull;
-
import org.apache.pulsar.client.api.MessageId;
import org.apache.pulsar.functions.api.Function;
-import org.apache.pulsar.functions.api.utils.DefaultSerDe;
-import org.apache.pulsar.functions.proto.Function.FunctionDetails;
-import org.apache.pulsar.functions.proto.Function.SinkSpec;
-import org.apache.pulsar.functions.source.PulsarSource;
import org.testng.annotations.Test;
-public class JavaInstanceTest {
+import static org.mockito.Mockito.mock;
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertNotNull;
- private static InstanceConfig createInstanceConfig() {
- FunctionDetails.Builder functionDetailsBuilder = FunctionDetails.newBuilder();
- functionDetailsBuilder.setSink(SinkSpec.newBuilder().setSerDeClassName(DefaultSerDe.class.getName()).build());
- InstanceConfig instanceConfig = new InstanceConfig();
- instanceConfig.setFunctionDetails(functionDetailsBuilder.build());
- return instanceConfig;
- }
+public class JavaInstanceTest {
/**
* Verify that be able to run lambda functions.
@@ -46,11 +34,9 @@ private static InstanceConfig createInstanceConfig() {
*/
@Test
public void testLambda() {
- InstanceConfig config = createInstanceConfig();
JavaInstance instance = new JavaInstance(
- config,
- (Function<String, String>) (input, context) -> input + "-lambda",
- null, null, mock(PulsarSource.class));
+ mock(ContextImpl.class),
+ (Function<String, String>) (input, context) -> input + "-lambda");
String testString = "ABC123";
JavaExecutionResult result = instance.handleMessage(MessageId.earliest, "random", testString);
assertNotNull(result.getResult());
diff --git a/pulsar-functions/instance/src/test/java/org/apache/pulsar/functions/source/PulsarSourceTest.java b/pulsar-functions/instance/src/test/java/org/apache/pulsar/functions/source/PulsarSourceTest.java
index a7e36109bc..baad625f83 100644
--- a/pulsar-functions/instance/src/test/java/org/apache/pulsar/functions/source/PulsarSourceTest.java
+++ b/pulsar-functions/instance/src/test/java/org/apache/pulsar/functions/source/PulsarSourceTest.java
@@ -28,6 +28,7 @@
import org.apache.pulsar.functions.api.SerDe;
import org.apache.pulsar.functions.api.utils.DefaultSerDe;
import org.apache.pulsar.functions.utils.FunctionConfig;
+import org.apache.pulsar.io.core.SourceContext;
import org.testng.annotations.Test;
import java.io.IOException;
@@ -121,7 +122,7 @@ public void testVoidInputClasses() throws IOException {
PulsarSource pulsarSource = new PulsarSource(getPulsarClient(), pulsarConfig);
try {
- pulsarSource.open(new HashMap<>());
+ pulsarSource.open(new HashMap<>(), mock(SourceContext.class));
assertFalse(true);
} catch (RuntimeException ex) {
log.error("RuntimeException: {}", ex, ex);
@@ -145,7 +146,7 @@ public void testInconsistentInputType() throws IOException {
pulsarConfig.setTopicSerdeClassNameMap(topicSerdeClassNameMap);
PulsarSource pulsarSource = new PulsarSource(getPulsarClient(), pulsarConfig);
try {
- pulsarSource.open(new HashMap<>());
+ pulsarSource.open(new HashMap<>(), mock(SourceContext.class));
fail("Should fail constructing java instance if function type is inconsistent with serde type");
} catch (RuntimeException ex) {
log.error("RuntimeException: {}", ex, ex);
@@ -169,7 +170,7 @@ public void testDefaultSerDe() throws Exception {
pulsarConfig.setTopicSerdeClassNameMap(topicSerdeClassNameMap);
PulsarSource pulsarSource = new PulsarSource(getPulsarClient(), pulsarConfig);
- pulsarSource.open(new HashMap<>());
+ pulsarSource.open(new HashMap<>(), mock(SourceContext.class));
}
/**
@@ -184,7 +185,7 @@ public void testExplicitDefaultSerDe() throws Exception {
pulsarConfig.setTopicSerdeClassNameMap(topicSerdeClassNameMap);
PulsarSource pulsarSource = new PulsarSource(getPulsarClient(), pulsarConfig);
- pulsarSource.open(new HashMap<>());
+ pulsarSource.open(new HashMap<>(), mock(SourceContext.class));
}
@Test
diff --git a/pulsar-functions/worker/src/test/java/org/apache/pulsar/functions/worker/rest/api/v2/FunctionApiV2ResourceTest.java b/pulsar-functions/worker/src/test/java/org/apache/pulsar/functions/worker/rest/api/v2/FunctionApiV2ResourceTest.java
index 599a30ef95..0bac0a68b2 100644
--- a/pulsar-functions/worker/src/test/java/org/apache/pulsar/functions/worker/rest/api/v2/FunctionApiV2ResourceTest.java
+++ b/pulsar-functions/worker/src/test/java/org/apache/pulsar/functions/worker/rest/api/v2/FunctionApiV2ResourceTest.java
@@ -67,6 +67,7 @@
import org.apache.pulsar.functions.worker.rest.api.FunctionsImpl;
import org.apache.pulsar.io.core.RecordContext;
import org.apache.pulsar.io.core.Sink;
+import org.apache.pulsar.io.core.SinkContext;
import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
import org.powermock.core.classloader.annotations.PowerMockIgnore;
import org.powermock.core.classloader.annotations.PrepareForTest;
@@ -105,7 +106,7 @@ public void close() throws Exception {
}
@Override
- public void open(Map config) throws Exception {
+ public void open(Map config, SinkContext sinkContext) throws Exception {
}
@Override
diff --git a/pulsar-io/aerospike/src/main/java/org/apache/pulsar/io/aerospike/AerospikeAbstractSink.java b/pulsar-io/aerospike/src/main/java/org/apache/pulsar/io/aerospike/AerospikeAbstractSink.java
index 15fcc521ad..ba296161fd 100644
--- a/pulsar-io/aerospike/src/main/java/org/apache/pulsar/io/aerospike/AerospikeAbstractSink.java
+++ b/pulsar-io/aerospike/src/main/java/org/apache/pulsar/io/aerospike/AerospikeAbstractSink.java
@@ -33,6 +33,7 @@
import com.aerospike.client.policy.WritePolicy;
import org.apache.pulsar.io.core.KeyValue;
import org.apache.pulsar.io.core.SimpleSink;
+import org.apache.pulsar.io.core.SinkContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -57,7 +58,7 @@
private EventLoop eventLoop;
@Override
- public void open(Map<String, Object> config) throws Exception {
+ public void open(Map<String, Object> config, SinkContext sinkContext) throws Exception {
aerospikeSinkConfig = AerospikeSinkConfig.load(config);
if (aerospikeSinkConfig.getSeedHosts() == null
|| aerospikeSinkConfig.getKeyspace() == null
diff --git a/pulsar-io/cassandra/src/main/java/org/apache/pulsar/io/cassandra/CassandraAbstractSink.java b/pulsar-io/cassandra/src/main/java/org/apache/pulsar/io/cassandra/CassandraAbstractSink.java
index 8c330cda74..c8a9ca51a3 100644
--- a/pulsar-io/cassandra/src/main/java/org/apache/pulsar/io/cassandra/CassandraAbstractSink.java
+++ b/pulsar-io/cassandra/src/main/java/org/apache/pulsar/io/cassandra/CassandraAbstractSink.java
@@ -33,6 +33,7 @@
import org.apache.pulsar.io.core.KeyValue;
import org.apache.pulsar.io.core.SimpleSink;
+import org.apache.pulsar.io.core.SinkContext;
/**
* A Simple abstract class for Cassandra sink
@@ -47,7 +48,7 @@
private PreparedStatement statement;
@Override
- public void open(Map<String, Object> config) throws Exception {
+ public void open(Map<String, Object> config, SinkContext sinkContext) throws Exception {
cassandraSinkConfig = CassandraSinkConfig.load(config);
if (cassandraSinkConfig.getRoots() == null
|| cassandraSinkConfig.getKeyspace() == null
diff --git a/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/PushSource.java b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/PushSource.java
index a33ad63a80..44d8162cab 100644
--- a/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/PushSource.java
+++ b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/PushSource.java
@@ -51,9 +51,10 @@ public PushSource() {
* Open connector with configuration
*
* @param config initialization config
+ * @param sourceContext
* @throws Exception IO type exceptions when opening a connector
*/
- abstract public void open(Map<String, Object> config) throws Exception;
+ abstract public void open(Map<String, Object> config, SourceContext sourceContext) throws Exception;
/**
* Attach a consumer function to this Source. This is invoked by the implementation
diff --git a/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/SimpleSink.java b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/SimpleSink.java
index 2c29bc8850..352a0593a4 100644
--- a/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/SimpleSink.java
+++ b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/SimpleSink.java
@@ -18,6 +18,7 @@
*/
package org.apache.pulsar.io.core;
+import java.util.Map;
import java.util.concurrent.CompletableFuture;
/**
diff --git a/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Sink.java b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Sink.java
index a84a47e071..31a044b7f2 100644
--- a/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Sink.java
+++ b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Sink.java
@@ -28,9 +28,10 @@
* Open connector with configuration
*
* @param config initialization config
+ * @param sinkContext
* @throws Exception IO type exceptions when opening a connector
*/
- void open(final Map<String, Object> config) throws Exception;
+ void open(final Map<String, Object> config, SinkContext sinkContext) throws Exception;
/**
* Write a message to Sink
diff --git a/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/SinkContext.java b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/SinkContext.java
new file mode 100644
index 0000000000..2d58e0c261
--- /dev/null
+++ b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/SinkContext.java
@@ -0,0 +1,28 @@
+/**
+ * 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.apache.pulsar.io.core;
+
+public interface SinkContext {
+ /**
+ * Record a user defined metric
+ * @param metricName The name of the metric
+ * @param value The value of the metric
+ */
+ void recordMetric(String metricName, double value);
+}
diff --git a/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Source.java b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Source.java
index e9ef0447e0..e311761af1 100644
--- a/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Source.java
+++ b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Source.java
@@ -25,9 +25,10 @@
* Open connector with configuration
*
* @param config initialization config
+ * @param sourceContext
* @throws Exception IO type exceptions when opening a connector
*/
- void open(final Map<String, Object> config) throws Exception;
+ void open(final Map<String, Object> config, SourceContext sourceContext) throws Exception;
/**
* Reads the next message from source.
diff --git a/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/SourceContext.java b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/SourceContext.java
new file mode 100644
index 0000000000..3ea707eafc
--- /dev/null
+++ b/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/SourceContext.java
@@ -0,0 +1,28 @@
+/**
+ * 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.apache.pulsar.io.core;
+
+public interface SourceContext {
+ /**
+ * Record a user defined metric
+ * @param metricName The name of the metric
+ * @param value The value of the metric
+ */
+ void recordMetric(String metricName, double value);
+}
diff --git a/pulsar-io/core/src/test/java/org/apache/pulsar/io/core/SinkTest.java b/pulsar-io/core/src/test/java/org/apache/pulsar/io/core/SinkTest.java
new file mode 100644
index 0000000000..4fb4a7d4e1
--- /dev/null
+++ b/pulsar-io/core/src/test/java/org/apache/pulsar/io/core/SinkTest.java
@@ -0,0 +1,60 @@
+/**
+ * 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.apache.pulsar.io.core;
+
+import org.testng.annotations.Test;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+public class SinkTest {
+
+ public static class TestSink implements Sink<String> {
+
+ @Override
+ public void open(Map<String, Object> config, SinkContext sinkContext) throws Exception {
+ sinkContext.recordMetric("foo", 1);
+ }
+
+ @Override
+ public void write(RecordContext inputRecordContext, String value) throws Exception {
+
+ }
+
+ @Override
+ public void close() throws Exception {
+
+ }
+ }
+
+ @Test
+ public void testSinkContext() throws Exception {
+ SinkContext sinkContext = mock(SinkContext.class);
+
+ Sink testSink = spy(TestSink.class);
+ testSink.open(new HashMap<>(), sinkContext);
+
+ verify(sinkContext, times(1)).recordMetric("foo", 1);
+ }
+}
diff --git a/pulsar-io/core/src/test/java/org/apache/pulsar/io/core/SourceTest.java b/pulsar-io/core/src/test/java/org/apache/pulsar/io/core/SourceTest.java
new file mode 100644
index 0000000000..18ad5c2321
--- /dev/null
+++ b/pulsar-io/core/src/test/java/org/apache/pulsar/io/core/SourceTest.java
@@ -0,0 +1,59 @@
+/**
+ * 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.apache.pulsar.io.core;
+
+import org.testng.annotations.Test;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+public class SourceTest {
+ public static class TestSource implements Source<String> {
+
+ @Override
+ public void close() throws Exception {
+
+ }
+
+ @Override
+ public void open(Map<String, Object> config, SourceContext sourceContext) throws Exception {
+ sourceContext.recordMetric("foo", 1);
+ }
+
+ @Override
+ public Record<String> read() throws Exception {
+ return null;
+ }
+ }
+
+ @Test
+ public void testSinkContext() throws Exception {
+ SourceContext sourceContext = mock(SourceContext.class);
+
+ Source testSource = spy(TestSource.class);
+ testSource.open(new HashMap<>(), sourceContext);
+
+ verify(sourceContext, times(1)).recordMetric("foo", 1);
+ }
+}
diff --git a/pulsar-io/kafka/src/main/java/org/apache/pulsar/io/kafka/KafkaAbstractSink.java b/pulsar-io/kafka/src/main/java/org/apache/pulsar/io/kafka/KafkaAbstractSink.java
index 1d6b8b2e07..c597489adc 100644
--- a/pulsar-io/kafka/src/main/java/org/apache/pulsar/io/kafka/KafkaAbstractSink.java
+++ b/pulsar-io/kafka/src/main/java/org/apache/pulsar/io/kafka/KafkaAbstractSink.java
@@ -25,6 +25,7 @@
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.pulsar.io.core.KeyValue;
import org.apache.pulsar.io.core.SimpleSink;
+import org.apache.pulsar.io.core.SinkContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -72,7 +73,7 @@ public void close() throws IOException {
}
@Override
- public void open(Map<String, Object> config) throws Exception {
+ public void open(Map<String, Object> config, SinkContext sinkContext) throws Exception {
kafkaSinkConfig = KafkaSinkConfig.load(config);
if (kafkaSinkConfig.getTopic() == null
|| kafkaSinkConfig.getBootstrapServers() == null
diff --git a/pulsar-io/kafka/src/main/java/org/apache/pulsar/io/kafka/KafkaAbstractSource.java b/pulsar-io/kafka/src/main/java/org/apache/pulsar/io/kafka/KafkaAbstractSource.java
index 05d90b3552..fe8a6a70ef 100644
--- a/pulsar-io/kafka/src/main/java/org/apache/pulsar/io/kafka/KafkaAbstractSource.java
+++ b/pulsar-io/kafka/src/main/java/org/apache/pulsar/io/kafka/KafkaAbstractSource.java
@@ -27,6 +27,7 @@
import org.apache.kafka.clients.consumer.KafkaConsumer;
import org.apache.pulsar.io.core.PushSource;
import org.apache.pulsar.io.core.Record;
+import org.apache.pulsar.io.core.SourceContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -49,7 +50,7 @@
Thread runnerThread;
@Override
- public void open(Map<String, Object> config) throws Exception {
+ public void open(Map<String, Object> config, SourceContext sourceContext) throws Exception {
kafkaSourceConfig = KafkaSourceConfig.load(config);
if (kafkaSourceConfig.getTopic() == null
|| kafkaSourceConfig.getBootstrapServers() == null
diff --git a/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/KinesisSink.java b/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/KinesisSink.java
index eaa2b91845..5387a661b2 100644
--- a/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/KinesisSink.java
+++ b/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/KinesisSink.java
@@ -35,6 +35,7 @@
import org.apache.commons.lang3.builder.ToStringStyle;
import org.apache.pulsar.io.core.RecordContext;
import org.apache.pulsar.io.core.Sink;
+import org.apache.pulsar.io.core.SinkContext;
import org.apache.pulsar.io.kinesis.KinesisSinkConfig.MessageFormat;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -120,7 +121,7 @@ public void close() throws IOException {
}
@Override
- public void open(Map<String, Object> config) throws Exception {
+ public void open(Map<String, Object> config, SinkContext sinkContext) throws Exception {
kinesisSinkConfig = KinesisSinkConfig.load(config);
checkArgument(isNotBlank(kinesisSinkConfig.getAwsKinesisStreamName()), "empty kinesis-stream name");
diff --git a/pulsar-io/rabbitmq/src/main/java/org/apache/pulsar/io/rabbitmq/RabbitMQSource.java b/pulsar-io/rabbitmq/src/main/java/org/apache/pulsar/io/rabbitmq/RabbitMQSource.java
index e17ab5f8d7..dab3fe96eb 100644
--- a/pulsar-io/rabbitmq/src/main/java/org/apache/pulsar/io/rabbitmq/RabbitMQSource.java
+++ b/pulsar-io/rabbitmq/src/main/java/org/apache/pulsar/io/rabbitmq/RabbitMQSource.java
@@ -27,12 +27,12 @@
import com.rabbitmq.client.Envelope;
import org.apache.pulsar.io.core.PushSource;
import org.apache.pulsar.io.core.Record;
+import org.apache.pulsar.io.core.SourceContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.util.Map;
-import java.util.function.Consumer;
/**
* A simple connector to consume messages from a RabbitMQ queue
@@ -46,7 +46,7 @@
private RabbitMQConfig rabbitMQConfig;
@Override
- public void open(Map<String, Object> config) throws Exception {
+ public void open(Map<String, Object> config, SourceContext sourceContext) throws Exception {
rabbitMQConfig = RabbitMQConfig.load(config);
if (rabbitMQConfig.getAmqUri() == null
|| rabbitMQConfig.getQueueName() == null) {
diff --git a/pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java b/pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
index 5dc495ea8c..56c52e7ca4 100644
--- a/pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
+++ b/pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
@@ -36,6 +36,7 @@
import org.apache.pulsar.io.core.PushSource;
import org.apache.pulsar.io.core.Record;
+import org.apache.pulsar.io.core.SourceContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -52,7 +53,7 @@
private Object waitObject;
@Override
- public void open(Map<String, Object> config) throws IOException {
+ public void open(Map<String, Object> config, SourceContext sourceContext) throws IOException {
TwitterFireHoseConfig hoseConfig = TwitterFireHoseConfig.load(config);
if (hoseConfig.getConsumerKey() == null
|| hoseConfig.getConsumerSecret() == null
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services