Merge pull request #3079 from uselagoon/docs-fixes

uselagoon · Mar 30, 2022 · 7e20867 · 7e20867
2 parents 3c99e19 + f253b8a
commit 7e20867
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 25 deletions.
diff --git a/docs/contributing-to-lagoon/documentation.md b/docs/contributing-to-lagoon/documentation.md
@@ -8,18 +8,23 @@ We use [mkdocs](https://www.mkdocs.org/) with the excellent [Material](https://s
 
 ## Viewing and updating docs locally
 
-From the root of this repo, just run
+From the root of this repo, just run:
 
-`docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
+```bash
+docker run --rm -it -p 127.0.0.1:8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
+```
 
-and this will start a development server on your local port 8000, configured to livereload on any updates.  The docker image contains all the necessary extensions.
+<!-- markdown-link-check-disable-next-line -->
+This will start a development server on [http://127.0.0.1:8000](http://127.0.0.1:8000), configured to live-reload on any updates.
+The Docker image contains all the necessary extensions.
 
 ## Editing in the cloud
 
 Each documentation page also has an "edit" pencil in the top right, that will take you to the correct page in the git repository.
 
-Feel free to contribute here too - you can always use the inbuilt [github.dev web-based editor](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor). It's got basic markdown previews, but none of the mkdocs loveliness
+Feel free to contribute here too - you can always use the inbuilt [github.dev web-based editor](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor).
+It's got basic markdown previews, but none of the mkdocs loveliness
 
 ## How we deploy documentation
 
-We use the [Deploy MkDocs](https://github.com/marketplace/actions/deploy-mkdocs) GitHub Action to build all main branch pushes, and trigger a deployment of the gh-pages branch.
+We use the [Deploy MkDocs](https://github.com/marketplace/actions/deploy-mkdocs) GitHub Action to build all main branch pushes, and trigger a deployment of the `gh-pages` branch.
diff --git a/docs/logging/logging.md b/docs/logging/logging.md
@@ -3,29 +3,33 @@
 Lagoon provides access to the following logs via Kibana:
 
 * Logs from the Kubernetes Routers, including every single HTTP and HTTPS request with:
-  * Source IP
-  * URL
-  * Path
-  * HTTP verb
-  * Cookies
-  * Headers
-  * User agent
-  * Project
-  * Container name
-  * Response size
-  * Response time
+    * Source IP
+    * URL
+    * Path
+    * HTTP verb
+    * Cookies
+    * Headers
+    * User agent
+    * Project
+    * Container name
+    * Response size
+    * Response time
 * Logs from containers:
-  * `stdout` and `stderr` messages
-  * Container name
-  * Project
+    * `stdout` and `stderr` messages
+    * Container name
+    * Project
 * Lagoon logs:
-  * Webhooks parsing
-  * Build logs
-  * Build errors
-  * Any other Lagoon related logs
+    * Webhooks parsing
+    * Build logs
+    * Build errors
+    * Any other Lagoon related logs
 * Application logs:
-  * Any logs sent by the running application
-  * For Drupal: install the [Lagoon Logs](https://www.drupal.org/project/lagoon_logs) module in order to receive logs from Drupal Watchdog.
+    * For Drupal: install the [Lagoon Logs](https://www.drupal.org/project/lagoon_logs) module in order to receive logs from Drupal Watchdog.
+    * For Laravel: install the [Lagoon Logs for Laravel](https://github.com/amazeeio/laravel_lagoon_logs) package.
+    * For other workloads:
+        * Send logs to `udp://application-logs.lagoon.svc:5140`
+        * Ensure logs are structured as JSON encoded objects.
+        * Ensure the `type` field contains the name of the Kubernetes namespace (`$LAGOON_PROJECT-$LAGOON_ENVIRONMENT`).
 
 To access the logs, please check with your Lagoon administrator to get the URL for the Kibana route \(for amazee.io this is [https://logs.amazeeio.cloud/](https://logs.amazeeio.cloud/)\).