Merge pull request #13 from Appdynamics/2.1.0

2.1.0

Author: kunalgupApDx

CHANGELOG.md

@@ -1,5 +1,9 @@
 # AppDynamics Extensions SDK CHANGELOG
 
+## 2.1.0 - Apr 5, 2018
+1. Extracted Configuration and Context from the MonitorConfiguration and dissolved it.
+2. onConfigReload(File file) will now have access to configuration and context after the refactoring.
+
 ## 2.0.4 - Mar 13, 2018
 1. Implemented mutual SSL Authentication
 

pom.xml

@@ -19,7 +19,7 @@
 
     <groupId>com.appdynamics</groupId>
     <artifactId>appd-exts-commons</artifactId>
-    <version>2.0.4</version>
+    <version>2.1.0</version>
     <packaging>jar</packaging>
     <name>extension-utils</name>
     <properties>

src/main/java/com/appdynamics/extensions/ABaseMonitor.java

@@ -15,7 +15,11 @@
 
 package com.appdynamics.extensions;
 
-import com.appdynamics.extensions.conf.MonitorConfiguration;
+import com.appdynamics.extensions.conf.MonitorContextConfiguration;
+import com.appdynamics.extensions.conf.MonitorContext;
+import com.appdynamics.extensions.file.FileWatchListener;
+import com.appdynamics.extensions.util.AssertUtils;
+import com.appdynamics.extensions.util.PathResolver;
 import com.singularity.ee.agent.systemagent.api.AManagedMonitor;
 import com.singularity.ee.agent.systemagent.api.TaskExecutionContext;
 import com.singularity.ee.agent.systemagent.api.TaskOutput;
@@ -35,7 +39,7 @@
  * <p>An {@code ABaseMonitor} is a wrapper on top of
  * {@link AManagedMonitor} to remove the boiler plate code of
  * creating a {@link AMonitorJob} and initializing the
- * {@link MonitorConfiguration}.
+ * {@link MonitorContextConfiguration}.
  *
  * <p>The MA or SIM agent loads all the {@link AManagedMonitor}s
  * from their respective subdirectories in the monitors directory
