Posthog to log to log file (#2813)

# Description of Changes Please provide a summary of the changes, including: - What was changed - Why the change was made - Any challenges encountered Closes #(issue_number) --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details. --------- Co-authored-by: a <a>
2025-01-30 15:13:42 +00:00
parent 8348caf3f0
commit 94ea723326
7 changed files with 157 additions and 56 deletions
--- a/src/main/java/stirling/software/SPDF/config/PostHogConfig.java
+++ b/src/main/java/stirling/software/SPDF/config/PostHogConfig.java
@@ -7,8 +7,10 @@ import org.springframework.context.annotation.Configuration;
 import com.posthog.java.PostHog;

 import jakarta.annotation.PreDestroy;
+import lombok.extern.slf4j.Slf4j;

@Configuration
+@Slf4j
 public class PostHogConfig {

    @Value("${posthog.api.key}")
@@ -21,7 +23,11 @@ public class PostHogConfig {

    @Bean
    public PostHog postHogClient() {
-        postHogClient = new PostHog.Builder(posthogApiKey).host(posthogHost).build();
+        postHogClient =
+                new PostHog.Builder(posthogApiKey)
+                        .host(posthogHost)
+                        .logger(new PostHogLoggerImpl())
+                        .build();
        return postHogClient;
    }

--- a/src/main/java/stirling/software/SPDF/config/PostHogLoggerImpl.java
+++ b/src/main/java/stirling/software/SPDF/config/PostHogLoggerImpl.java
@@ -0,0 +1,42 @@
+package stirling.software.SPDF.config;
+
+import org.springframework.stereotype.Component;
+
+import com.posthog.java.PostHogLogger;
+
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+@Component
+public class PostHogLoggerImpl implements PostHogLogger {
+
+    @Override
+    public void debug(String message) {
+        log.debug(message);
+    }
+
+    @Override
+    public void info(String message) {
+        log.info(message);
+    }
+
+    @Override
+    public void warn(String message) {
+        log.warn(message);
+    }
+
+    @Override
+    public void error(String message) {
+        log.error(message);
+    }
+
+    @Override
+    public void error(String message, Throwable throwable) {
+        if (message.contains("Error sending events to PostHog")) {
+            log.warn(
+                    "Error sending metrics, Likely caused by no internet connection. Non Blocking");
+        } else {
+            log.error(message, throwable);
+        }
+    }
+}
--- a/src/main/java/stirling/software/SPDF/controller/api/AnalysisController.java
+++ b/src/main/java/stirling/software/SPDF/controller/api/AnalysisController.java
@@ -1,41 +1,43 @@
 package stirling.software.SPDF.controller.api;

+import java.io.IOException;
+import java.util.*;
+
 import org.apache.pdfbox.Loader;
 import org.apache.pdfbox.cos.COSName;
 import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDDocumentInformation;
 import org.apache.pdfbox.pdmodel.PDPage;
 import org.apache.pdfbox.pdmodel.PDPageTree;
-import org.apache.pdfbox.pdmodel.PDDocumentInformation;
-import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
-import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation;
 import org.apache.pdfbox.pdmodel.encryption.PDEncryption;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation;
+import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
 import org.springframework.web.bind.annotation.*;
-import org.springframework.web.multipart.MultipartFile;
+
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
-import stirling.software.SPDF.model.api.PDFFile;

-import java.io.IOException;
-import java.util.*;
+import stirling.software.SPDF.model.api.PDFFile;

@RestController
@RequestMapping("/api/v1/analysis")
@Tag(name = "Analysis", description = "Analysis APIs")
 public class AnalysisController {

+    @PostMapping(value = "/page-count", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Get PDF page count",
+            description = "Returns total number of pages in PDF. Input:PDF Output:JSON Type:SISO")
+    public Map<String, Integer> getPageCount(@ModelAttribute PDFFile file) throws IOException {
+        try (PDDocument document = Loader.loadPDF(file.getFileInput().getBytes())) {
+            return Map.of("pageCount", document.getNumberOfPages());
+        }
+    }

-	@PostMapping(value = "/page-count", consumes = "multipart/form-data")
-	@Operation(summary = "Get PDF page count",
-	          description = "Returns total number of pages in PDF. Input:PDF Output:JSON Type:SISO")
-	public Map<String, Integer> getPageCount(@ModelAttribute PDFFile file) throws IOException {
-		try (PDDocument document = Loader.loadPDF(file.getFileInput().getBytes())) {
-	       return Map.of("pageCount", document.getNumberOfPages());
-	   }
-	}
-
-    @PostMapping(value ="/basic-info", consumes = "multipart/form-data")
-    @Operation(summary = "Get basic PDF information",
-               description = "Returns page count, version, file size. Input:PDF Output:JSON Type:SISO")
+    @PostMapping(value = "/basic-info", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Get basic PDF information",
+            description = "Returns page count, version, file size. Input:PDF Output:JSON Type:SISO")
    public Map<String, Object> getBasicInfo(@ModelAttribute PDFFile file) throws IOException {
        try (PDDocument document = Loader.loadPDF(file.getFileInput().getBytes())) {
            Map<String, Object> info = new HashMap<>();
@@ -46,10 +48,12 @@ public class AnalysisController {
        }
    }

-    @PostMapping(value ="/document-properties", consumes = "multipart/form-data")
-    @Operation(summary = "Get PDF document properties",
-               description = "Returns title, author, subject, etc. Input:PDF Output:JSON Type:SISO")
-    public Map<String, String> getDocumentProperties(@ModelAttribute PDFFile file) throws IOException {
+    @PostMapping(value = "/document-properties", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Get PDF document properties",
+            description = "Returns title, author, subject, etc. Input:PDF Output:JSON Type:SISO")
+    public Map<String, String> getDocumentProperties(@ModelAttribute PDFFile file)
+            throws IOException {
        try (PDDocument document = Loader.loadPDF(file.getFileInput().getBytes())) {
            PDDocumentInformation info = document.getDocumentInformation();
            Map<String, String> properties = new HashMap<>();
@@ -65,10 +69,12 @@ public class AnalysisController {
        }
    }

-    @PostMapping(value ="/page-dimensions", consumes = "multipart/form-data")
-    @Operation(summary = "Get page dimensions for all pages",
-               description = "Returns width and height of each page. Input:PDF Output:JSON Type:SISO")
-    public List<Map<String, Float>> getPageDimensions(@ModelAttribute PDFFile file) throws IOException {
+    @PostMapping(value = "/page-dimensions", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Get page dimensions for all pages",
+            description = "Returns width and height of each page. Input:PDF Output:JSON Type:SISO")
+    public List<Map<String, Float>> getPageDimensions(@ModelAttribute PDFFile file)
+            throws IOException {
        try (PDDocument document = Loader.loadPDF(file.getFileInput().getBytes())) {
            List<Map<String, Float>> dimensions = new ArrayList<>();
            PDPageTree pages = document.getPages();
@@ -83,9 +89,11 @@ public class AnalysisController {
        }
    }

-    @PostMapping(value ="/form-fields", consumes = "multipart/form-data")
-    @Operation(summary = "Get form field information",
-               description = "Returns count and details of form fields. Input:PDF Output:JSON Type:SISO")
+    @PostMapping(value = "/form-fields", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Get form field information",
+            description =
+                    "Returns count and details of form fields. Input:PDF Output:JSON Type:SISO")
    public Map<String, Object> getFormFields(@ModelAttribute PDFFile file) throws IOException {
        try (PDDocument document = Loader.loadPDF(file.getFileInput().getBytes())) {
            Map<String, Object> formInfo = new HashMap<>();
@@ -104,9 +112,10 @@ public class AnalysisController {
        }
    }

-    @PostMapping(value ="/annotation-info", consumes = "multipart/form-data")
-    @Operation(summary = "Get annotation information",
-               description = "Returns count and types of annotations. Input:PDF Output:JSON Type:SISO")
+    @PostMapping(value = "/annotation-info", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Get annotation information",
+            description = "Returns count and types of annotations. Input:PDF Output:JSON Type:SISO")
    public Map<String, Object> getAnnotationInfo(@ModelAttribute PDFFile file) throws IOException {
        try (PDDocument document = Loader.loadPDF(file.getFileInput().getBytes())) {
            Map<String, Object> annotInfo = new HashMap<>();
@@ -127,9 +136,11 @@ public class AnalysisController {
        }
    }

-    @PostMapping(value ="/font-info", consumes = "multipart/form-data")
-    @Operation(summary = "Get font information",
-               description = "Returns list of fonts used in the document. Input:PDF Output:JSON Type:SISO")
+    @PostMapping(value = "/font-info", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Get font information",
+            description =
+                    "Returns list of fonts used in the document. Input:PDF Output:JSON Type:SISO")
    public Map<String, Object> getFontInfo(@ModelAttribute PDFFile file) throws IOException {
        try (PDDocument document = Loader.loadPDF(file.getFileInput().getBytes())) {
            Map<String, Object> fontInfo = new HashMap<>();
@@ -147,9 +158,11 @@ public class AnalysisController {
        }
    }

-    @PostMapping(value ="/security-info", consumes = "multipart/form-data")
-    @Operation(summary = "Get security information",
-               description = "Returns encryption and permission details. Input:PDF Output:JSON Type:SISO")
+    @PostMapping(value = "/security-info", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Get security information",
+            description =
+                    "Returns encryption and permission details. Input:PDF Output:JSON Type:SISO")
    public Map<String, Object> getSecurityInfo(@ModelAttribute PDFFile file) throws IOException {
        try (PDDocument document = Loader.loadPDF(file.getFileInput().getBytes())) {
            Map<String, Object> securityInfo = new HashMap<>();
@@ -163,8 +176,12 @@ public class AnalysisController {
                Map<String, Boolean> permissions = new HashMap<>();
                permissions.put("canPrint", document.getCurrentAccessPermission().canPrint());
                permissions.put("canModify", document.getCurrentAccessPermission().canModify());
-                permissions.put("canExtractContent", document.getCurrentAccessPermission().canExtractContent());
-                permissions.put("canModifyAnnotations", document.getCurrentAccessPermission().canModifyAnnotations());
+                permissions.put(
+                        "canExtractContent",
+                        document.getCurrentAccessPermission().canExtractContent());
+                permissions.put(
+                        "canModifyAnnotations",
+                        document.getCurrentAccessPermission().canModifyAnnotations());

                securityInfo.put("permissions", permissions);
            } else {
@@ -174,7 +191,4 @@ public class AnalysisController {
            return securityInfo;
        }
    }
-
-
-
 }