Merge pull request #17 from logicmonitor/feature/add-versioning

feature/add-versioning:  DEV-70290 : Adding '<platform>/<version>' as…

Author: choudharypooja

build.gradle

@@ -4,7 +4,7 @@ plugins {
 }
 
 group "com.logicmonitor"
-version "1.2"
+version "1.3"
 
 def jerseyVersion = "2.31"
 def junitVersion = "5.6.2"
@@ -18,7 +18,7 @@ repositories {
 dependencies {
     implementation (
         "com.microsoft.azure.functions:azure-functions-java-library:1.4.0",
-        "com.logicmonitor:lm-logs-sdk-java:1.1",
+        "com.logicmonitor:lm-logs-sdk-java:1.2",
         "com.google.code.gson:gson:2.8.6"
     )
     testImplementation (
@@ -47,6 +47,13 @@ test {
     }
 }
 
+jar {
+    manifest {
+        attributes 'Implementation-Title': project.getName(),
+                   'Implementation-Version': project.getVersion()
+    }
+}
+
 jar.dependsOn test
 
 def azureAppName = System.properties["azureFunction"] ? System.properties["azureFunction"] : rootProject.name
@@ -78,4 +85,3 @@ task copyPackage(type: Copy) {
 
 copyPackage.dependsOn azureFunctionsPackageZip
 build.finalizedBy copyPackage
-

local.settings.json

@@ -14,4 +14,4 @@
         "LogApiClientDebugging": "false",
         "LogRegexScrub": "<regex pattern>"
     }
-}
+}

package/lm-logs-azure.zip

@@ -109,13 +109,16 @@ protected LogEntry createEntry(JsonObject json) {
             .map(Instant::getEpochSecond)
             .ifPresent(entry::setTimestamp);
 
+        // get properties from event if present
+        Optional<LogEventProperties> properties = Optional.ofNullable(event.getProperties());
+
         // message:
         //     properties.Msg if present,
         //     else properties.Description if present,
         //     otherwise the whole JSON
-        String message = Optional.ofNullable(event.getProperties().getMsg())
-            .or(() -> Optional.ofNullable(event.getProperties().getDescription()))
-            .orElseGet(() -> GSON.toJson(json));
+        String message = properties.map(LogEventProperties::getMsg)
+                .or(() -> properties.map(LogEventProperties::getDescription))
+                .orElseGet(() -> GSON.toJson(json));
 
         if (scrubPattern != null) {
             message = scrubPattern.matcher(message).replaceAll("");
@@ -125,4 +128,4 @@ protected LogEntry createEntry(JsonObject json) {
         return entry;
     }
 
-}
+}

src/main/java/com/logicmonitor/logs/azure/LogEventAdapter.java

@@ -126,10 +126,12 @@ protected static LMLogsApi configureApi() {
         LMLogsApi.Builder builder = new LMLogsApi.Builder()
              .withCompany(System.getenv(PARAMETER_COMPANY_NAME))
              .withAccessId(System.getenv(PARAMETER_ACCESS_ID))
-             .withAccessKey(System.getenv(PARAMETER_ACCESS_KEY));
+             .withAccessKey(System.getenv(PARAMETER_ACCESS_KEY))
+             .withUserAgentHeader(getUserAgent());
         setProperty(PARAMETER_CONNECT_TIMEOUT, Integer::valueOf, builder::withConnectTimeout);
         setProperty(PARAMETER_READ_TIMEOUT, Integer::valueOf, builder::withReadTimeout);
         setProperty(PARAMETER_DEBUGGING, Boolean::valueOf, builder::withDebugging);
+
         return builder.build();
     }
 
@@ -231,4 +233,27 @@ private static void logResponse(final ExecutionContext context, boolean success,
                 () -> "Response body: " + response.getData());
     }
 
+    /**
+     * gets the gradle 'Implementation-Version'.
+     * @return the project version
+     */
+    private static String getBuildVersion() {
+        return LogEventForwarder.class.getPackage().getImplementationVersion();
+    }
+
+    /**
+     * gets the gradle 'Implementation-Title'.
+     * @return the project name
+     */
+    private static String getBuildName() {
+        return LogEventForwarder.class.getPackage().getImplementationTitle();
+    }
+
+    /**
+     * generates user-agent as <buildname>/<buildversion>.
+     * @return the user-agent
+     */
+    public static String getUserAgent() {
+        return getBuildName() + "/" + getBuildVersion();
+    }
 }

