Skip to content

Node.js based forum software built for the modern web

feat(federation): add activities-by-type pie chart to analytics page

Julian Lamb23912c0d582
diff --git a/public/language/en-GB/admin/settings/activitypub.json b/public/language/en-GB/admin/settings/activitypub.json
index 9f528c9507..45cbb1f38e 100644
--- a/public/language/en-GB/admin/settings/activitypub.json
+++ b/public/language/en-GB/admin/settings/activitypub.json
@@ -103,6 +103,8 @@
"analytics.term": "Time scale",
"analytics.hourly": "Hourly",
"analytics.daily": "Daily",
+ "analytics.activities_by_type": "Activities by Type",
+ "analytics.activities_by_type_not_filterable": "<strong>Note:</strong> This breakdown is global and not filtered by the selected hostname.",
"errors.intro": "The following %1 error(s) were recorded by this instance within the last 24 hours.",
"errors.payload-gone": "The payload for this error no longer exists.",
diff --git a/public/src/admin/federation/analytics.js b/public/src/admin/federation/analytics.js
index 4fb6c75cf8..55308a54a1 100644
--- a/public/src/admin/federation/analytics.js
+++ b/public/src/admin/federation/analytics.js
@@ -8,6 +8,8 @@ import {
Tooltip,
Filler,
Legend,
+ PieController,
+ ArcElement,
} from 'chart.js';
import { get } from 'api';
@@ -21,7 +23,9 @@ Chart.register(
PointElement,
Tooltip,
Filler,
- Legend
+ Legend,
+ PieController,
+ ArcElement
);
let charts;
@@ -34,9 +38,17 @@ const labels = new Map([
})],
]);
+const pieColors = [
+ '#5954e8', '#7892a4', '#a3b56c', '#ab4642',
+ '#d4a017', '#28a745', '#dc3545', '#6f42c1',
+ '#e83e8c', '#fd7e14', '#20c997', '#17a2b8',
+];
+
export async function init() {
charts = await initializeCharts();
+ await renderActivitiesByTypeLegend();
+
const hostFilterEl = document.getElementById('hostFilter');
const termEl = document.getElementById('term');
if (hostFilterEl) {
@@ -61,6 +73,30 @@ async function updateCharts() {
});
}
+async function renderActivitiesByTypeLegend() {
+ const legendEl = document.getElementById('activitiesByTypeLegend');
+ if (!legendEl) return;
+
+ const byType = ajaxify.data.data.byType;
+ const total = Object.values(byType).reduce((sum, v) => sum + v, 0);
+
+ const entries = Object.entries(byType)
+ .filter(([type, count]) => count > 0)
+ .sort(([, a], [, b]) => b - a);
+
+ const items = entries.map(([type, count], idx) => {
+ const color = pieColors[idx % pieColors.length];
+ const pct = total > 0 ? ((count / total) * 100).toFixed(1) : 0;
+ return `<li class="mb-2">
+ <span class="badge me-2" style="background-color: ${color};">&nbsp;</span>
+ <span>${type}</span>
+ <span class="float-end">${count} (${pct}%)</span>
+ </li>`;
+ }).join('');
+
+ legendEl.innerHTML = items;
+}
+
async function initializeCharts() {
const receivedCanvas = document.getElementById('received');
const sentCanvas = document.getElementById('sent');
diff --git a/src/controllers/admin/federation.js b/src/controllers/admin/federation.js
index 6861073463..62aad1016c 100644
--- a/src/controllers/admin/federation.js
+++ b/src/controllers/admin/federation.js
@@ -100,6 +100,8 @@ federationController.analytics = async function (req, res) {
const sent = await analytics[method](sentSet, Date.now(), count);
const sentErr = await analytics[method](sentErrSet, Date.now(), count);
+ const byType = await getActivitiesByType();
+
res.render('admin/federation/analytics', {
title: '[[admin/menu:federation/analytics]]',
instances,
@@ -108,11 +110,27 @@ federationController.analytics = async function (req, res) {
receivedErr,
sent,
sentErr,
+ byType,
},
hideSave: 1,
});
};
+async function getActivitiesByType() {
+ const analyticsKeys = await db.getSortedSetRange('analyticsKeys', 0, -1);
+ const typeKeys = analyticsKeys.filter((key) => key.startsWith('activities:byType:'));
+
+ const results = await Promise.all(typeKeys.map(async (key) => {
+ const entries = await db.getSortedSetRangeWithScores(`analytics:${key}`, 0, -1);
+ return {
+ type: key.replace('activities:byType:', ''),
+ count: entries.reduce((sum, { score }) => sum + score, 0),
+ };
+ }));
+
+ return Object.fromEntries(results.map(({ type, count }) => [type, count]));
+}
+
federationController.errors = async function (req, res) {
const { hostname: filterHostname, type: filterType } = req.query;
let errors = await db.getSortedSetRevRangeByScoreWithScores('ap.errors', 0, -1, Date.now(), '-inf');
diff --git a/src/views/admin/federation/analytics.tpl b/src/views/admin/federation/analytics.tpl
index 4a251cd7d5..f6e246788c 100644
--- a/src/views/admin/federation/analytics.tpl
+++ b/src/views/admin/federation/analytics.tpl
@@ -50,6 +50,25 @@
</div>
</div>
</div>
+
+ <div class="mb-4">
+ <div class="card">
+ <div class="card-header">{{tx("admin/settings/activitypub:analytics.activities_by_type")}}</div>
+ <div class="card-body">
+ <div class="row">
+ <div class="col-md-6">
+ <div class="position-relative" style="aspect-ratio: 1;">
+ <canvas id="activitiesByType"></canvas>
+ </div>
+ </div>
+ <div class="col-md-6 d-flex align-items-center">
+ <ul id="activitiesByTypeLegend" class="list-unstyled mb-0"></ul>
+ </div>
+ </div>
+ <p class="text-muted mt-3 mb-0 small">{{tx("admin/settings/activitypub:analytics.activities_by_type_not_filterable")}}</p>
+ </div>
+ </div>
+ </div>
</div>
<!-- IMPORT admin/partials/settings/toc.tpl -->