HeartBeat Feature Implementation

core/src/main/java/com/microsoft/applicationinsights/internal/heartbeat/BaseDefaultHeartbeatPropertyProvider.java → core/src/main/java/com/microsoft/applicationinsights/internal/heartbeat/DefaultHeartbeatPropertyProvider.java

@@ -14,14 +14,14 @@
  * <h1>Base Heartbeat Property Provider</h1>
  *
  * <p>
- *   This class is a concrete implementation of {@link com.microsoft.applicationinsights.internal.heartbeat.HeartBeatDefaultPayloadProviderInterface}
+ *   This class is a concrete implementation of {@link HeartBeatPayloadProviderInterface}
  *   It enables setting SDK Metadata to heartbeat payload.
  * </p>
  *
  * @author Dhaval Doshi
  * @since 03-30-2018
  */
-public class BaseDefaultHeartbeatPropertyProvider implements HeartBeatDefaultPayloadProviderInterface {
+public class DefaultHeartbeatPropertyProvider implements HeartBeatPayloadProviderInterface {
 
   /**
    * Collection holding default properties for this default provider.
@@ -38,9 +38,17 @@ public class BaseDefaultHeartbeatPropertyProvider implements HeartBeatDefaultPay
   /**
    * Name of this provider.
    */
-  private final String name = "Base";
+  private final String name = "Default";
 
-  public BaseDefaultHeartbeatPropertyProvider() {
+  private final String JRE_VERSION = "jreVersion";
+
+  private final String SDK_VERSION = "sdkVersion";
+
+  private final String OS_VERSION = "osVersion";
+
+  private final String PROCESS_SESSION_ID = "processSessionId";
+
+  public DefaultHeartbeatPropertyProvider() {
     defaultFields = new HashSet<>();
     initializeDefaultFields(defaultFields);
   }
@@ -51,7 +59,7 @@ public String getName() {
   }
 
   @Override
-  public boolean isKeyWord(String keyword) {
+  public boolean isKeyword(String keyword) {
     return defaultFields.contains(keyword);
   }
 
@@ -60,27 +68,26 @@ public Callable<Boolean> setDefaultPayload(final List<String> disableFields,
       final HeartBeatProviderInterface provider) {
     return new Callable<Boolean>() {
 
-      // using volatile here to avoid caching in threads.
-      volatile boolean hasSetValues = false;
       volatile Set<String> enabledProperties = MiscUtils.except(defaultFields, disableFields);
       @Override
       public Boolean call() {
+        boolean hasSetValues = false;
         for (String fieldName : enabledProperties) {
           try {
             switch (fieldName) {
-              case "jdkVersion":
-                provider.addHeartBeatProperty(fieldName, getJdkVersion(), true);
+              case JRE_VERSION:
+                provider.addHeartBeatProperty(fieldName, getJreVersion(), true);
                 hasSetValues = true;
                 break;
-              case "sdk-version":
+              case SDK_VERSION:
                 provider.addHeartBeatProperty(fieldName, getSdkVersion(), true);
                 hasSetValues = true;
                 break;
-              case "osType":
-                provider.addHeartBeatProperty(fieldName, getOsType(), true);
+              case OS_VERSION:
+                provider.addHeartBeatProperty(fieldName, getOsVersion(), true);
                 hasSetValues = true;
                 break;
-              case "processSessionId":
+              case PROCESS_SESSION_ID:
                 provider.addHeartBeatProperty(fieldName, getProcessSessionId(), true);
                 hasSetValues = true;
                 break;
@@ -109,17 +116,17 @@ private void initializeDefaultFields(Set<String> defaultFields) {
     if (defaultFields == null) {
       defaultFields = new HashSet<>();
     }
-    defaultFields.add("jdkVersion");
-    defaultFields.add("sdk-version");
-    defaultFields.add("osType");
-    defaultFields.add("processSessionId");
+    defaultFields.add(JRE_VERSION);
+    defaultFields.add(SDK_VERSION);
+    defaultFields.add(OS_VERSION);
+    defaultFields.add(PROCESS_SESSION_ID);
   }
 
   /**
    * Gets the JDK version being used by the application
    * @return String representing JDK Version
    */
-  private String getJdkVersion() {
+  private String getJreVersion() {
     return System.getProperty("java.version");
   }
 
@@ -145,7 +152,7 @@ private String getSdkVersion() {
    * Gets the OS version on which application is running.
    * @return String representing OS version
    */
-  private String getOsType() {
+  private String getOsVersion() {
     return System.getProperty("os.name");
   }
 

core/src/main/java/com/microsoft/applicationinsights/internal/heartbeat/HeartBeatModule.java

@@ -161,9 +161,9 @@ public void setHeartBeatEnabled(boolean heartBeatEnabled) {
 
   @Override
   public void initialize(TelemetryConfiguration configuration) {
-    if (!isInitialized) {
+    if (!isInitialized && isHeartBeatEnabled()) {
       synchronized (lock) {
-        if (!isInitialized) {
+        if (!isInitialized && isHeartBeatEnabled()) {
           this.heartBeatProviderInterface.initialize(configuration);
           InternalLogger.INSTANCE.info("heartbeat is enabled");
           isInitialized = true;

core/src/main/java/com/microsoft/applicationinsights/internal/heartbeat/HeartBeatDefaultPayloadProviderInterface.java → core/src/main/java/com/microsoft/applicationinsights/internal/heartbeat/HeartBeatPayloadProviderInterface.java

@@ -10,14 +10,14 @@
  *   This interface is used to set the default payload of a provider and defines implementation for
  *   some helper methods to assist it.
  *
- *   The default concrete implementations are {@link com.microsoft.applicationinsights.internal.heartbeat.BaseDefaultHeartbeatPropertyProvider}
- *   and {@link com.microsoft.applicationinsights.internal.heartbeat.WebAppsDefaultHeartbeatProvider}
+ *   The default concrete implementations are {@link DefaultHeartbeatPropertyProvider}
+ *   and {@link WebAppsHeartbeatProvider}
  * </p>
  *
  * @author Dhaval Doshi
  * @since 03-30-2018
  */
-public interface HeartBeatDefaultPayloadProviderInterface {
+public interface HeartBeatPayloadProviderInterface {
 
   /**
    * Returns the name of the heartbeat provider.
@@ -30,7 +30,7 @@ public interface HeartBeatDefaultPayloadProviderInterface {
    * @param keyword string to test
    * @return true if input string is reserved keyword
    */
-  boolean isKeyWord(String keyword);
+  boolean isKeyword(String keyword);
 
   /**
    * Returns a callable which can be executed to set the payload based on the parameters.

core/src/main/java/com/microsoft/applicationinsights/internal/heartbeat/HeartBeatProvider.java

@@ -4,6 +4,7 @@
 import com.microsoft.applicationinsights.TelemetryConfiguration;
 import com.microsoft.applicationinsights.internal.logger.InternalLogger;
 import com.microsoft.applicationinsights.internal.shutdown.Stoppable;
+import com.microsoft.applicationinsights.internal.util.ThreadPoolUtils;
 import com.microsoft.applicationinsights.telemetry.MetricTelemetry;
 import com.microsoft.applicationinsights.telemetry.Telemetry;
 import java.util.ArrayList;
@@ -15,6 +16,7 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicLong;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.exception.ExceptionUtils;
@@ -69,12 +71,12 @@ public class HeartBeatProvider implements HeartBeatProviderInterface, Stoppable
   /**
    * ThreadPool used for adding properties to concurrent dictionary
    */
-  private ExecutorService executorService = Executors.newCachedThreadPool();
+  private ExecutorService propertyUpdateService;
 
   /**
    * Threadpool used to send data heartbeat telemetry
    */
-  private ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(1);
+  private ScheduledExecutorService heartBeatSenderService;
 
   /**
    * Heartbeat enabled state
@@ -88,6 +90,8 @@ public HeartBeatProvider() {
     this.heartbeatProperties = new ConcurrentHashMap<>();
     this.isEnabled = true;
     this.heartbeatsSent = new AtomicLong(0);
+    this.propertyUpdateService = Executors.newCachedThreadPool(ThreadPoolUtils.createDaemonThreadFactory(HeartBeatProvider.class));
+    this.heartBeatSenderService = Executors.newScheduledThreadPool(1, ThreadPoolUtils.createDaemonThreadFactory(HeartBeatProvider.class));
   }
 
   @Override
@@ -111,12 +115,10 @@ public void initialize(TelemetryConfiguration configuration) {
 
       //Submit task to set properties to dictionary using separate thread. we do not wait for the
       //results to come out as some I/O bound properties may take time.
-      executorService.submit(HeartbeatDefaultPayload.populateDefaultPayload(getExcludedHeartBeatProperties(),
+      propertyUpdateService.submit(HeartbeatDefaultPayload.populateDefaultPayload(getExcludedHeartBeatProperties(),
           getExcludedHeartBeatPropertyProviders(), this));
 
-
-
-      scheduledExecutorService.scheduleAtFixedRate(heartBeatPulse(), interval, interval, TimeUnit.SECONDS);
+      heartBeatSenderService.scheduleAtFixedRate(heartBeatPulse(), interval, interval, TimeUnit.SECONDS);
     }
   }
 
@@ -133,10 +135,10 @@ public boolean addHeartBeatProperty(String propertyName, String propertyValue,
              payload.setPayloadValue(propertyValue);
              heartbeatProperties.put(propertyName, payload);
              isAdded = true;
-             InternalLogger.INSTANCE.trace("added heartbeat property");
+             InternalLogger.INSTANCE.trace("added heartbeat property %s - %s", propertyName, propertyValue);
         }
         else {
-          throw new Exception("heartbeat property cannot be added twice");
+          throw new Exception("heartbeat property cannot be added twice. Please use setHeartBeatProperty instead to modify the value");
         }
       } catch (Exception e) {
         InternalLogger.INSTANCE.warn("Failed to add the property %s value %s, stack trace is : %s," ,
@@ -156,17 +158,21 @@ public boolean setHeartBeatProperty(String propertyName, String propertyValue,
     boolean setResult = false;
     if (!StringUtils.isEmpty(propertyName)) {
       try {
-        if (heartbeatProperties.containsKey(propertyName) && !HeartbeatDefaultPayload.isDefaultKeyWord(propertyName)) {
+
+        if (!heartbeatProperties.containsKey(propertyName)) {
+          setResult = false;
+          throw new Exception("heartbeat property cannot be set without adding it first");
+        } else if (HeartbeatDefaultPayload.isDefaultKeyword(propertyName)) {
+          setResult = false;
+          throw new Exception("heartbeat beat property specified is a reserved property");
+        }
+        else  {
           HeartBeatPropertyPayload payload = new HeartBeatPropertyPayload();
           payload.setHealthy(isHealthy);
           payload.setPayloadValue(propertyValue);
           heartbeatProperties.put(propertyName, payload);
           setResult = true;
         }
-        else {
-          throw new Exception("heartbeat property cannot be set without adding it first, or heartbeat"
-              + "beat property specified is a reserved property");
-        }
       }
       catch (Exception e) {
         InternalLogger.INSTANCE.warn("failed to set heartbeat property name %s, value %s, "
@@ -228,11 +234,11 @@ public void setExcludedHeartBeatProperties(List<String> excludedHeartBeatPropert
 
   @Override
   public void stop(long timeout, TimeUnit timeUnit) {
-    executorService.shutdown();
-    scheduledExecutorService.shutdown();
+    propertyUpdateService.shutdown();
+    heartBeatSenderService.shutdown();
     try {
-      executorService.awaitTermination(timeout, timeUnit);
-      scheduledExecutorService.awaitTermination(timeout, timeUnit);
+      propertyUpdateService.awaitTermination(timeout, timeUnit);
+      heartBeatSenderService.awaitTermination(timeout, timeUnit);
     }
     catch (InterruptedException e) {
       InternalLogger.INSTANCE.warn("unable to successfully terminate heartbeat module, "

core/src/main/java/com/microsoft/applicationinsights/internal/heartbeat/HeartbeatDefaultPayload.java

@@ -6,24 +6,24 @@
 
 public class HeartbeatDefaultPayload {
 
-  private static final List<HeartBeatDefaultPayloadProviderInterface> defaultPayloadProviders =
+  private static final List<HeartBeatPayloadProviderInterface> defaultPayloadProviders =
       new ArrayList<>();
 
   static {
-    defaultPayloadProviders.add(new BaseDefaultHeartbeatPropertyProvider());
-    defaultPayloadProviders.add(new WebAppsDefaultHeartbeatProvider());
+    defaultPayloadProviders.add(new DefaultHeartbeatPropertyProvider());
+    defaultPayloadProviders.add(new WebAppsHeartbeatProvider());
   }
 
-  public static boolean isDefaultKeyWord(String keyword) {
-    for (HeartBeatDefaultPayloadProviderInterface payloadProvider : defaultPayloadProviders) {
-      if (payloadProvider.isKeyWord(keyword)) {
+  public static boolean isDefaultKeyword(String keyword) {
+    for (HeartBeatPayloadProviderInterface payloadProvider : defaultPayloadProviders) {
+      if (payloadProvider.isKeyword(keyword)) {
         return true;
       }
     }
     return false;
   }
 
-  public static boolean addDefaultPayLoadProvider(HeartBeatDefaultPayloadProviderInterface payloadProviderInterface) {
+  public static boolean addDefaultPayLoadProvider(HeartBeatPayloadProviderInterface payloadProviderInterface) {
     if (payloadProviderInterface != null) {
       defaultPayloadProviders.add(payloadProviderInterface);
       return true;
@@ -38,7 +38,7 @@ public static Callable<Boolean> populateDefaultPayload(final List<String> disabl
       volatile boolean populatedFields = false;
       @Override
       public Boolean call() throws Exception {
-        for (HeartBeatDefaultPayloadProviderInterface payloadProvider : defaultPayloadProviders) {
+        for (HeartBeatPayloadProviderInterface payloadProvider : defaultPayloadProviders) {
           if (disabledProviders != null && disabledProviders.contains(payloadProvider.getName())) {
 
             // skip any azure specific modules here

core/src/main/java/com/microsoft/applicationinsights/internal/heartbeat/MiscUtils.java

@@ -15,7 +15,7 @@
 public class MiscUtils {
 
   /**
-   * Returns a list which contains Items present in list2 but not in the set.
+   * Returns a list which contains items present in list2 but not in the set.
    * @param set
    * @param list2
    * @return