continue cleanup

Author: breedx-splk

ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/WMQContext.java renamed to ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/WmqContext.java

@@ -16,14 +16,14 @@
  * authorization.<br>
  * It also validates the arguments passed for various scenarios.
  */
-public class WMQContext {
+public class WmqContext {
   private static final String TRANSPORT_TYPE_CLIENT = "Client";
   private static final String TRANSPORT_TYPE_BINDINGS = "Bindings";
 
-  public static final Logger logger = LoggerFactory.getLogger(WMQContext.class);
+  public static final Logger logger = LoggerFactory.getLogger(WmqContext.class);
   private final QueueManager queueManager;
 
-  public WMQContext(QueueManager queueManager) {
+  public WmqContext(QueueManager queueManager) {
     this.queueManager = queueManager;
     validateArgs();
   }

ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/WMQMonitor.java renamed to ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/WmqMonitor.java

@@ -14,7 +14,6 @@
 import io.opentelemetry.api.metrics.Meter;
 import io.opentelemetry.ibm.mq.config.QueueManager;
 import io.opentelemetry.ibm.mq.metrics.MetricsConfig;
-import io.opentelemetry.ibm.mq.metricscollector.*;
 import io.opentelemetry.ibm.mq.metricscollector.ChannelMetricsCollector;
 import io.opentelemetry.ibm.mq.metricscollector.InquireChannelCmdCollector;
 import io.opentelemetry.ibm.mq.metricscollector.InquireQueueManagerCmdCollector;
@@ -27,28 +26,29 @@
 import io.opentelemetry.ibm.mq.metricscollector.ReadConfigurationEventQueueCollector;
 import io.opentelemetry.ibm.mq.metricscollector.TopicMetricsCollector;
 import io.opentelemetry.ibm.mq.opentelemetry.ConfigWrapper;
-import io.opentelemetry.ibm.mq.util.WMQUtil;
+import io.opentelemetry.ibm.mq.util.WmqUtil;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.Callable;
 import java.util.concurrent.ExecutorService;
 import java.util.function.Consumer;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class WMQMonitor {
+public class WmqMonitor {
 
-  private static final Logger logger = LoggerFactory.getLogger(WMQMonitor.class);
+  private static final Logger logger = LoggerFactory.getLogger(WmqMonitor.class);
 
   private final List<QueueManager> queueManagers;
   private final List<Consumer<MetricsCollectorContext>> jobs = new ArrayList<>();
   private final LongGauge heartbeatGauge;
   private final ExecutorService threadPool;
   private final MetricsConfig metricsConfig;
 
-  public WMQMonitor(ConfigWrapper config, ExecutorService threadPool, Meter meter) {
+  public WmqMonitor(ConfigWrapper config, ExecutorService threadPool, Meter meter) {
     List<Map<String, ?>> queueManagers = getQueueManagers(config);
     ObjectMapper mapper = new ObjectMapper();
 
@@ -86,16 +86,6 @@ public void run() {
     }
   }
 
-  @NotNull
-  private static List<Map<String, ?>> getQueueManagers(ConfigWrapper config) {
-    List<Map<String, ?>> queueManagers = config.getQueueManagers();
-    if (queueManagers.isEmpty()) {
-      throw new IllegalStateException(
-          "The 'queueManagers' section in config.yml is empty or otherwise incorrect.");
-    }
-    return queueManagers;
-  }
-
   public void run(QueueManager queueManager) {
     String queueManagerName = queueManager.getName();
     logger.debug("WMQMonitor thread for queueManager {} started.", queueManagerName);
@@ -104,11 +94,11 @@ public void run(QueueManager queueManager) {
     PCFMessageAgent agent = null;
     int heartBeatMetricValue = 0;
     try {
-      ibmQueueManager = WMQUtil.connectToQueueManager(queueManager);
+      ibmQueueManager = WmqUtil.connectToQueueManager(queueManager);
       heartBeatMetricValue = 1;
-      agent = WMQUtil.initPCFMessageAgent(queueManager, ibmQueueManager);
+      agent = WmqUtil.initPCFMessageAgent(queueManager, ibmQueueManager);
       extractAndReportMetrics(ibmQueueManager, queueManager, agent);
-    } catch (Exception e) {
+    } catch (RuntimeException e) {
       logger.error(
           "Error connecting to QueueManager {} by thread {}: {}",
           queueManagerName,
@@ -130,6 +120,16 @@ public void run(QueueManager queueManager) {
     }
   }
 
+  @NotNull
+  private static List<Map<String, ?>> getQueueManagers(ConfigWrapper config) {
+    List<Map<String, ?>> queueManagers = config.getQueueManagers();
+    if (queueManagers.isEmpty()) {
+      throw new IllegalStateException(
+          "The 'queueManagers' section in config.yml is empty or otherwise incorrect.");
+    }
+    return queueManagers;
+  }
+
   private void extractAndReportMetrics(
       MQQueueManager mqQueueManager, QueueManager queueManager, PCFMessageAgent agent) {
     logger.debug("Queueing {} jobs", jobs.size());
@@ -154,9 +154,9 @@ private void extractAndReportMetrics(
                     collector.getClass().getSimpleName(),
                     diffTime);
               }
-            } catch (Exception e) {
+            } catch (RuntimeException e) {
               logger.error(
-                  "Error while running task name = " + collector.getClass().getSimpleName(), e);
+                  "Error while running task name = {}", collector.getClass().getSimpleName(), e);
             }
             return null;
           });
@@ -170,7 +170,8 @@ private void extractAndReportMetrics(
   }
 
   /** Destroy the agent and disconnect from queue manager */
-  private static void cleanUp(MQQueueManager ibmQueueManager, PCFMessageAgent agent) {
+  private static void cleanUp(
+      @Nullable MQQueueManager ibmQueueManager, @Nullable PCFMessageAgent agent) {
     // Disconnect the agent.
 
     if (agent != null) {

ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/config/ExcludeFilters.java

@@ -7,12 +7,16 @@
 
 import io.opentelemetry.ibm.mq.metricscollector.FilterType;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
 
+/**
+ * A jackson databind class used for config.
+ */
 public class ExcludeFilters {
 
-  private String type;
+  private String type = "UNKNOWN";
   private Set<String> values = new HashSet<>();
 
   public String getType() {
@@ -24,11 +28,11 @@ public void setType(String type) {
   }
 
   public Set<String> getValues() {
-    return values;
+    return Collections.unmodifiableSet(values);
   }
 
   public void setValues(Set<String> values) {
-    this.values = values;
+    this.values = new HashSet<>(values);
   }
 
   public static boolean isExcluded(String resourceName, Collection<ExcludeFilters> excludeFilters) {

ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/config/QueueManager.java

@@ -6,25 +6,26 @@
 package io.opentelemetry.ibm.mq.config;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
-import java.util.List;
+import org.jetbrains.annotations.Nullable;
 
+/** This is a jackson databind class used purely for config. */
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class QueueManager {
 
-  private String host;
+  @Nullable private String host;
   private int port = -1;
-  private String name;
-  private String channelName;
-  private String transportType;
-  private String username;
-  private String password;
-  private String sslKeyRepository;
+  private String name = "UNKNOWN";
+  @Nullable private String channelName;
+  @Nullable private String transportType;
+  @Nullable private String username;
+  @Nullable private String password;
+  @Nullable private String sslKeyRepository;
   private int ccsid = Integer.MIN_VALUE;
   private int encoding = Integer.MIN_VALUE;
-  private String cipherSuite;
-  private String cipherSpec;
-  private String replyQueuePrefix;
-  private String modelQueueName;
+  @Nullable private String cipherSuite;
+  @Nullable private String cipherSpec;
+  @Nullable private String replyQueuePrefix;
+  @Nullable private String modelQueueName;
   private String configurationQueueName = "SYSTEM.ADMIN.CONFIG.EVENT";
   private String performanceEventsQueueName = "SYSTEM.ADMIN.PERFM.EVENT";
   private String queueManagerEventsQueueName = "SYSTEM.ADMIN.QMGR.EVENT";
@@ -34,14 +35,12 @@ public class QueueManager {
   // https://www.ibm.com/docs/en/ibm-mq/9.3.x?topic=qmini-channels-stanza-file
   private int maxActiveChannels = 100;
 
-  private ResourceFilters queueFilters;
-  private ResourceFilters channelFilters;
-  private ResourceFilters listenerFilters;
-  private ResourceFilters topicFilters;
+  @Nullable private ResourceFilters queueFilters;
+  @Nullable private ResourceFilters channelFilters;
+  @Nullable private ResourceFilters listenerFilters;
+  @Nullable private ResourceFilters topicFilters;
 
-  List<String> writeStatsDirectory;
-
-  public String getHost() {
+  public @Nullable String getHost() {
     return host;
   }
 
@@ -65,35 +64,35 @@ public void setName(String name) {
     this.name = name;
   }
 
-  public String getChannelName() {
+  public @Nullable String getChannelName() {
     return channelName;
   }
 
-  public void setChannelName(String channelName) {
+  public void setChannelName(@Nullable String channelName) {
     this.channelName = channelName;
   }
 
-  public String getTransportType() {
+  public @Nullable String getTransportType() {
     return transportType;
   }
 
-  public void setTransportType(String transportType) {
+  public void setTransportType(@Nullable String transportType) {
     this.transportType = transportType;
   }
 
-  public String getUsername() {
+  public @Nullable String getUsername() {
     return username;
   }
 
-  public void setUsername(String username) {
+  public void setUsername(@Nullable String username) {
     this.username = username;
   }
 
-  public String getPassword() {
+  public @Nullable String getPassword() {
     return password;
   }
 
-  public void setPassword(String password) {
+  public void setPassword(@Nullable String password) {
     this.password = password;
   }
 
@@ -104,31 +103,31 @@ public ResourceFilters getQueueFilters() {
     return queueFilters;
   }
 
-  public void setQueueFilters(ResourceFilters queueFilters) {
+  public void setQueueFilters(@Nullable ResourceFilters queueFilters) {
     this.queueFilters = queueFilters;
   }
 
-  public String getSslKeyRepository() {
+  public @Nullable String getSslKeyRepository() {
     return sslKeyRepository;
   }
 
-  public void setSslKeyRepository(String sslKeyRepository) {
+  public void setSslKeyRepository(@Nullable String sslKeyRepository) {
     this.sslKeyRepository = sslKeyRepository;
   }
 
-  public String getCipherSuite() {
+  public @Nullable String getCipherSuite() {
     return cipherSuite;
   }
 
   public void setCipherSuite(String cipherSuite) {
     this.cipherSuite = cipherSuite;
   }
 
-  public String getCipherSpec() {
+  public @Nullable String getCipherSpec() {
     return cipherSpec;
   }
 
-  public void setCipherSpec(String cipherSpec) {
+  public void setCipherSpec(@Nullable String cipherSpec) {
     this.cipherSpec = cipherSpec;
   }
 
@@ -139,23 +138,23 @@ public ResourceFilters getChannelFilters() {
     return channelFilters;
   }
 
-  public void setChannelFilters(ResourceFilters channelFilters) {
+  public void setChannelFilters(@Nullable ResourceFilters channelFilters) {
     this.channelFilters = channelFilters;
   }
 
-  public String getReplyQueuePrefix() {
+  public @Nullable String getReplyQueuePrefix() {
     return replyQueuePrefix;
   }
 
-  public void setReplyQueuePrefix(String replyQueuePrefix) {
+  public void setReplyQueuePrefix(@Nullable String replyQueuePrefix) {
     this.replyQueuePrefix = replyQueuePrefix;
   }
 
-  public String getModelQueueName() {
+  public @Nullable String getModelQueueName() {
     return modelQueueName;
   }
 
-  public void setModelQueueName(String modelQueueName) {
+  public void setModelQueueName(@Nullable String modelQueueName) {
     this.modelQueueName = modelQueueName;
   }
 
@@ -166,7 +165,7 @@ public ResourceFilters getListenerFilters() {
     return listenerFilters;
   }
 
-  public void setListenerFilters(ResourceFilters listenerFilters) {
+  public void setListenerFilters(@Nullable ResourceFilters listenerFilters) {
     this.listenerFilters = listenerFilters;
   }
 
@@ -193,7 +192,7 @@ public ResourceFilters getTopicFilters() {
     return topicFilters;
   }
 
-  public void setTopicFilters(ResourceFilters topicFilters) {
+  public void setTopicFilters(@Nullable ResourceFilters topicFilters) {
     this.topicFilters = topicFilters;
   }
 

ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/metricscollector/MetricsCollectorContext.java

@@ -15,11 +15,11 @@
 import io.opentelemetry.ibm.mq.config.QueueManager;
 import io.opentelemetry.ibm.mq.metrics.MetricsConfig;
 import java.io.IOException;
-import java.util.*;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Set;
 import javax.annotation.concurrent.Immutable;
 import org.jetbrains.annotations.NotNull;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * A temporary bundle to contain the collaborators of the original MetricsCollector base class until
@@ -29,8 +29,6 @@
 @Immutable
 public final class MetricsCollectorContext {
 
-  private static final Logger logger = LoggerFactory.getLogger(MetricsCollectorContext.class);
-
   private final QueueManager queueManager;
   private final PCFMessageAgent agent;
   private final MQQueueManager mqQueueManager;

ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/opentelemetry/Main.java

@@ -7,7 +7,7 @@
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.metrics.MeterProvider;
-import io.opentelemetry.ibm.mq.WMQMonitor;
+import io.opentelemetry.ibm.mq.WmqMonitor;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import io.opentelemetry.sdk.resources.Resource;
@@ -76,7 +76,7 @@ public static void run(
     MeterProvider meterProvider = otel.getMeterProvider();
 
     Runtime.getRuntime().addShutdownHook(new Thread(service::shutdown));
-    WMQMonitor monitor = new WMQMonitor(config, service, meterProvider.get("websphere/mq"));
+    WmqMonitor monitor = new WmqMonitor(config, service, meterProvider.get("websphere/mq"));
     service.scheduleAtFixedRate(
         monitor::run,
         config.getTaskInitialDelaySeconds(),