Add docs

Constantine0808 · May 29, 2024 · bca3902 · bca3902
1 parent b014ada
commit bca3902
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -97,6 +97,7 @@ Some of MadelineProto's core components are also available as separate, standalo
     * [Databases on docker](https://docs.madelineproto.xyz/docs/DOCKER.html#databases-on-docker)
     * [Web docker](https://docs.madelineproto.xyz/docs/DOCKER.html#web-docker)
     * [Custom extensions](https://docs.madelineproto.xyz/docs/DOCKER.html#custom-extensions)
+* [Metrics](https://docs.madelineproto.xyz/docs/METRICS.html) - MadelineProto can expose many useful metrics, that can be visualized using the official MadelineProto Grafana dashboard.
 * [Installation](https://docs.madelineproto.xyz/docs/INSTALLATION.html) - There are various ways to install MadelineProto:
   * [Simple](https://docs.madelineproto.xyz/docs/INSTALLATION.html#simple)
   * [Composer from existing project](https://docs.madelineproto.xyz/docs/INSTALLATION.html#composer-from-existing-project)

diff --git a/docs b/docs
diff --git a/src/GarbageCollector.php b/src/GarbageCollector.php
@@ -76,6 +76,7 @@ public static function start(): void
         self::$inuse = self::$prometheus->registerGauge("MadelineProto", "php_memstats_inuse_bytes", "RAM actually used by PHP");
 
         $counter = self::$prometheus->registerCounter("MadelineProto", "explicit_gc_count", "Number of times the GC was explicitly invoked");
+        $counter->incBy(0);
         EventLoop::unreference(EventLoop::repeat(1, static function () use ($counter): void {
             $currentMemory = self::getMemoryConsumption();
             if ($currentMemory > self::$memoryConsumption + self::$memoryDiffMb) {

diff --git a/tools/build_docs.php b/tools/build_docs.php
@@ -99,6 +99,7 @@
     'FEATURES',
     'REQUIREMENTS',
     'DOCKER',
+    'METRICS',
     'INSTALLATION',
     'BROADCAST',
     'UPDATES',
+1 −1		docs/docs/ASYNC.md
+1 −1		docs/docs/BROADCAST.md
+1 −1		docs/docs/CALLS.md
+1 −1		docs/docs/CHAT_INFO.md
+1 −1		docs/docs/CONTRIB.md
+1 −1		docs/docs/DATABASE.md
+1 −1		docs/docs/DIALOGS.md
+3 −3		docs/docs/DOCKER.md
+1 −1		docs/docs/EXCEPTIONS.md
+1 −1		docs/docs/FAQ.md
+1 −1		docs/docs/FILES.md
+1 −1		docs/docs/FILTERS.md
+1 −1		docs/docs/FLOOD_WAIT.md
+1 −1		docs/docs/INLINE_BUTTONS.md
+1 −1		docs/docs/INSTALLATION.md
+1 −1		docs/docs/LOGGING.md
+112 −0		docs/docs/METRICS.md
+1 −1		docs/docs/PLUGINS.md
+1 −1		docs/docs/PROXY.md
+1 −1		docs/docs/SECRET_CHATS.md
+1 −1		docs/docs/SELF.md
+1 −1		docs/docs/SETTINGS.md
+1 −1		docs/docs/TEMPLATES.md
+1 −1		docs/docs/UPDATES.md
+1 −1		docs/docs/UPGRADING.md
+1 −1		docs/docs/USING_METHODS.md
+1 −0		docs/index.md