From c86c3c0a30a87eba3ada305fc70162ea8c875a54 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ren=C3=A9?= <rene@gofiber.io>
Date: Wed, 9 Oct 2024 09:41:15 +0200
Subject: [PATCH] Update documentation for monitor middleware migration

---
 docs/middleware/monitor.md | 94 --------------------------------------
 docs/whats_new.md          | 28 +++++++++---
 2 files changed, 22 insertions(+), 100 deletions(-)
 delete mode 100644 docs/middleware/monitor.md

diff --git a/docs/middleware/monitor.md b/docs/middleware/monitor.md
deleted file mode 100644
index aa3b1c89ee..0000000000
--- a/docs/middleware/monitor.md
+++ /dev/null
@@ -1,94 +0,0 @@
----
-id: monitor
----
-
-# Monitor
-
-Monitor middleware for [Fiber](https://github.com/gofiber/fiber) that reports server metrics, inspired by [express-status-monitor](https://github.com/RafalWilinski/express-status-monitor)
-
-:::caution
-
-Monitor is still in beta, API might change in the future!
-
-:::
-
-![](https://i.imgur.com/nHAtBpJ.gif)
-
-## Signatures
-
-```go
-func New() fiber.Handler
-```
-
-## Examples
-
-Import the middleware package that is part of the Fiber web framework
-
-```go
-import (
-    "github.com/gofiber/fiber/v3"
-    "github.com/gofiber/fiber/v3/middleware/monitor"
-)
-```
-
-After you initiate your Fiber app, you can use the following possibilities:
-
-```go
-// Initialize default config (Assign the middleware to /metrics)
-app.Get("/metrics", monitor.New())
-
-// Or extend your config for customization
-// Assign the middleware to /metrics
-// and change the Title to `MyService Metrics Page`
-app.Get("/metrics", monitor.New(monitor.Config{Title: "MyService Metrics Page"}))
-```
-
-You can also access the API endpoint with
-`curl -X GET -H "Accept: application/json" http://localhost:3000/metrics` which returns:
-
-```json
-{
-    "pid":{ 
-        "cpu":0.4568381746582226,
-        "ram":20516864,
-        "conns":3
-    },
-    "os": {
-        "cpu":8.759124087593099,  "ram":3997155328, "conns":44,
-        "total_ram":8245489664, "load_avg":0.51
-    }
-}
-```
-
-## Config
-
-| Property   | Type                    | Description                                                         | Default                                                                                             |
-|:-----------|:------------------------|:--------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------|
-| Title      | `string`                | Metrics page title                                                  | "Fiber Monitor"                                                                                     |
-| Refresh    | `time.Duration`         | Refresh period                                                      | 3 seconds                                                                                           |
-| APIOnly    | `bool`                  | Whether the service should expose only the monitoring API           | false                                                                                               |
-| Next       | `func(fiber.Ctx) bool` | Next defines a function to skip this middleware when returned true. | `nil`                                                                                               |
-| CustomHead | `string`                | Custom HTML Code to Head Section(Before End)                        | empty                                                                                               |
-| FontURL    | `string`                | FontURL for specify font resource path or URL                       | "[fonts.googleapis.com](https://fonts.googleapis.com/css2?family=Roboto:wght@400;900&display=swap)" |
-| ChartJsURL | `string`                | ChartJsURL for specify ChartJS library path or URL                  | "[cdn.jsdelivr.net](https://cdn.jsdelivr.net/npm/chart.js@2.9/dist/Chart.bundle.min.js)"          |
-
-## Default Config
-
-```go
-var ConfigDefault = Config{
-    Title:      defaultTitle,
-    Refresh:    defaultRefresh,
-    FontURL:    defaultFontURL,
-    ChartJsURL: defaultChartJSURL,
-    CustomHead: defaultCustomHead,
-    APIOnly:    false,
-    Next:       nil,
-    index: newIndex(viewBag{
-        defaultTitle,
-        defaultRefresh,
-        defaultFontURL,
-        defaultChartJSURL,
-        defaultCustomHead,
-    }),
-}
-```
diff --git a/docs/whats_new.md b/docs/whats_new.md
index 963d1daece..6449d24292 100644
--- a/docs/whats_new.md
+++ b/docs/whats_new.md
@@ -325,11 +325,7 @@ Now, static middleware can do everything that filesystem middleware and static d
 
 ### Monitor
 
-:::caution
-DRAFT section
-:::
-
-Monitor middleware is now in Contrib package.
+Monitor middleware is migrated to the [Contrib package](https://github.com/gofiber/contrib/tree/main/monitor) with [PR #1172](https://github.com/gofiber/contrib/pull/1172).
 
 ### Healthcheck
 
@@ -526,7 +522,7 @@ app.Use(static.New("", static.Config{
 }))
 ```
 
-### Healthcheck
+#### Healthcheck
 
 Previously, the Healthcheck middleware was configured with a combined setup for liveliness and readiness probes:
 
@@ -570,3 +566,23 @@ app.Get(healthcheck.DefaultStartupEndpoint, healthcheck.NewHealthChecker(healthc
 // Custom liveness endpoint configuration
 app.Get("/live", healthcheck.NewHealthChecker())
 ```
+
+#### Monitor
+
+Since v3 the Monitor middleware has been moved to the [Contrib package](https://github.com/gofiber/contrib/tree/main/monitor)
+
+```go
+// Before
+import "github.com/gofiber/fiber/v2/middleware/monitor"
+
+app.Use("/metrics", monitor.New())
+```
+
+You only need to change the import path to the contrib package.
+
+```go
+// After
+import "github.com/gofiber/contrib/monitor"
+
+app.Use("/metrics", monitor.New())
+```