Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update documentation around logging #3852

Merged
merged 4 commits into from
Dec 16, 2024
Merged

docs: update documentation around logging #3852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00c2cde
docs: delete kibana-examples.md
Dec 2, 2024
6a49af8
docs: modified mkdocks.yml
Dec 6, 2024
4a34c87
docs: take out kibana details from logging.md
Dec 9, 2024
9dca924
docs: fix redirect for logging
Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 0 additions & 100 deletions docs/logging/kibana-examples.md
View file
Open in desktop

This file was deleted.

7 changes: 1 addition & 6 deletions docs/logging/logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Logging

Lagoon provides access to the following logs via Kibana:
Lagoon provides access to the following logs:

* Logs from the Kubernetes Routers, including every single HTTP and HTTPS request with:
* Source IP
Expand Down Expand Up @@ -31,10 +31,5 @@ Lagoon provides access to the following logs via Kibana:
* 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 contact {{ defaults.helpstring }} to get the URL for the Kibana route.

Each Lagoon user account has their own login and will see the logs only for the projects to which they have access.

Each Lagoon user account also has their own **Kibana Tenant**, which means no saved searches or visualizations are shared with another account.

If you would like to know more about how to use Kibana: [https://www.elastic.co/webinars/getting-started-kibana](https://www.elastic.co/webinars/getting-started-kibana).
5 changes: 3 additions & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,6 @@ nav:
- Role-Based Access Control (RBAC): interacting/rbac.md
- Understanding Logs:
- Logging: logging/logging.md
- Kibana Examples: logging/kibana-examples.md
- Installing Lagoon:
- Requirements: installing-lagoon/requirements.md
- Bulk storage Provisioner: installing-lagoon/bulk-storage-provisioner.md
Expand Down Expand Up @@ -416,7 +415,7 @@ plugins:
'lagoon/drupal/services/varnish.md': 'applications/drupal/services/varnish.md'
'lagoon/drupal/step-by-step-getting-drupal-ready-to-run-on-lagoon.md': 'applications/drupal/step-by-step-getting-drupal-ready-to-run-on-lagoon.md'
'lagoon/drupal/subfolders.md': 'applications/drupal/subfolders.md'
'lagoon/logging/kibana-examples.md': 'logging/kibana-examples.md'
'lagoon/logging/kibana-examples.md': 'logging/logging.md'
'lagoon/logging/logging.md': 'logging/logging.md'
'lagoon/resources/faq.md': 'resources/faq.md'
'lagoon/resources/glossary.md': 'resources/glossary.md'
Expand Down Expand Up @@ -498,3 +497,5 @@ plugins:
'drupal/services/solr-drupal.md': 'applications/drupal/services/solr.md'
'drupal/services/varnish-drupal.md': 'applications/drupal/services/varnish.md'
'installing-lagoon/efs-provisioner.md': 'installing-lagoon/bulk-storage-provisioner.md'
# December 2024 reorganization redirects
'logging/kibana-examples.md': 'logging/logging.md'
Loading