Java Metrics SDK implementation (Spring Boot)

.github/workflows/codeql-analysis.yml

@@ -22,6 +22,7 @@ jobs:
           - javascript
           - python
           - ruby
+          - java
 
     steps:
       - name: Checkout repository
@@ -34,7 +35,15 @@ jobs:
           languages: ${{ matrix.language }}
 
       - name: Autobuild
+        if: matrix.language != 'java'
         uses: github/codeql-action/autobuild@v3
 
+      - name: Build for Java and Kotlin
+        if: matrix.language == 'java'
+        run: |
+          mvn clean install -f packages/java/metrics-core/pom.xml
+          mvn clean install -f packages/java/metrics-spring/pom.xml
+          mvn clean install -f packages/java/metrics-spring2/pom.xml
+
       - name: Perform CodeQL Analysis
         uses: github/codeql-action/analyze@v3

.github/workflows/java.yaml

@@ -0,0 +1,105 @@
+name: java
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/java/**'
+
+jobs:
+  build-and-deploy-core:
+    name: Build and Deploy metrics-core
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Configure Maven settings.xml
+        run: echo "${{ secrets.MAVEN_SETTINGS }}" > ~/.m2/settings.xml
+
+      - name: Build & Test metrics-core
+        working-directory: packages/java
+        run: mvn clean verify
+
+      - name: Import GPG Key
+        run: |
+          echo "$GPG_PRIVATE_KEY" | base64 --decode | gpg --batch --import
+        env:
+          GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
+
+      - name: Deploy metrics-core
+        working-directory: packages/java
+        run: mvn deploy -Dgpg.passphrase=${{ secrets.GPG_PASSPHRASE }}
+
+  build-and-deploy-for-spring3:
+    name: Build and Deploy metrics-spring library for Spring Boot 3+
+    needs: build-and-deploy-core
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Configure Maven settings.xml
+        run: echo "${{ secrets.MAVEN_SETTINGS }}" > ~/.m2/settings.xml
+
+      - name: Build & Test metrics-spring
+        working-directory: packages/java/metrics-spring
+        run: mvn clean verify
+
+      - name: Import GPG Key
+        run: |
+          echo "$GPG_PRIVATE_KEY" | base64 --decode | gpg --batch --import
+        env:
+          GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
+
+      - name: Deploy metrics-spring
+        working-directory: packages/java/metrics-spring
+        run: mvn deploy -Dgpg.passphrase=${{ secrets.GPG_PASSPHRASE }}
+
+  build-and-deploy-for-spring2:
+    name: Build and Deploy metrics-spring library for Spring Boot 2+
+    needs: build-and-deploy-core
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Configure Maven settings.xml
+        run: echo "${{ secrets.MAVEN_SETTINGS }}" > ~/.m2/settings.xml
+
+      - name: Build & Test metrics-spring2
+        working-directory: packages/java/metrics-spring2
+        run: mvn clean verify
+
+      - name: Import GPG Key
+        run: |
+          echo "$GPG_PRIVATE_KEY" | base64 --decode | gpg --batch --import
+        env:
+          GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
+
+      - name: Deploy metrics-spring2
+        working-directory: packages/java/metrics-spring2
+        run: mvn deploy -Dgpg.passphrase=${{ secrets.GPG_PASSPHRASE }}
+

.gitignore

@@ -4,3 +4,10 @@ node_modules/
 packages/*/.nyc_output/
 packages/*/coverage/
 packages/*/node_modules/
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+

packages/java/.gitignore