src/main/java/com/logicmonitor/logs/azure/LogEventForwarder.java

@@ -36,6 +36,7 @@ public class LogEventAdapterTest {
         "vm_catalina.json,              1",
         "vm_syslog.json,                1",
         "windows_vm_log.json,           1",
+        "resource_metrics.json,         1"
     })
     public void testApply(String resourceName, int expectedEntriesCount) {
         String events = TestJsonUtils.getFirstJsonString(resourceName);
@@ -54,6 +55,7 @@ public void testApply(String resourceName, int expectedEntriesCount) {
         "vm_catalina.json,              Msg,         .                                 ",
         "vm_syslog.json,                Msg,         \\d                               ",
         "windows_vm_log.json,           Description,                                   ",
+        "resource_metrics.json,         ,                                              "
     })
     public void testCreateEntry(String resourceName, String propertyName, String regexScrub) {
         JsonObject event = TestJsonUtils.getFirstLogEvent(resourceName);

src/test/java/com/logicmonitor/logs/azure/LogEventAdapterTest.java

@@ -49,7 +49,6 @@ public class LogEventForwarderIntegrationTest extends JerseyTest {
     protected static final String TEST_KEY = "testKey";
     protected static final String TEST_REQUEST_ID = "testRequestId";
     protected static final Pattern TEST_SCRUB_PATTERN = Pattern.compile("\\d");
-
     protected static ExecutionContext mockExecutionContext;
 
     @Path("/rest")

src/test/java/com/logicmonitor/logs/azure/LogEventForwarderIntegrationTest.java

@@ -31,10 +31,10 @@ public class LogEventForwarderTest {
     @ParameterizedTest
     @CsvSource({
         ",           1,      2,         true,     .                          ",
-        "company,    ,       0,         false,    \\d                        ",
-        "company,    0,      ,          true,     [\\w-.#]+@[\\w-.]+         ",
-        "company,    333,    4444,      false,    \\d+\\.\\d+\\.\\d+\\.\\d+  ",
-        "company,    55555,  666666,    false,                               ",
+        "company,    ,       0,         false,    \\d                       ",
+        "company,    0,      ,          true,     [\\w-.#]+@[\\w-.]+        ",
+        "company,    333,    4444,      false,    \\d+\\.\\d+\\.\\d+\\.\\d+ ",
+        "company,    55555,  666666,    false,                             ",
     })
     public void testConfigurationParameters(String companyName, Integer connectTimeout,
             Integer readTimeout, Boolean debugging, String regexScrub) throws Exception {
@@ -50,6 +50,7 @@ public void testConfigurationParameters(String companyName, Integer connectTimeo
                     debugging != null ? debugging.toString() : null)
             .and(LogEventForwarder.PARAMETER_REGEX_SCRUB, regexScrub)
             .execute(() -> {
+
                 LMLogsApi api = LogEventForwarder.configureApi();
                 LogEventAdapter adapter = LogEventForwarder.configureAdapter();
                 assertAll(
@@ -62,7 +63,10 @@ public void testConfigurationParameters(String companyName, Integer connectTimeo
                     () -> assertEquals(debugging != null ? debugging : false,
                             api.getApiClient().isDebugging()),
                     () -> assertEquals(regexScrub,
-                            regexScrub != null ? adapter.getScrubPattern().pattern() : adapter.getScrubPattern())
+                            regexScrub != null ? adapter.getScrubPattern().pattern() : adapter.getScrubPattern()),
+                    () -> assertEquals(LogEventForwarder.getUserAgent(),
+                            api.getApiClient().getUserAgent())
+
                 );
             }
         );

src/test/java/com/logicmonitor/logs/azure/LogEventForwarderTest.java

@@ -0,0 +1,17 @@
+[
+  {
+    "records": [
+      {
+        "count": 2,
+        "total": 3,
+        "minimum": 1,
+        "maximum": 2,
+        "average": 1.5,
+        "resourceId": "/SUBSCRIPTIONS/318382E3-A165-4F0D-8906-01FB4CD06B74/RESOURCEGROUPS/LM-LOGS-WESTINDIA-GROUP/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/LM-LOGS-WESTINDIA",
+        "time": "2021-03-04T17:30:00.0000000Z",
+        "metricName": "IncomingRequests",
+        "timeGrain": "PT1M"
+      }
+    ]
+  }
+]