Merge branch 'main' into duplicate-checker-fix

Author: pc9795

.github/workflows/greetings.yml

@@ -0,0 +1,13 @@
+name: Greetings
+
+on: [pull_request, issues]
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/first-interaction@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        issue-message: 'Thanks for reporting this issue. We will get back to you in a while'
+        pr-message: 'Great Job for your first PR in this repository'

.github/workflows/stale.yml

@@ -0,0 +1,19 @@
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: "30 1 * * *"
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/stale@v3
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue is stale'
+        stale-pr-message: 'This PR is stale'
+        stale-issue-label: 'stale'
+        stale-pr-label: 'stale'

Readme.md README.mdReadme.md renamed to README.md

@@ -32,6 +32,31 @@ class ExampleApp{
 }
 ```
 
+**Builder Pattern**
+
+We love our builders!!! This project heavily utilized the use of builders instead of traditional object creation
+using `new`. We do this with the help of Project Lombok's `@Builder` annotation. Read more about the
+project [here](https://projectlombok.org/features/all). Read more about the
+annotation [here](https://projectlombok.org/features/Builder). Read more about the builder
+pattern [here](https://refactoring.guru/design-patterns/builder).
+
+_Example: Customizing your Event Queue implementation_
+
+```
+EventQueueIF queue = //get your implementation
+Configuration configuration =
+    Configuration.builder().serverUrl("http://your-server-url").apiKey("your-api-key").build();
+ConfigurationManager configurationManager =
+    ConfigurationManager.builder().queue(queue).configuration(configuration).build();
+ExceptionlessClient client =
+    ExceptionlessClient.builder().configurationManager(configurationManager).build();
+```
+
+In this library we have made sure that all the values which are not set by builders fallback to reasonable defaults. So
+don't feel the pressure to supply values for all the fields. **Note:** Whenever customizing the client
+using `ConfigurationManager` never forget to supply your `serverUrl` and `apiKey` using a `Configuration` object as
+shown above.
+
 ## Spring Boot Users
 
 You can observe `NoClassDefFoundError` in your Spring-boot apps because Spring-boot uses v3 of `OkHttpClient` while this client uses v4. In that case you have to explicitly declare v4 of the library in you `pom.xml/build.gradle`.

samples/example-app/src/main/java/com/exceptionless/example/app/ExampleApp.java

@@ -20,15 +20,12 @@ public static void sampleEventSubmissions() {
 
   public static void sampleUseOfSessions() {
     client.getConfigurationManager().useSessions();
-    client.submitEvent(
-        EventPluginContext.from(client.createSessionStart().userIdentity("test-user").build()));
+    client.submitEvent(client.createSessionStart().userIdentity("test-user").build());
     client.submitSessionEnd("test-user");
   }
 
   public static void sampleUseOfUpdatingEmailAndDescription() {
-    client.submitEvent(
-        EventPluginContext.from(
-            client.createLog("test-log").referenceId("test-reference-id").build()));
+    client.submitEvent(client.createLog("test-log").referenceId("test-reference-id").build());
     client.updateEmailAndDescription("test-reference-id", "[email protected]", "test-description");
   }
 

src/main/java/com/exceptionless/exceptionlessclient/ExceptionlessClient.java

@@ -2,19 +2,18 @@
 
 import com.exceptionless.exceptionlessclient.configuration.Configuration;
 import com.exceptionless.exceptionlessclient.configuration.ConfigurationManager;
+import com.exceptionless.exceptionlessclient.enums.EventPropertyKey;
+import com.exceptionless.exceptionlessclient.enums.EventType;
 import com.exceptionless.exceptionlessclient.models.Event;
 import com.exceptionless.exceptionlessclient.models.EventPluginContext;
 import com.exceptionless.exceptionlessclient.models.PluginContext;
 import com.exceptionless.exceptionlessclient.models.UserDescription;
-import com.exceptionless.exceptionlessclient.models.enums.EventPropertyKey;
-import com.exceptionless.exceptionlessclient.models.enums.EventType;
-import com.exceptionless.exceptionlessclient.models.submission.SubmissionResponse;
 import com.exceptionless.exceptionlessclient.plugins.EventPluginRunner;
+import com.exceptionless.exceptionlessclient.submission.SubmissionResponse;
 import com.exceptionless.exceptionlessclient.utils.VisibleForTesting;
 import lombok.Builder;
 import lombok.Getter;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import lombok.extern.slf4j.Slf4j;
 
 import java.time.LocalDate;
 import java.util.Timer;
@@ -23,8 +22,8 @@
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 
+@Slf4j
 public class ExceptionlessClient {
-  private static final Logger LOG = LoggerFactory.getLogger(ExceptionlessClient.class);
   private static final String UPDATE_SETTINGS_TIMER_NAME = "update-settings-timer";
   private static final int UPDATE_SETTINGS_TIMER_INITIAL_DELAY = 5000;
   private static final Integer DEFAULT_NTHREADS = 10;
@@ -63,7 +62,7 @@ public void run() {
             try {
               configurationManager.getSettingsManager().updateSettings();
             } catch (Exception e) {
-              LOG.error("Error in updating settings", e);
+              log.error("Error in updating settings", e);
             }
           }
         },
@@ -92,12 +91,26 @@ public CompletableFuture<Void> submitExceptionAsync(Exception exception) {
   }
 
   public void submitException(Exception exception) {
-    Event event = createException().build();
+    submitException(null, exception);
+  }
+
+  public CompletableFuture<Void> submitExceptionAsync(String message, Exception exception) {
+    return CompletableFuture.runAsync(() -> submitException(message, exception), executorService);
+  }
+
+  public void submitException(String message, Exception exception) {
+    Event event;
+    if (message == null) {
+      event = createError().build();
+    } else {
+      event = createError().message(message).build();
+    }
     PluginContext pluginContext = PluginContext.builder().exception(exception).build();
-    submitEvent(EventPluginContext.builder().event(event).context(pluginContext).build());
+    submitEventWithContext(
+        EventPluginContext.builder().event(event).context(pluginContext).build());
   }
 
-  public Event.EventBuilder createException() {
+  public Event.EventBuilder createError() {
     return createEvent().type(EventType.ERROR.value());
   }
 
@@ -108,23 +121,23 @@ public CompletableFuture<Void> submitUnhandledExceptionAsync(
   }
 
   public void submitUnhandledException(Exception exception, String submissionMethod) {
-    Event event = createException().build();
+    Event event = createError().build();
     PluginContext pluginContext =
         PluginContext.builder()
             .exception(exception)
             .unhandledError(true)
             .submissionMethod(submissionMethod)
             .build();
-    submitEvent(EventPluginContext.builder().event(event).context(pluginContext).build());
+    submitEventWithContext(
+        EventPluginContext.builder().event(event).context(pluginContext).build());
   }
 
   public CompletableFuture<Void> submitFeatureUsageAsync(String feature) {
     return CompletableFuture.runAsync(() -> submitFeatureUsage(feature), executorService);
   }
 
   public void submitFeatureUsage(String feature) {
-    Event event = createFeatureUsage(feature).build();
-    submitEvent(EventPluginContext.from(event));
+    submitEvent(createFeatureUsage(feature).build());
   }
 
   public Event.EventBuilder createFeatureUsage(String feature) {
@@ -152,8 +165,7 @@ public CompletableFuture<Void> submitLogAsync(String message, String source, Str
   }
 
   public void submitLog(String message, String source, String level) {
-    Event event = createLog(message, source, level).build();
-    submitEvent(EventPluginContext.from(event));
+    submitEvent(createLog(message, source, level).build());
   }
 
   public Event.EventBuilder createLog(String message) {
@@ -166,13 +178,7 @@ public Event.EventBuilder createLog(String message, String source) {
 
   public Event.EventBuilder createLog(String message, String source, String level) {
     if (source == null) {
-      // Calling method
-      StackTraceElement[] traceElements = Thread.currentThread().getStackTrace();
-      source = traceElements[2].getMethodName();
-      // Came from the overrided method
-      if (source.equals("createLog")) {
-        source = traceElements[3].getMethodName();
-      }
+      source = getCallingMethod();
     }
 
     Event.EventBuilder builder =
@@ -184,13 +190,20 @@ public Event.EventBuilder createLog(String message, String source, String level)
     return builder.property(EventPropertyKey.LOG_LEVEL.value(), level);
   }
 
+  private String getCallingMethod() {
+    StackTraceElement[] traceElements = Thread.currentThread().getStackTrace();
+    String source = traceElements[3].getMethodName();
+    boolean cameFromOverridenMethod = source.equals("createLog");
+
+    return cameFromOverridenMethod ? traceElements[4].getMethodName() : source;
+  }
+
   public CompletableFuture<Void> submitNotFoundAsync(String resource) {
     return CompletableFuture.runAsync(() -> submitNotFound(resource), executorService);
   }
 
   public void submitNotFound(String resource) {
-    Event event = createNotFound(resource).build();
-    submitEvent(EventPluginContext.from(event));
+    submitEvent(createNotFound(resource).build());
   }
 
   public Event.EventBuilder createNotFound(String resource) {
@@ -202,8 +215,7 @@ public CompletableFuture<Void> submitSessionStartAsync() {
   }
 
   public void submitSessionStart() {
-    Event event = createSessionStart().build();
-    submitEvent(EventPluginContext.from(event));
+    submitEvent(createSessionStart().build());
   }
 
   public Event.EventBuilder createSessionStart() {
@@ -216,11 +228,21 @@ public Event.EventBuilder createEvent() {
         .date(LocalDate.now());
   }
 
-  public CompletableFuture<Void> submitEventAsync(EventPluginContext eventPluginContext) {
-    return CompletableFuture.runAsync(() -> submitEvent(eventPluginContext), executorService);
+  public CompletableFuture<Void> submitEventAsync(Event event) {
+    return CompletableFuture.runAsync(() -> submitEvent(event), executorService);
+  }
+
+  public void submitEvent(Event event) {
+    eventPluginRunner.run(EventPluginContext.from(event));
   }
 
-  public void submitEvent(EventPluginContext eventPluginContext) {
+  public CompletableFuture<Void> submitEventWithContextAsync(
+      EventPluginContext eventPluginContext) {
+    return CompletableFuture.runAsync(
+        () -> submitEventWithContext(eventPluginContext), executorService);
+  }
+
+  public void submitEventWithContext(EventPluginContext eventPluginContext) {
     eventPluginRunner.run(eventPluginContext);
   }
 
@@ -229,7 +251,7 @@ public CompletableFuture<Void> submitSessionEndAsync(String sessionOrUserId) {
   }
 
   public void submitSessionEnd(String sessionOrUserId) {
-    LOG.info(String.format("Submitting session end: %s", sessionOrUserId));
+    log.info(String.format("Submitting session end: %s", sessionOrUserId));
     configurationManager.getSubmissionClient().sendHeartBeat(sessionOrUserId, true);
   }
 
@@ -247,9 +269,16 @@ public SubmissionResponse updateEmailAndDescription(
             .postUserDescription(
                 referenceId,
                 UserDescription.builder().description(description).emailAddress(email).build());
+    if (response.hasException()) {
+      log.error(
+          String.format("Failed to submit user email and description for event: %s", referenceId),
+          response.getException());
+    }
     if (!response.isSuccess()) {
-      LOG.error(
-          String.format("Failed to submit user email and description for event: %s", referenceId));
+      log.error(
+          String.format(
+              "Failed to submit user email and description for event: %s, code: %s",
+              referenceId, response.getCode()));
     }
 
     return response;

src/main/java/com/exceptionless/exceptionlessclient/configuration/Configuration.java

@@ -9,6 +9,7 @@
 public class Configuration {
   private static final String DEFAULT_SERVER_URL = "https://collector.exceptionless.io";
   private static final String DEFAULT_HEARTBEAT_SERVER_URL = "https://heartbeat.exceptionless.io";
+  private static final String DEFAULT_CONFIG_SERVER_URL = "https://config.exceptionless.io";
   private static final Long DEFAULT_UPDATE_SETTINGS_WHEN_IDLE_INTERVAL = 12000L;
   private static final Integer DEFAULT_SUBMISSION_BATCH_SIZE = 50;
   private static final Integer DEFAULT_SUBMISSION_CLIENT_TIMEOUT_IN_MILLIS = 500;
@@ -17,6 +18,7 @@ public class Configuration {
   public static class Property {
     public static final String API_KEY = "apiKey";
     public static final String SERVER_URL = "serverUrl";
+    public static final String CONFIG_SERVER_URL = "configServerUrl";
     public static final String HEART_BEAT_SERVER_URL = "heartbeatServerUrl";
     public static final String UPDATE_SETTINGS_WHEN_IDLE_INTERVAL =
         "updateSettingsWhenIdleInterval";
@@ -29,6 +31,7 @@ public static class Property {
   @Getter private String apiKey;
   @Getter private String serverUrl;
   @Getter private String heartbeatServerUrl;
+  @Getter private String configServerUrl;
   @Getter private Long updateSettingsWhenIdleInterval;
   @Getter private Integer submissionBatchSize;
   @Getter private Integer submissionClientTimeoutInMillis;
@@ -51,6 +54,10 @@ public Configuration(
         heartbeatServerUrl == null
             ? (serverUrl == null ? DEFAULT_HEARTBEAT_SERVER_URL : serverUrl)
             : heartbeatServerUrl;
+    this.configServerUrl =
+        configServerUrl == null
+            ? (serverUrl == null ? DEFAULT_CONFIG_SERVER_URL : serverUrl)
+            : configServerUrl;
     this.updateSettingsWhenIdleInterval =
         updateSettingsWhenIdleInterval == null
             ? DEFAULT_UPDATE_SETTINGS_WHEN_IDLE_INTERVAL
@@ -88,6 +95,13 @@ public void setServerUrl(String serverUrl) {
     propertyChangeSupport.firePropertyChange(Property.SERVER_URL, prevValue, serverUrl);
   }
 
+  public void setConfigServerUrl(String configServerUrl) {
+    String prevValue = this.configServerUrl;
+    this.configServerUrl = configServerUrl;
+    propertyChangeSupport.firePropertyChange(
+        Property.CONFIG_SERVER_URL, prevValue, configServerUrl);
+  }
+
   public void setHeartbeatServerUrl(String heartbeatServerUrl) {
     String prevValue = this.heartbeatServerUrl;
     this.heartbeatServerUrl = heartbeatServerUrl;