opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/DataBrokerCommitExecutor.java

   1 /*
   2  * Copyright (c) 2024 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.databroker;
   9
  10 import java.util.concurrent.Executor;
  11 import java.util.concurrent.ExecutorService;
  12 import java.util.concurrent.TimeUnit;
  13 import org.opendaylight.controller.md.sal.common.util.jmx.ThreadExecutorStatsMXBeanImpl;
  14 import org.opendaylight.yangtools.util.DurationStatisticsTracker;
  15 import org.opendaylight.yangtools.util.concurrent.SpecialExecutors;
  16 import org.osgi.service.component.annotations.Activate;
  17 import org.osgi.service.component.annotations.Component;
  18 import org.osgi.service.component.annotations.Deactivate;
  19 import org.osgi.service.metatype.annotations.AttributeDefinition;
  20 import org.osgi.service.metatype.annotations.Designate;
  21 import org.osgi.service.metatype.annotations.ObjectClassDefinition;
  22 import org.slf4j.Logger;
  23 import org.slf4j.LoggerFactory;
  24
  25 @Component(
  26     service = DataBrokerCommitExecutor.class,
  27     configurationPid = "org.opendaylight.controller.cluster.datastore.broker")
  28 @Designate(ocd = DataBrokerCommitExecutor.Config.class)
  29 public final class DataBrokerCommitExecutor {
  30     @ObjectClassDefinition
  31     public @interface Config {
  32         @AttributeDefinition(name = "max-data-broker-future-callback-queue-size")
  33         int callbackQueueSize() default 1000;
  34         @AttributeDefinition(name = "max-data-broker-future-callback-pool-size")
  35         int callbackPoolSize() default 20;
  36     }
  37
  38     private static final Logger LOG = LoggerFactory.getLogger(DataBrokerCommitExecutor.class);
  39
  40     private final DurationStatisticsTracker commitStatsTracker = DurationStatisticsTracker.createConcurrent();
  41     private final ThreadExecutorStatsMXBeanImpl threadStats;
  42     private final CommitStatsMXBeanImpl commitStats;
  43     private final ExecutorService executorService;
  44
  45     @Activate
  46     public DataBrokerCommitExecutor(final Config config) {
  47         executorService = SpecialExecutors.newBlockingBoundedCachedThreadPool(config.callbackPoolSize(),
  48             config.callbackQueueSize(), "CommitFutures", ConcurrentDOMDataBroker.class);
  49         threadStats = ThreadExecutorStatsMXBeanImpl.create(executorService, "CommitFutureExecutorStats",
  50             "DOMDataBroker");
  51         commitStats = new CommitStatsMXBeanImpl(commitStatsTracker, "DOMDataBroker");
  52         commitStats.register();
  53         LOG.info("DOM Data Broker commit exector started");
  54     }
  55
  56     @Deactivate
  57     void deactivate() {
  58         LOG.info("DOM Data Broker commit exector stopping");
  59         commitStats.unregister();
  60         threadStats.unregister();
  61         executorService.shutdown();
  62         try {
  63             executorService.awaitTermination(1, TimeUnit.MINUTES);
  64         } catch (InterruptedException e) {
  65             LOG.warn("Future executor failed to finish in time, giving up", e);
  66         }
  67         LOG.info("DOM Data Broker commit exector stopped");
  68     }
  69
  70     Executor executor() {
  71         return executorService;
  72     }
  73
  74     DurationStatisticsTracker commitStatsTracker() {
  75         return commitStatsTracker;
  76     }
  77 }