Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.opencord.kafka.impl; |
| 17 | |
| 18 | import com.fasterxml.jackson.databind.JsonNode; |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 19 | import org.apache.kafka.common.KafkaException; |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 20 | import org.osgi.service.component.annotations.Activate; |
| 21 | import org.osgi.service.component.annotations.Component; |
| 22 | import org.osgi.service.component.annotations.Deactivate; |
| 23 | import org.osgi.service.component.annotations.Reference; |
| 24 | import org.osgi.service.component.annotations.ReferenceCardinality; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 25 | import org.apache.kafka.clients.producer.KafkaProducer; |
| 26 | import org.apache.kafka.clients.producer.ProducerRecord; |
| 27 | import org.apache.kafka.common.serialization.StringSerializer; |
Jonathan Hart | a11792a | 2018-08-19 13:48:17 -0700 | [diff] [blame] | 28 | import org.onosproject.cluster.ClusterService; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 29 | import org.onosproject.core.ApplicationId; |
| 30 | import org.onosproject.core.CoreService; |
| 31 | import org.onosproject.net.config.ConfigFactory; |
| 32 | import org.onosproject.net.config.NetworkConfigEvent; |
| 33 | import org.onosproject.net.config.NetworkConfigListener; |
| 34 | import org.onosproject.net.config.NetworkConfigRegistry; |
| 35 | import org.onosproject.net.config.basics.SubjectFactories; |
| 36 | import org.opencord.kafka.EventBusService; |
| 37 | import org.slf4j.Logger; |
| 38 | |
| 39 | import java.util.Properties; |
| 40 | import java.util.concurrent.ExecutorService; |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 41 | import java.util.concurrent.ScheduledExecutorService; |
| 42 | import java.util.concurrent.ScheduledFuture; |
Jonathan Hart | a11792a | 2018-08-19 13:48:17 -0700 | [diff] [blame] | 43 | import java.util.concurrent.TimeUnit; |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 44 | import java.util.concurrent.atomic.AtomicReference; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 45 | |
| 46 | import static com.google.common.base.Preconditions.checkNotNull; |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 47 | import static java.util.concurrent.Executors.newScheduledThreadPool; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 48 | import static java.util.concurrent.Executors.newSingleThreadExecutor; |
| 49 | import static org.onlab.util.Tools.groupedThreads; |
| 50 | import static org.slf4j.LoggerFactory.getLogger; |
| 51 | |
| 52 | /** |
| 53 | * Sends events to a Kafka event bus. |
| 54 | */ |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 55 | @Component(immediate = true) |
| 56 | public class KafkaIntegration implements EventBusService { |
| 57 | |
| 58 | private final Logger log = getLogger(getClass()); |
| 59 | private static final Class<KafkaConfig> |
| 60 | KAFKA_CONFIG_CLASS = KafkaConfig.class; |
| 61 | |
kishore | efa3db5 | 2020-03-23 16:09:26 +0530 | [diff] [blame] | 62 | protected static final String APP_NAME = "org.opencord.kafka"; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 63 | private ApplicationId appId; |
| 64 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 65 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 66 | protected CoreService coreService; |
| 67 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jonathan Hart | a11792a | 2018-08-19 13:48:17 -0700 | [diff] [blame] | 69 | protected ClusterService clusterService; |
| 70 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 72 | protected NetworkConfigRegistry configRegistry; |
| 73 | |
| 74 | private static StringSerializer stringSerializer = new StringSerializer(); |
| 75 | |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 76 | private AtomicReference<KafkaProducer<String, String>> kafkaProducerRef = new AtomicReference<>(); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 77 | |
| 78 | private InternalNetworkConfigListener configListener = |
| 79 | new InternalNetworkConfigListener(); |
| 80 | |
| 81 | private final ExecutorService executor = newSingleThreadExecutor( |
| 82 | groupedThreads(this.getClass().getSimpleName(), "events", log)); |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 83 | private final ScheduledExecutorService scheduledExecutorService = newScheduledThreadPool(1, |
| 84 | groupedThreads(this.getClass().getSimpleName(), "kafka", log)); |
| 85 | ScheduledFuture producerCreate; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 86 | |
| 87 | private ConfigFactory<ApplicationId, KafkaConfig> kafkaConfigFactory = |
| 88 | new ConfigFactory<ApplicationId, KafkaConfig>( |
| 89 | SubjectFactories.APP_SUBJECT_FACTORY, KAFKA_CONFIG_CLASS, |
| 90 | "kafka") { |
| 91 | @Override |
| 92 | public KafkaConfig createConfig() { |
| 93 | return new KafkaConfig(); |
| 94 | } |
| 95 | }; |
| 96 | |
Jonathan Hart | a11792a | 2018-08-19 13:48:17 -0700 | [diff] [blame] | 97 | private static final String CLIENT_ID = "client.id"; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 98 | private static final String BOOTSTRAP_SERVERS = "bootstrap.servers"; |
| 99 | private static final String RETRIES = "retries"; |
| 100 | private static final String RECONNECT_BACKOFF = "reconnect.backoff.ms"; |
| 101 | private static final String INFLIGHT_REQUESTS = |
| 102 | "max.in.flight.requests.per.connection"; |
| 103 | private static final String ACKS = "acks"; |
| 104 | private static final String KEY_SERIALIZER = "key.serializer"; |
| 105 | private static final String VALUE_SERIALIZER = "value.serializer"; |
| 106 | private static final String STRING_SERIALIZER = |
| 107 | stringSerializer.getClass().getCanonicalName(); |
| 108 | |
| 109 | private static final String TIMESTAMP = "timestamp"; |
| 110 | |
| 111 | @Activate |
| 112 | public void activate() { |
| 113 | appId = coreService.registerApplication(APP_NAME); |
| 114 | configRegistry.registerConfigFactory(kafkaConfigFactory); |
| 115 | configRegistry.addListener(configListener); |
Andy Bavier | 8e9eeef | 2018-09-19 15:40:58 -0700 | [diff] [blame] | 116 | configure(); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 117 | |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 118 | log.info("Started"); |
| 119 | } |
| 120 | |
| 121 | @Deactivate |
| 122 | public void deactivate() { |
| 123 | configRegistry.removeListener(configListener); |
| 124 | configRegistry.unregisterConfigFactory(kafkaConfigFactory); |
| 125 | |
| 126 | executor.shutdownNow(); |
| 127 | |
| 128 | shutdownKafka(); |
| 129 | log.info("Stopped"); |
| 130 | } |
| 131 | |
| 132 | private void configure() { |
| 133 | KafkaConfig config = |
| 134 | configRegistry.getConfig(appId, KAFKA_CONFIG_CLASS); |
| 135 | if (config == null) { |
| 136 | log.info("Kafka configuration not present"); |
| 137 | return; |
| 138 | } |
| 139 | configure(config); |
| 140 | } |
| 141 | |
| 142 | private void configure(KafkaConfig config) { |
| 143 | checkNotNull(config); |
| 144 | |
| 145 | Properties properties = new Properties(); |
Jonathan Hart | a11792a | 2018-08-19 13:48:17 -0700 | [diff] [blame] | 146 | properties.put(CLIENT_ID, clusterService.getLocalNode().id().toString()); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 147 | properties.put(BOOTSTRAP_SERVERS, config.getBootstrapServers()); |
| 148 | properties.put(RETRIES, config.getRetries()); |
| 149 | properties.put(RECONNECT_BACKOFF, config.getReconnectBackoff()); |
| 150 | properties.put(INFLIGHT_REQUESTS, config.getInflightRequests()); |
| 151 | properties.put(ACKS, config.getAcks()); |
| 152 | properties.put(KEY_SERIALIZER, STRING_SERIALIZER); |
| 153 | properties.put(VALUE_SERIALIZER, STRING_SERIALIZER); |
| 154 | |
| 155 | startKafka(properties); |
| 156 | } |
| 157 | |
| 158 | private void unconfigure() { |
| 159 | shutdownKafka(); |
| 160 | } |
| 161 | |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 162 | private synchronized void startKafka(Properties properties) { |
| 163 | if (kafkaProducerRef.get() == null) { |
Matteo Scandolo | 246f723 | 2019-05-09 15:57:39 -0700 | [diff] [blame] | 164 | // Kafka client doesn't play nice with the default OSGi classloader |
| 165 | // This workaround temporarily changes the thread's classloader so that |
| 166 | // the Kafka client can load the serializer classes. |
| 167 | ClassLoader original = Thread.currentThread().getContextClassLoader(); |
| 168 | Thread.currentThread().setContextClassLoader(this.getClass().getClassLoader()); |
| 169 | try { |
| 170 | log.info("Starting Kafka producer"); |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 171 | try { |
| 172 | KafkaProducer<String, String> kafkaProducer = new KafkaProducer<>(properties); |
| 173 | kafkaProducerRef.set(kafkaProducer); |
| 174 | } catch (KafkaException e) { |
| 175 | log.error("Unable to create the kafka producer", e); |
| 176 | // Try again in a little bit |
| 177 | producerCreate = scheduledExecutorService.schedule(() -> configure(), 30, TimeUnit.SECONDS); |
| 178 | } |
Matteo Scandolo | 246f723 | 2019-05-09 15:57:39 -0700 | [diff] [blame] | 179 | } finally { |
| 180 | Thread.currentThread().setContextClassLoader(original); |
| 181 | } |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 182 | } |
| 183 | } |
| 184 | |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 185 | private synchronized void shutdownKafka() { |
| 186 | if (producerCreate != null) { |
| 187 | producerCreate.cancel(true); |
| 188 | producerCreate = null; |
| 189 | } |
| 190 | |
| 191 | if (kafkaProducerRef.get() != null) { |
| 192 | KafkaProducer<String, String> kafkaProducer = kafkaProducerRef.get(); |
| 193 | |
| 194 | kafkaProducerRef.set(null); |
| 195 | |
Jonathan Hart | a11792a | 2018-08-19 13:48:17 -0700 | [diff] [blame] | 196 | log.info("Shutting down Kafka producer"); |
| 197 | kafkaProducer.flush(); |
| 198 | kafkaProducer.close(0, TimeUnit.MILLISECONDS); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 199 | } |
| 200 | } |
| 201 | |
| 202 | private void logException(Exception e) { |
| 203 | if (e != null) { |
| 204 | log.error("Exception while sending to Kafka", e); |
| 205 | } |
| 206 | } |
| 207 | |
| 208 | @Override |
| 209 | public void send(String topic, JsonNode data) { |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 210 | KafkaProducer<String, String> producer = kafkaProducerRef.get(); |
| 211 | if (producer == null) { |
Matteo Scandolo | e53b12a | 2018-09-13 10:06:58 -0700 | [diff] [blame] | 212 | log.warn("Not sending event as kafkaProducer is not defined: {}", data.toString()); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 213 | return; |
| 214 | } |
| 215 | |
| 216 | if (log.isTraceEnabled()) { |
| 217 | log.trace("Sending event to Kafka: {}", data.toString()); |
| 218 | } |
| 219 | |
Jonathan Hart | 4a7bf7a | 2020-03-03 12:59:18 -0800 | [diff] [blame] | 220 | try { |
| 221 | producer.send(new ProducerRecord<>(topic, data.toString()), |
| 222 | (r, e) -> logException(e)); |
| 223 | } catch (KafkaException e) { |
| 224 | log.warn("Sending to kafka failed", e); |
| 225 | } |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 226 | } |
| 227 | |
| 228 | private class InternalNetworkConfigListener implements NetworkConfigListener { |
| 229 | |
| 230 | @Override |
| 231 | public void event(NetworkConfigEvent event) { |
Jonathan Hart | a11792a | 2018-08-19 13:48:17 -0700 | [diff] [blame] | 232 | log.info("Event type {}", event.type()); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 233 | switch (event.type()) { |
| 234 | case CONFIG_ADDED: |
| 235 | case CONFIG_UPDATED: |
Matteo Scandolo | 246f723 | 2019-05-09 15:57:39 -0700 | [diff] [blame] | 236 | unconfigure(); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 237 | configure((KafkaConfig) event.config().get()); |
| 238 | break; |
| 239 | case CONFIG_REMOVED: |
| 240 | unconfigure(); |
| 241 | break; |
| 242 | case CONFIG_REGISTERED: |
| 243 | case CONFIG_UNREGISTERED: |
| 244 | default: |
| 245 | break; |
| 246 | } |
| 247 | } |
| 248 | |
| 249 | @Override |
| 250 | public boolean isRelevant(NetworkConfigEvent event) { |
| 251 | return event.configClass().equals(KAFKA_CONFIG_CLASS); |
| 252 | } |
| 253 | } |
| 254 | } |