Add login and metrics docs

LibOps · Nov 18, 2023 · caf9600 · caf9600
1 parent b8f0196
commit caf9600
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 1 deletion.
diff --git a/docs/assets/img/metrics/coldstart.png b/docs/assets/img/metrics/coldstart.png
diff --git a/docs/assets/img/metrics/container-metrics-filters.gif b/docs/assets/img/metrics/container-metrics-filters.gif
diff --git a/docs/assets/img/metrics/container-metrics.gif b/docs/assets/img/metrics/container-metrics.gif
diff --git a/docs/assets/img/metrics/php-logs.gif b/docs/assets/img/metrics/php-logs.gif
diff --git a/docs/development/metrics.md b/docs/development/metrics.md
@@ -0,0 +1,29 @@
+# LibOps Metrics
+
+Your LibOps site services emits metrics that are aggregated and displayed on your LibOps Metrics dashboard. You can find the link to you dashboard at [https://www.libops.io/user](https://www.libops.io/user)
+
+## Timing metrics
+
+At the top of the metrics dashboard are metrics related to the number of requests and latency of those requests to your site, grouped by environment.
+
+There's also a metric to record how long your environment takes to come online after a cold start. Keep in mind, cold starts only happen during a period of inactivity to your development environment (and also your production environment for sites not on a payment plan)
+
+![Coldstart](../assets/img/metrics/coldstart.png)
+
+## PHP Logs
+
+The dashboard contains a filtered log view of any PHP errors that might be occurring on your site. There's also a link to the log explorer for further log analysis/troubleshooting.
+
+![PHP Logs](../assets/img/metrics/php-logs.gif)
+
+## Container metrics
+
+All of the services running on your LibOps envionrment have CPU, memory, i/o, and network metrics emitted. These metrics can be viewed as an aggregate of all environments and all containers
+
+![Container metrics](../assets/img/metrics/container-metrics.gif)
+
+### Filter container metrics
+
+You also can filter which container metrics to view by selecting `cluster` to filter by a given LibOps environment and/or selectioning `name` to filter by a given service
+
+![Filter metrics](../assets/img/metrics/container-metrics-filters.gif)
diff --git a/docs/site/login.md b/docs/site/login.md
@@ -0,0 +1,8 @@
+## Logging into your Drupal site
+
+When you first create a site on LibOps, logging into the admin account on the Drupal site can only be done by:
+
+1. Using [the LibOps CLI to run drush uli](../development/cli.md#drush).
+2. Accessing the login link [from your site dashboard](https://www.libops.io/user)
+
+Both approaches generate a one-time login link for the super user account on your Drupal site. Keep the link safe and never share it with anyone you don't want to have full administrative access to your site.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -17,4 +17,7 @@ nav:
     - LibOps CLI: development/cli.md
     - LibOps YML: development/yml.md
     - Redis: development/redis.md
-  - Site: 'site/index.md'
+    - Metrics: development/metrics.md
+  - Site:
+    - Overview: 'site/index.md'
+    - Login: 'site/login.md'