]> git.mxchange.org Git - friendica.git/commitdiff
Add doc
authorPhilipp <admin@philipp.info>
Sat, 26 Apr 2025 23:58:20 +0000 (01:58 +0200)
committerPhilipp <admin@philipp.info>
Sun, 27 Apr 2025 19:26:50 +0000 (21:26 +0200)
doc/stats.md [new file with mode: 0644]
doc/tools.md

diff --git a/doc/stats.md b/doc/stats.md
new file mode 100644 (file)
index 0000000..1b6a2df
--- /dev/null
@@ -0,0 +1,35 @@
+Monitoring
+===========
+
+* [Home](help)
+
+## Endpoints
+
+Currently, there are two endpoints for statistics available
+
+-      `/stats` Returns some basic statistics of the current node
+-      `/stats/caching` Returns statistics of cache or lock instances, which are used for the currend node
+
+### `/stats`
+
+The statistics contain data about the worker performance, the last cron call, number of reports, inbound and outbound packets, posts and comments.
+
+### `/stats/caching`
+
+The statistics contain data about the opcache, the used caching (like memory usage, hits/misses, entries, ...) and the used lock (including the cache data)
+
+## Configuration
+
+Please define 'stats_key' in your local.config.php in the 'system' section to be able to access the statistics page at /stats?key=your-defined-stats_key
+
+## 3rd Party monitoring tools
+
+### Zabbix
+
+To monitor the health status of your Friendica installation, you can use for example a tool like Zabbix.
+
+### Prometheus
+
+To use [prometheus](https://prometheus.io) for gathering metrics, use the [Friendica exporter](https://git.friendi.ca/friendica/friendica-exporter).
+
+You can find the installation instructions here: https://git.friendi.ca/friendica/friendica-exporter#installation
index 2a273e365076c3575125a223872954df531c57e8..fac1f4b392b12d8d3e6defeb40601b276deec07a 100644 (file)
@@ -78,15 +78,3 @@ The following will compress */var/log/friendica* (assuming this is the location
                daily
                rotate 2
        }
-
-### Zabbix
-
-To monitor the health status of your Friendica installation, you can use for example a tool like Zabbix. Please define 'stats_key' in your local.config.php in the 'system' section to be able to access the statistics page at /stats?key=your-defined-stats_key
-
-The statistics contain data about the worker performance, the last cron call, number of reports, inbound and outbound packets, posts and comments.
-
-### Prometheus
-
-To use [prometheus](https://prometheus.io) for gathering metrics, use the [Friendica exporter](https://git.friendi.ca/friendica/friendica-exporter).
-
-You can find the installation instructions here: https://git.friendi.ca/friendica/friendica-exporter#installation