@@ -0,0 +1,27 @@
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+../*
+
+### IntelliJ IDEA ###
+.idea/
+*.iws
+*.iml
+*.ipr
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store
+

packages/java/examples/SpringMetricsExample/.gitignore

@@ -0,0 +1,24 @@
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### VS Code ###
+.vscode/
+
+.DS_Store

packages/java/examples/SpringMetricsExample/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+wrapperVersion=3.3.2
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip

packages/java/examples/SpringMetricsExample/README.md

@@ -0,0 +1,3 @@
+# SpringMetricsExample
+
+The application is a REST web-service. It is an example of using Java metrics SDK.

packages/java/examples/SpringMetricsExample/pom.xml

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-parent</artifactId>
+		<version>3.3.4</version>
+<!--		<version>2.7.18</version>-->
+		<relativePath/>
+	</parent>
+	<groupId>com.readme</groupId>
+	<artifactId>spring-metrics-example</artifactId>
+	<version>0.0.1-SNAPSHOT</version>
+	<name>spring-metrics-example</name>
+	<description>Example project to test metrics-sdk</description>
+
+	<properties>
+		<java.version>21</java.version>
+	</properties>
+
+	<dependencies>
+		<dependency>
+			<groupId>com.readme</groupId>
+			<artifactId>metrics-spring</artifactId>
+<!--			<artifactId>metrics-spring2</artifactId>-->
+			<version>0.1.0</version>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-maven-plugin</artifactId>
+			</plugin>
+		</plugins>
+	</build>
+
+</project>

packages/java/examples/SpringMetricsExample/src/main/java/com/owl/example/CustomUserDataCollectorConfig.java

@@ -0,0 +1,49 @@
+package com.owl.example;
+
+import com.readme.core.dataextraction.LogOptions;
+import com.readme.core.dataextraction.payload.user.UserData;
+import com.readme.core.dataextraction.payload.user.UserDataCollector;
+import com.readme.spring.datacollection.ServletDataPayloadAdapter;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import java.util.List;
+
+/**
+ * Configuration class for customizing the strategy to collect user data.
+ *
+ * <p>This configuration provides a custom implementation of {@link UserDataCollector},
+ * which overrides the default behavior provided by the SDK. It allows developers
+ * to specify their own logic for extracting user-specific information, such as API keys,
+ * email addresses, or labels, from the incoming HTTP requests.</p>
+ *
+ * <p>In this example, the API key is extracted from the HTTP headers using the header
+ * "X-User-Name", while the email and label fields are hardcoded with custom values.
+ * Developers can modify this logic to suit their application's requirements.</p>
+ *
+ * <p>By defining this bean, Spring Boot's auto-configuration will automatically use
+ * this custom implementation instead of the default {@link UserDataCollector}.</p>
+ */
+@Configuration
+public class CustomUserDataCollectorConfig {
+
+    @Bean
+    public UserDataCollector<ServletDataPayloadAdapter> customUserDataCollector() {
+        return payloadAdapter -> {
+            String apiKey = payloadAdapter.getRequestHeaders().get("x-user-name");
+            return UserData.builder()
+                    .apiKey(apiKey)
+                    .email("[email protected]")
+                    .label("owl-label")
+                    .build();
+        };
+    }
+
+    @Bean
+    public LogOptions logOptions() {
+        return LogOptions.builder()
+                .baseLogUrl("http://baseurl.abcd")
+                .bufferLength(1)
+                .build();
+    }
+}

packages/java/examples/SpringMetricsExample/src/main/java/com/owl/example/OwlController.java

@@ -0,0 +1,76 @@
+package com.owl.example;
+
+import com.readme.core.datatransfer.har.HttpStatus;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.*;
+
+/**
+ * OwlController is a sample REST controller intended for demonstration and testing purposes.
+ * <p>
+ * It simulates typical HTTP requests and responses to showcase how the ReadMe Metrics SDK
+ * integrates into a Spring Boot application.
+ * <p>
+ * This controller is not intended for production use and serves only as an example endpoint
+ * to test how the SDK logs and processes different request types.
+ */
+@RestController
+public class OwlController {
+
+    private final Map<String, String> owlStorage = new HashMap<>();
+
+    public OwlController() {
+        owlStorage.put("1", "Default Owl");
+    }
+
+    @GetMapping("/owl/{id}")
+    public String getOwlById(@PathVariable String id) {
+        return "Owl with id " + id;
+    }
+
+    @GetMapping("/owls")
+    public Collection<String> getAllOwl() {
+        return owlStorage.values();
+    }
+
+    @PutMapping("/owl/{owlName}")
+    public ResponseEntity<String> createOwl(@PathVariable String owlName, @RequestBody String body) {
+        UUID birdId = UUID.randomUUID();
+        owlStorage.put(birdId.toString(), owlName);
+
+        String responseBody = "Bird " + owlName + " created a bird with id: " + birdId + "\n" +
+                "Creation request body: \n" + body;
+
+        HttpHeaders headers = new HttpHeaders();
+        headers.add("bird-id", birdId.toString());
+        headers.add("bird-token", Base64.getEncoder()
+                .encodeToString(birdId.toString()
+                        .getBytes()));
+
+        return ResponseEntity.status(HttpStatus.CREATED.getCode())
+                .headers(headers)
+                .body(responseBody);
+    }
+
+    @PutMapping(value = "/owl/urlencoded/{owlName}", consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE)
+    public ResponseEntity<String> createOwlUrlencoded(@RequestParam Map<String, String> params) {
+        UUID birdId = UUID.randomUUID();
+
+        String responseBody = "Created a bird with id: " + birdId + "\n" +
+                "Creation request urlencoded body: \n" + params;
+
+        HttpHeaders headers = new HttpHeaders();
+        headers.add("bird-id", birdId.toString());
+        headers.add("bird-token", Base64.getEncoder()
+                .encodeToString(birdId.toString()
+                        .getBytes()));
+
+        return ResponseEntity.status(HttpStatus.CREATED.getCode())
+                .headers(headers)
+                .body(responseBody);
+    }
+
+}