@@ -87,11 +91,13 @@ public abstract class ABaseMonitor extends AManagedMonitor{
      */
     protected String monitorName;
 
+    private File installDir;
+
     /**
-     * A configuration object that reads the monitor's config file
+     * A contextConfiguration object that reads the monitor's config file
      * and initializes the different bits required by the monitor.
      */
-    protected MonitorConfiguration configuration;
+    private MonitorContextConfiguration contextConfiguration;
 
     /**
      * A runnable which does all the leg work for fetching the
@@ -104,21 +110,39 @@ public ABaseMonitor(){
         logger.info("Using {} Version [{}]",monitorName, getImplementationVersion());
     }
 
-    protected void initialize(Map<String, String> args) {
-        if(configuration == null){
+    protected void initialize(final Map<String, String> args) {
+        if(contextConfiguration == null){
+            installDir = getInstallDirectory();
             monitorJob = createMonitorJob();
-            MonitorConfiguration conf = new MonitorConfiguration(monitorName,getDefaultMetricPrefix(), monitorJob);
-            conf.setConfigYml(args.get("config-file"), new MonitorConfiguration.FileWatchListener() {
-                @Override
-                public void onFileChange(File file) {
-                    onConfigReload(file);
-                }
-            });
-            initializeMoreStuff(args, conf);
-            this.configuration = conf;
+            contextConfiguration = createContextConfiguration();
+            contextConfiguration.registerListener(args.get("config-file"), createYmlFileListener(args.get("config-file")));
+            initializeMoreStuff(args);
         }
     }
 
+    private FileWatchListener createYmlFileListener(final String ymlFile) {
+        FileWatchListener fileWatchListener = new FileWatchListener() {
+            @Override
+            public void onFileChange(File file) {
+                contextConfiguration.setConfigYml(ymlFile);
+                onConfigReload(file);
+            }
+        };
+        return fileWatchListener;
+    }
+
+    private File getInstallDirectory() {
+        File installDir = PathResolver.resolveDirectory(AManagedMonitor.class);
+        if(installDir == null){
+            throw new RuntimeException("The install directory cannot be null");
+        }
+        return installDir;
+    }
+
+    private MonitorContextConfiguration createContextConfiguration() {
+        return new MonitorContextConfiguration(getMonitorName(), getDefaultMetricPrefix(), installDir, monitorJob);
+    }
+
     protected void onConfigReload(File file){};
 
     protected AMonitorJob createMonitorJob() {
@@ -128,9 +152,9 @@ protected AMonitorJob createMonitorJob() {
     /**
      * A placeholder method which should be overridden if there are
      * custom objects to be initialized in the monitor.
-     * @param conf
+     * @param args
      */
-    protected void initializeMoreStuff(Map<String, String> args, MonitorConfiguration conf) {
+    protected void initializeMoreStuff(Map<String, String> args) {
         ;
     }
 
@@ -154,8 +178,10 @@ public TaskOutput execute(Map<String, String> args, TaskExecutionContext taskExe
     }
 
     protected void executeMonitor() {
-        if(configuration.isEnabled()){
-            if(configuration.isScheduledModeEnabled()){ //scheduled mode
+        if(contextConfiguration.isEnabled()){
+            MonitorContext context = contextConfiguration.getContext();
+            AssertUtils.assertNotNull(context, "The context of the extension has not been initialised!!!! Please check your contextConfiguration");
+            if(context.isScheduledModeEnabled()){ //scheduled mode
                 logger.debug("Task scheduler is enabled, printing the metrics from the cache");
                 monitorJob.printAllFromCache();
             }
@@ -175,8 +201,8 @@ protected static String getImplementationVersion() {
 
     public abstract String getMonitorName();
 
-    public MonitorConfiguration getConfiguration(){
-        return configuration;
+    public MonitorContextConfiguration getContextConfiguration() {
+        return contextConfiguration;
     }
 
     protected abstract void doRun(TasksExecutionServiceProvider tasksExecutionServiceProvider);
@@ -186,4 +212,5 @@ public MonitorConfiguration getConfiguration(){
     protected void onComplete() {
         logger.info("Finished processing all tasks in the job for {}",getMonitorName());
     }
+
 }

src/main/java/com/appdynamics/extensions/AMonitorJob.java

@@ -45,7 +45,7 @@ public void run() {
     }
 
     public void printAllFromCache() {
-        ConcurrentMap<String, Metric> map = baseMonitor.configuration.getCachedMetrics();
+        ConcurrentMap<String, Metric> map = baseMonitor.getContextConfiguration().getContext().getCachedMetrics();
         Set<String> keys;
         if (map != null && (keys = map.keySet()) != null) {
             for (String key : keys) {

src/main/java/com/appdynamics/extensions/MetricWriteHelper.java

@@ -54,15 +54,15 @@ protected MetricWriteHelper() {
     public MetricWriteHelper(ABaseMonitor baseMonitor) {
         AssertUtils.assertNotNull(baseMonitor, "The ABaseMonitor instance cannot be null");
         this.baseMonitor = baseMonitor;
-        derivedMetricsCalculator = baseMonitor.getConfiguration().createDerivedMetricsCalculator();
+        derivedMetricsCalculator = baseMonitor.getContextConfiguration().getContext().createDerivedMetricsCalculator();
     }
 
     public void printMetric(String metricPath, String metricValue, String aggregationType, String timeRollup, String clusterRollup) {
         if (validateStrings(metricPath, metricValue, timeRollup, clusterRollup) && isValidMetricValue(metricValue)) {
-            if (baseMonitor.getConfiguration().isScheduledModeEnabled()) {
+            if (baseMonitor.getContextConfiguration().getContext().isScheduledModeEnabled()) {
                 Metric metric = new Metric(MetricPathUtils.getMetricName(metricPath), metricValue, metricPath, aggregationType, timeRollup, clusterRollup);
                 logger.debug("Scheduled mode is enabled, caching the metric {}", metric);
-                baseMonitor.getConfiguration().putInMetricCache(metricPath, metric);
+                baseMonitor.getContextConfiguration().getContext().putInMetricCache(metricPath, metric);
             } else {
                 MetricWriter metricWriter = getMetricWriter(metricPath, aggregationType, timeRollup, clusterRollup);
                 metricWriter.printMetric(metricValue);
@@ -71,7 +71,7 @@ public void printMetric(String metricPath, String metricValue, String aggregatio
                 }
                 if (cacheMetrics) {
                     Metric metric = new Metric(MetricPathUtils.getMetricName(metricPath), metricValue, metricPath, aggregationType, timeRollup, clusterRollup);
-                    baseMonitor.getConfiguration().putInMetricCache(metricPath, metric);
+                    baseMonitor.getContextConfiguration().getContext().putInMetricCache(metricPath, metric);
                 }
             }
             addForDerivedMetricsCalculation(metricPath, metricValue);
@@ -117,10 +117,10 @@ public void printMetric(String metricPath, BigDecimal value, String metricType)
     }
 
     public MetricWriter getMetricWriter(String metricPath, String aggregationType, String timeRollup, String clusterRollup) {
-        MetricWriter writer = baseMonitor.getConfiguration().getFromWriterCache(metricPath);
+        MetricWriter writer = baseMonitor.getContextConfiguration().getContext().getFromWriterCache(metricPath);
         if (writer == null) {
             writer = baseMonitor.getMetricWriter(metricPath, aggregationType, timeRollup, clusterRollup);
-            baseMonitor.getConfiguration().putInWriterCache(metricPath, writer);
+            baseMonitor.getContextConfiguration().getContext().putInWriterCache(metricPath, writer);
         }
         return writer;
     }
@@ -189,7 +189,7 @@ private String[] createMetricType(String metricType) {
     }
 
     public Set<String> getMetricPaths() {
-        ConcurrentMap<String, Metric> map = baseMonitor.configuration.getCachedMetrics();
+        ConcurrentMap<String, Metric> map = baseMonitor.getContextConfiguration().getContext().getCachedMetrics();
         if(map != null){
             return map.keySet();
         }

src/main/java/com/appdynamics/extensions/MetricWriteHelperFactory.java

@@ -15,11 +15,12 @@
 
 package com.appdynamics.extensions;
 
-import com.appdynamics.extensions.conf.MonitorConfiguration;
 import com.appdynamics.extensions.workbench.metric.WorkbenchMetricStore;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import static com.appdynamics.extensions.conf.MonitorContext.isWorkbenchMode;
+
 /**
  * Created by abey.tom on 3/20/16.
  */
@@ -28,7 +29,7 @@ public class MetricWriteHelperFactory {
 
     public static MetricWriteHelper create(ABaseMonitor baseMonitor) {
         MetricWriteHelper helper;
-        if (MonitorConfiguration.isWorkbenchMode()) {
+        if (isWorkbenchMode()) {
             helper = WorkbenchMetricStore.getInstance();
         } else {
             helper = new MetricWriteHelper(baseMonitor);

src/main/java/com/appdynamics/extensions/TaskInputArgs.java

@@ -34,19 +34,7 @@ public class TaskInputArgs {
     public static final String URI = "uri";
     public static final String PORT = "port";
     public static final String USE_SSL = "useSsl";
-    public static final String DISABLE_SSL_CERT_VALIDATION = "disable-ssl-cert-validation";
     public static final String METRIC_PREFIX = "metric-prefix";
-    public static final String TRUST_STORE_FILE = "trust-store-file";
-    public static final String TRUST_STORE_PWD = "trust-store-password";
-    public static final String SSL_VERIFY_HOSTNAME = "ssl-verify-hostname";
-    public static final String PROXY_URI = "proxy-uri";
-    public static final String PROXY_HOST = "proxy-host";
-    public static final String PROXY_PORT = "proxy-port";
-    public static final String PROXY_USER = "proxy-username";
-    public static final String PROXY_PASSWORD = "proxy-password";
-    public static final String PROXY_PASSWORD_ENCRYPTED = "proxy-password-encrypted";
-    public static final String PROXY_USE_SSL = "proxy-use-ssl";
-    public static final String PROXY_AUTH_TYPE = "proxy-auth-type";
     public static final String ENCRYPTION_KEY = "encryptionKey";
     public static final String SSL_PROTOCOL = "sslProtocols";
 

src/main/java/com/appdynamics/extensions/TasksExecutionServiceProvider.java

@@ -15,14 +15,9 @@
 
 package com.appdynamics.extensions;
 
-import com.appdynamics.extensions.conf.MonitorConfiguration;
-import org.apache.commons.httpclient.util.ExceptionUtil;
-import org.apache.http.util.ExceptionUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.io.PrintWriter;
-import java.io.StringWriter;
 import java.util.concurrent.atomic.AtomicInteger;
 
 /*
@@ -46,7 +41,7 @@ public TasksExecutionServiceProvider(ABaseMonitor aBaseMonitor, MetricWriteHelpe
 
 
     public void submit(final String name, final AMonitorTaskRunnable aServerTask){
-        aBaseMonitor.getConfiguration().getExecutorService().submit(name,new Runnable() {
+        aBaseMonitor.getContextConfiguration().getContext().getExecutorService().submit(name,new Runnable() {
             @Override
             public void run() {
                 try{
@@ -73,8 +68,4 @@ private void onRunComplete(){
     public MetricWriteHelper getMetricWriteHelper() {
         return this.metricWriteHelper;
     }
-
-    public MonitorConfiguration getMonitorConfiguration(){
-        return this.aBaseMonitor.configuration;
-    }
 }