Added metric events (#1433)

* added a bunch of metric events

* adjusted tests

* (merge conflict)

Author: Zabuzard

application/src/main/java/org/togetherjava/tjbot/features/Features.java

@@ -121,18 +121,18 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         ModerationActionsStore actionsStore = new ModerationActionsStore(database);
         ModAuditLogWriter modAuditLogWriter = new ModAuditLogWriter(config);
         ScamHistoryStore scamHistoryStore = new ScamHistoryStore(database);
-        GitHubReference githubReference = new GitHubReference(config);
+        GitHubReference githubReference = new GitHubReference(config, metrics);
         CodeMessageHandler codeMessageHandler =
-                new CodeMessageHandler(blacklistConfig.special(), jshellEval);
-        ChatGptService chatGptService = new ChatGptService(config);
+                new CodeMessageHandler(blacklistConfig.special(), jshellEval, metrics);
+        ChatGptService chatGptService = new ChatGptService(config, metrics);
         HelpSystemHelper helpSystemHelper = new HelpSystemHelper(config, database, chatGptService);
         HelpThreadLifecycleListener helpThreadLifecycleListener =
                 new HelpThreadLifecycleListener(helpSystemHelper, database);
         HelpThreadCreatedListener helpThreadCreatedListener =
-                new HelpThreadCreatedListener(helpSystemHelper);
+                new HelpThreadCreatedListener(helpSystemHelper, metrics);
         TopHelpersService topHelpersService = new TopHelpersService(database);
         TopHelpersAssignmentRoutine topHelpersAssignmentRoutine =
-                new TopHelpersAssignmentRoutine(config, topHelpersService);
+                new TopHelpersAssignmentRoutine(config, topHelpersService, metrics);
 
         // NOTE The system can add special system relevant commands also by itself,
         // hence this list may not necessarily represent the full list of all commands actually
@@ -147,22 +147,22 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         features.add(new ScamHistoryPurgeRoutine(scamHistoryStore));
         features.add(new HelpThreadMetadataPurger(database));
         features.add(new HelpThreadActivityUpdater(helpSystemHelper));
-        features
-            .add(new AutoPruneHelperRoutine(config, helpSystemHelper, modAuditLogWriter, database));
+        features.add(new AutoPruneHelperRoutine(config, helpSystemHelper, modAuditLogWriter,
+                database, metrics));
         features.add(new HelpThreadAutoArchiver(helpSystemHelper));
         features.add(new LeftoverBookmarksCleanupRoutine(bookmarksSystem));
         features.add(new MarkHelpThreadCloseInDBRoutine(database, helpThreadLifecycleListener));
         features.add(new MemberCountDisplayRoutine(config));
-        features.add(new RSSHandlerRoutine(config, database));
+        features.add(new RSSHandlerRoutine(config, database, metrics));
         features.add(topHelpersAssignmentRoutine);
 
         // Message receivers
         features.add(new TopHelpersMessageListener(database, config));
-        features.add(new SuggestionsUpDownVoter(config));
-        features.add(new ScamBlocker(actionsStore, scamHistoryStore, config));
-        features.add(new MediaOnlyChannelListener(config));
-        features.add(new FileSharingMessageListener(config));
-        features.add(new BlacklistedAttachmentListener(config, modAuditLogWriter));
+        features.add(new SuggestionsUpDownVoter(config, metrics));
+        features.add(new ScamBlocker(actionsStore, scamHistoryStore, config, metrics));
+        features.add(new MediaOnlyChannelListener(config, metrics));
+        features.add(new FileSharingMessageListener(config, metrics));
+        features.add(new BlacklistedAttachmentListener(config, modAuditLogWriter, metrics));
         features.add(githubReference);
         features.add(codeMessageHandler);
         features.add(new CodeMessageAutoDetection(config, codeMessageHandler));
@@ -171,11 +171,11 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         features.add(new QuoteBoardForwarder(config));
 
         // Voice receivers
-        features.add(new DynamicVoiceChat(config));
+        features.add(new DynamicVoiceChat(config, metrics));
 
         // Event receivers
-        features.add(new RejoinModerationRoleListener(actionsStore, config));
-        features.add(new GuildLeaveCloseThreadListener(config));
+        features.add(new RejoinModerationRoleListener(actionsStore, config, metrics));
+        features.add(new GuildLeaveCloseThreadListener(config, metrics));
         features.add(new LeftoverBookmarksListener(bookmarksSystem));
         features.add(helpThreadCreatedListener);
         features.add(new HelpThreadLifecycleListener(helpSystemHelper, database));
@@ -190,7 +190,7 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         features.add(new LogLevelCommand());
         features.add(new PingCommand());
         features.add(new TeXCommand());
-        features.add(new TagCommand(tagSystem));
+        features.add(new TagCommand(tagSystem, metrics));
         features.add(new TagManageCommand(tagSystem, modAuditLogWriter));
         features.add(new TagsCommand(tagSystem));
         features.add(new WarnCommand(actionsStore));
@@ -210,7 +210,7 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         features.add(new WolframAlphaCommand(config));
         features.add(new GitHubCommand(githubReference));
         features.add(new ModMailCommand(jda, config));
-        features.add(new HelpThreadCommand(config, helpSystemHelper));
+        features.add(new HelpThreadCommand(config, helpSystemHelper, metrics));
         features.add(new ReportCommand(config));
         features.add(new BookmarksCommand(bookmarksSystem));
         features.add(new ChatGptCommand(chatGptService, helpSystemHelper));

application/src/main/java/org/togetherjava/tjbot/features/basic/SuggestionsUpDownVoter.java

@@ -13,6 +13,7 @@
 import org.togetherjava.tjbot.config.Config;
 import org.togetherjava.tjbot.config.SuggestionsConfig;
 import org.togetherjava.tjbot.features.MessageReceiverAdapter;
+import org.togetherjava.tjbot.features.analytics.Metrics;
 
 import java.util.Optional;
 import java.util.regex.Pattern;
@@ -28,16 +29,19 @@ public final class SuggestionsUpDownVoter extends MessageReceiverAdapter {
     private static final int THREAD_TITLE_MAX_LENGTH = 60;
 
     private final SuggestionsConfig config;
+    private final Metrics metrics;
 
     /**
      * Creates a new listener to receive all message sent in suggestion channels.
      *
      * @param config the config to use for this
+     * @param metrics to track events
      */
-    public SuggestionsUpDownVoter(Config config) {
+    public SuggestionsUpDownVoter(Config config, Metrics metrics) {
         super(Pattern.compile(config.getSuggestions().getChannelPattern()));
 
         this.config = config.getSuggestions();
+        this.metrics = metrics;
     }
 
     @Override
@@ -49,6 +53,7 @@ public void onMessageReceived(MessageReceivedEvent event) {
         Guild guild = event.getGuild();
         Message message = event.getMessage();
 
+        metrics.count("suggestion");
         createThread(message);
 
         reactWith(config.getUpVoteEmoteName(), FALLBACK_UP_VOTE, guild, message);

application/src/main/java/org/togetherjava/tjbot/features/chatgpt/ChatGptService.java

@@ -9,6 +9,7 @@
 import org.slf4j.LoggerFactory;
 
 import org.togetherjava.tjbot.config.Config;
+import org.togetherjava.tjbot.features.analytics.Metrics;
 
 import javax.annotation.Nullable;
 
@@ -28,14 +29,18 @@ public class ChatGptService {
 
     private boolean isDisabled = false;
     private OpenAIClient openAIClient;
+    private Metrics metrics;
 
     /**
      * Creates instance of ChatGPTService
      *
      * @param config needed for token to OpenAI API.
+     * @param metrics to track events
      */
-    public ChatGptService(Config config) {
+    public ChatGptService(Config config, Metrics metrics) {
         String apiKey = config.getOpenaiApiKey();
+        this.metrics = metrics;
+
         boolean keyIsDefaultDescription = apiKey.startsWith("<") && apiKey.endsWith(">");
         if (apiKey.isBlank() || keyIsDefaultDescription) {
             isDisabled = true;
@@ -111,6 +116,7 @@ private Optional<String> sendPrompt(String prompt, ChatGptModel chatModel) {
                 .build();
 
             Response chatGptResponse = openAIClient.responses().create(params);
+            metrics.count("chatgpt-prompted");
 
             String response = chatGptResponse.output()
                 .stream()

application/src/main/java/org/togetherjava/tjbot/features/code/CodeMessageHandler.java

@@ -17,6 +17,7 @@
 import org.togetherjava.tjbot.features.MessageReceiverAdapter;
 import org.togetherjava.tjbot.features.UserInteractionType;
 import org.togetherjava.tjbot.features.UserInteractor;
+import org.togetherjava.tjbot.features.analytics.Metrics;
 import org.togetherjava.tjbot.features.componentids.ComponentIdGenerator;
 import org.togetherjava.tjbot.features.componentids.ComponentIdInteractor;
 import org.togetherjava.tjbot.features.jshell.JShellEval;
@@ -52,6 +53,7 @@ public final class CodeMessageHandler extends MessageReceiverAdapter implements
     static final Color AMBIENT_COLOR = Color.decode("#FDFD96");
 
     private final ComponentIdInteractor componentIdInteractor;
+    private final Metrics metrics;
     private final Map<String, CodeAction> labelToCodeAction;
 
     /**
@@ -71,9 +73,12 @@ public final class CodeMessageHandler extends MessageReceiverAdapter implements
      * @param blacklist the feature blacklist, used to test if certain code actions should be
      *        disabled
      * @param jshellEval used to execute java code and build visual result
+     * @param metrics to track events
      */
-    public CodeMessageHandler(FeatureBlacklist<String> blacklist, JShellEval jshellEval) {
+    public CodeMessageHandler(FeatureBlacklist<String> blacklist, JShellEval jshellEval,
+            Metrics metrics) {
         componentIdInteractor = new ComponentIdInteractor(getInteractionType(), getName());
+        this.metrics = metrics;
 
         List<CodeAction> codeActions = blacklist
             .filterStream(Stream.of(new FormatCodeCommand(), new EvalCodeCommand(jshellEval)),
@@ -183,6 +188,7 @@ public void onButtonClick(ButtonInteractionEvent event, List<String> args) {
                 CodeFence code = extractCodeOrFallback(originalMessage.get().getContentRaw());
 
                 // Apply the selected action
+                metrics.count("code_action-" + codeAction.getLabel());
                 return event.getHook()
                     .editOriginalEmbeds(codeAction.apply(code))
                     .setActionRow(createButtons(originalMessageId, codeAction));

application/src/main/java/org/togetherjava/tjbot/features/filesharing/FileSharingMessageListener.java

@@ -18,6 +18,7 @@
 import org.togetherjava.tjbot.features.MessageReceiverAdapter;
 import org.togetherjava.tjbot.features.UserInteractionType;
 import org.togetherjava.tjbot.features.UserInteractor;
+import org.togetherjava.tjbot.features.analytics.Metrics;
 import org.togetherjava.tjbot.features.componentids.ComponentIdGenerator;
 import org.togetherjava.tjbot.features.componentids.ComponentIdInteractor;
 import org.togetherjava.tjbot.features.utils.Guilds;
@@ -46,6 +47,7 @@ public final class FileSharingMessageListener extends MessageReceiverAdapter
             new ComponentIdInteractor(getInteractionType(), getName());
 
     private final String githubApiKey;
+    private final Metrics metrics;
     private final Set<String> extensionFilter = Set.of("txt", "java", "gradle", "xml", "kt", "json",
             "fxml", "css", "c", "h", "cpp", "py", "yml");
 
@@ -56,11 +58,13 @@ public final class FileSharingMessageListener extends MessageReceiverAdapter
      * Creates a new instance.
      *
      * @param config used to get api key and channel names.
+     * @param metrics to track events
      * @see org.togetherjava.tjbot.features.Features
      */
-    public FileSharingMessageListener(Config config) {
+    public FileSharingMessageListener(Config config, Metrics metrics) {
         super(Pattern.compile(".*"));
         githubApiKey = config.getGitHubApiKey();
+        this.metrics = metrics;
         isHelpForumName =
                 Pattern.compile(config.getHelpSystem().getHelpForumPattern()).asMatchPredicate();
         isSoftModRole = Pattern.compile(config.getSoftModerationRolePattern()).asMatchPredicate();
@@ -112,6 +116,7 @@ public void onButtonClick(ButtonInteractionEvent event, List<String> args) {
             new GitHubBuilder().withOAuthToken(githubApiKey).build().getGist(gistId).delete();
             event.deferEdit().queue();
             event.getHook().deleteOriginal().queue();
+            metrics.count("file_sharing-deleted");
         } catch (IOException e) {
             logger.warn("Failed to delete gist with id {}", gistId, e);
         }
@@ -190,6 +195,7 @@ private void sendResponse(MessageReceivedEvent event, String url, String gistId)
                 componentIdInteractor.generateComponentId(message.getAuthor().getId(), gistId),
                 "Delete");
 
+        metrics.count("file_sharing-uploaded");
         message.reply(messageContent).setActionRow(gist, delete).queue();
     }
 

application/src/main/java/org/togetherjava/tjbot/features/github/GitHubReference.java

@@ -21,6 +21,7 @@
 
 import org.togetherjava.tjbot.config.Config;
 import org.togetherjava.tjbot.features.MessageReceiverAdapter;
+import org.togetherjava.tjbot.features.analytics.Metrics;
 
 import java.awt.Color;
 import java.io.FileNotFoundException;
@@ -67,6 +68,7 @@ public final class GitHubReference extends MessageReceiverAdapter {
             DateTimeFormatter.ofPattern("dd MMM, yyyy").withZone(ZoneOffset.UTC);
     private final Predicate<String> hasGithubIssueReferenceEnabled;
     private final Config config;
+    private final Metrics metrics;
 
     /**
      * The repositories that are searched when looking for an issue.
@@ -80,9 +82,11 @@ public final class GitHubReference extends MessageReceiverAdapter {
      * a predicate for matching allowed channels for feature and acquires repositories.
      *
      * @param config The Config to get allowed channel pattern for feature.
+     * @param metrics to track events
      */
-    public GitHubReference(Config config) {
+    public GitHubReference(Config config, Metrics metrics) {
         this.config = config;
+        this.metrics = metrics;
         this.hasGithubIssueReferenceEnabled =
                 Pattern.compile(config.getGitHubReferencingEnabledChannelPattern())
                     .asMatchPredicate();
@@ -142,6 +146,7 @@ private void replyBatchEmbeds(List<MessageEmbed> embeds, Message message,
                 ? message.getChannel().asThreadChannel()
                 : message.getChannel().asTextChannel();
 
+        metrics.count("gh_reference");
         for (List<MessageEmbed> messageEmbeds : partition) {
             if (isFirstBatch) {
                 message.replyEmbeds(messageEmbeds).mentionRepliedUser(mentionRepliedUser).queue();

application/src/main/java/org/togetherjava/tjbot/features/help/AutoPruneHelperRoutine.java

@@ -12,6 +12,7 @@
 import org.togetherjava.tjbot.config.HelperPruneConfig;
 import org.togetherjava.tjbot.db.Database;
 import org.togetherjava.tjbot.features.Routine;
+import org.togetherjava.tjbot.features.analytics.Metrics;
 import org.togetherjava.tjbot.features.moderation.audit.ModAuditLogWriter;
 
 import javax.annotation.Nullable;
@@ -45,6 +46,7 @@ public final class AutoPruneHelperRoutine implements Routine {
     private final HelpSystemHelper helper;
     private final ModAuditLogWriter modAuditLogWriter;
     private final Database database;
+    private final Metrics metrics;
     private final List<String> allCategories;
     private final Predicate<String> selectYourRolesChannelNamePredicate;
 
@@ -55,13 +57,15 @@ public final class AutoPruneHelperRoutine implements Routine {
      * @param helper the helper to use
      * @param modAuditLogWriter to inform mods when manual pruning becomes necessary
      * @param database to determine whether a user is inactive
+     * @param metrics to track events
      */
     public AutoPruneHelperRoutine(Config config, HelpSystemHelper helper,
-            ModAuditLogWriter modAuditLogWriter, Database database) {
+            ModAuditLogWriter modAuditLogWriter, Database database, Metrics metrics) {
         allCategories = config.getHelpSystem().getCategories();
         this.helper = helper;
         this.modAuditLogWriter = modAuditLogWriter;
         this.database = database;
+        this.metrics = metrics;
 
         HelperPruneConfig helperPruneConfig = config.getHelperPruneConfig();
         roleFullLimit = helperPruneConfig.roleFullLimit();
@@ -108,6 +112,7 @@ private void pruneRoleIfFull(List<Member> members, Role targetRole,
 
         if (isRoleFull(withRole)) {
             logger.debug("Helper role {} is full, starting to prune.", targetRole.getName());
+            metrics.count("autoprune_helper-" + targetRole.getName());
             pruneRole(targetRole, withRole, selectRoleChannel, when);
         }
     }

application/src/main/java/org/togetherjava/tjbot/features/help/GuildLeaveCloseThreadListener.java

@@ -7,20 +7,24 @@
 
 import org.togetherjava.tjbot.config.Config;
 import org.togetherjava.tjbot.features.EventReceiver;
+import org.togetherjava.tjbot.features.analytics.Metrics;
 
 /**
  * Remove all thread channels associated to a user when they leave the guild.
  */
 public final class GuildLeaveCloseThreadListener extends ListenerAdapter implements EventReceiver {
     private final String helpForumPattern;
+    private final Metrics metrics;
 
     /**
      * Creates a new instance.
      *
      * @param config the config to get help forum channel pattern from
+     * @param metrics to track events
      */
-    public GuildLeaveCloseThreadListener(Config config) {
+    public GuildLeaveCloseThreadListener(Config config, Metrics metrics) {
         this.helpForumPattern = config.getHelpSystem().getHelpForumPattern();
+        this.metrics = metrics;
     }
 
     @Override
@@ -35,8 +39,11 @@ public void onGuildMemberRemove(GuildMemberRemoveEvent event) {
             .queue(threads -> threads.stream()
                 .filter(thread -> thread.getOwnerIdLong() == event.getUser().getIdLong())
                 .filter(thread -> thread.getParentChannel().getName().matches(helpForumPattern))
-                .forEach(thread -> thread.sendMessageEmbeds(embed)
-                    .flatMap(_ -> thread.getManager().setArchived(true))
-                    .queue()));
+                .forEach(thread -> {
+                    metrics.count("op_left_thread");
+                    thread.sendMessageEmbeds(embed)
+                        .flatMap(_ -> thread.getManager().setArchived(true))
+                        .queue();
+                }));
     }
 }

application/src/main/java/org/togetherjava/tjbot/features/help/HelpSystemHelper.java

@@ -236,7 +236,6 @@ private RestAction<Message> useChatGptFallbackMessage(ThreadChannel threadChanne
     }
 
     void writeHelpThreadToDatabase(long authorId, ThreadChannel threadChannel) {
-
         Instant createdAt = threadChannel.getTimeCreated().toInstant();
 
         String appliedTags = threadChannel.getAppliedTags()