Merge remote-tracking branch 'upstream/main' into fix-changed

* upstream/main: Add initial telemetry development documentation (#8530) Add existing "Remote storage" to index Disable telemetry client due to incompatibilites with jakarta (#8526)
JabRef · Feb 26, 2022 · 5bd4ba4 · 5bd4ba4
2 parents 8e753ec + 0e81417
commit 5bd4ba4
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 8 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -11,10 +11,12 @@
   * [JabRef's development strategy](getting-into-the-code/development-strategy.md)
 * [Advanced reading](advanced-reading/README.md)
   * [Code Quality](advanced-reading/code-quality.md)
-  * [Recommendations for UI design](advanced-reading/ui-recommendations.md)
+  * [Creating a binary and debug it](advanced-reading/jpackage.md)
   * [Custom SVG icons](advanced-reading/custom-svg-icons.md)
+  * [Recommendations for UI design](advanced-reading/ui-recommendations.md)
+  * [Remote Storage](advanced-reading/remote-storage.md)
+  * [Telemetry](advanced-reading/telemetry.md)
   * [Working on fetchers](advanced-reading/fetchers.md)
-  * [Creating a binary and debug it](advanced-reading/jpackage.md)
 * [JabRef and Software Engineering Training](teaching.md)
 * [Readings on Coding](readings-on-coding/README.md)
   * [Readings on JavaFX](readings-on-coding/javafx.md)

diff --git a/docs/advanced-reading/remote-storage.md b/docs/advanced-reading/remote-storage.md
@@ -2,8 +2,6 @@
 
 ## Using a shared PostgreSQL database
 
-...
-
 ## Handling large shared databases
 
 Synchronization times may get long when working with a large database containing several thousand entries. Therefore, synchronization only happens if several conditions are fulfilled:

diff --git a/docs/advanced-reading/telemetry.md b/docs/advanced-reading/telemetry.md
@@ -0,0 +1,11 @@
+# Telemetry
+
+JabRef aims for improving user experience. For that, it employs telemetry and, for instance, checks for used features.
+
+The pull requests introducing the first version was <https://github.com/JabRef/jabref/pull/2283>.
+Self-hosted alternative [Matomo Java Tracker](https://github.com/matomo-org/matomo-java-tracker) where neglected, because the JabRef team currently does not have the resources to maintain a server.
+
+## Implementation hints
+
+The ApplicationInsights library that we use supports a special way to submit additional details: <https://docs.microsoft.com/en-us/azure/azure-monitor/app/api-custom-events-metrics#properties>.
+Especially, one has to send `source` as property.
diff --git a/src/main/java/org/jabref/gui/Globals.java b/src/main/java/org/jabref/gui/Globals.java
@@ -1,6 +1,5 @@
 package org.jabref.gui;
 
-import java.awt.GraphicsEnvironment;
 import java.util.Optional;
 import java.util.UUID;
 
@@ -115,10 +114,10 @@ public static synchronized ThemeManager getThemeManager() {
     public static void startBackgroundTasks() {
         Globals.fileUpdateMonitor = new DefaultFileUpdateMonitor();
         JabRefExecutorService.INSTANCE.executeInterruptableTask(Globals.fileUpdateMonitor, "FileUpdateMonitor");
-
-        if (Globals.prefs.getTelemetryPreferences().shouldCollectTelemetry() && !GraphicsEnvironment.isHeadless()) {
+        // TODO Currently deactivated due to incompatibilities in XML
+      /*  if (Globals.prefs.getTelemetryPreferences().shouldCollectTelemetry() && !GraphicsEnvironment.isHeadless()) {
             startTelemetryClient();
-        }
+        } */
     }
 
     private static void stopTelemetryClient() {