From 12b9b48f51cc5c71a1491acb5df0052eaf97dce0 Mon Sep 17 00:00:00 2001
From: Sebastiaan van Steenis <mail@superseb.nl>
Date: Wed, 1 Apr 2020 14:15:59 +0200
Subject: [PATCH] Describe Rancher log levels

---
 .../rancher/v2.x/en/faq/technical/_index.md   | 50 +------------------
 .../rancher/v2.x/en/troubleshooting/_index.md |  5 ++
 .../v2.x/en/troubleshooting/logging/_index.md | 48 ++++++++++++++++++
 3 files changed, 54 insertions(+), 49 deletions(-)
 create mode 100644 content/rancher/v2.x/en/troubleshooting/logging/_index.md

diff --git a/content/rancher/v2.x/en/faq/technical/_index.md b/content/rancher/v2.x/en/faq/technical/_index.md
index d5b22464771..1340d9623e3 100644
--- a/content/rancher/v2.x/en/faq/technical/_index.md
+++ b/content/rancher/v2.x/en/faq/technical/_index.md
@@ -56,55 +56,7 @@ New password for default admin user (user-xxxxx):
 
 ### How can I enable debug logging?
 
-* Docker Install
- * Enable
-```
-$ docker exec -ti <container_id> loglevel --set debug
-OK
-$ docker logs -f <container_id>
-```
-
- * Disable
-```
-$ docker exec -ti <container_id> loglevel --set info
-OK
-```
-
-* Kubernetes install (Helm)
- * Enable
-```
-$ KUBECONFIG=./kube_config_rancher-cluster.yml
-$ kubectl --kubeconfig $KUBECONFIG -n cattle-system get pods -l app=rancher | grep '1/1' | awk '{ print $1 }' | xargs -I{} kubectl --kubeconfig $KUBECONFIG -n cattle-system exec {} -- loglevel --set debug
-OK
-OK
-OK
-$ kubectl --kubeconfig $KUBECONFIG -n cattle-system logs -l app=rancher
-```
-
- * Disable
-```
-$ KUBECONFIG=./kube_config_rancher-cluster.yml
-$ kubectl --kubeconfig $KUBECONFIG -n cattle-system get pods -l app=rancher | grep '1/1' | awk '{ print $1 }' | xargs -I{} kubectl --kubeconfig $KUBECONFIG -n cattle-system exec {} -- loglevel --set info
-OK
-OK
-OK
-```
-
-* Kubernetes install (RKE add-on)
- * Enable
-```
-$ KUBECONFIG=./kube_config_rancher-cluster.yml
-$ kubectl --kubeconfig $KUBECONFIG exec -n cattle-system $(kubectl --kubeconfig $KUBECONFIG get pods -n cattle-system -o json | jq -r '.items[] | select(.spec.containers[].name=="cattle-server") | .metadata.name') -- loglevel --set debug
-OK
-$ kubectl --kubeconfig $KUBECONFIG logs -n cattle-system -f $(kubectl --kubeconfig $KUBECONFIG get pods -n cattle-system -o json | jq -r '.items[] | select(.spec.containers[].name="cattle-server") | .metadata.name')
-```
-
- * Disable
-```
-$ KUBECONFIG=./kube_config_rancher-cluster.yml
-$ kubectl --kubeconfig $KUBECONFIG exec -n cattle-system $(kubectl --kubeconfig $KUBECONFIG get pods -n cattle-system -o json | jq -r '.items[] | select(.spec.containers[].name=="cattle-server") | .metadata.name') -- loglevel --set info
-OK
-```
+See [Troubleshooting: Logging]({{<baseurl>}}/rancher/v2.x/en/troubleshooting/logging/)
 
 ### My ClusterIP does not respond to ping
 
diff --git a/content/rancher/v2.x/en/troubleshooting/_index.md b/content/rancher/v2.x/en/troubleshooting/_index.md
index aa6c57afe66..edb5fb4f061 100644
--- a/content/rancher/v2.x/en/troubleshooting/_index.md
+++ b/content/rancher/v2.x/en/troubleshooting/_index.md
@@ -35,3 +35,8 @@ This section contains information to help you troubleshoot issues when using Ran
 - [Imported clusters]({{<baseurl>}}/rancher/v2.x/en/troubleshooting/imported-clusters/)
 
     If you experience issues when [Importing Kubernetes Clusters]({{<baseurl>}}/rancher/v2.x/en/cluster-provisioning/imported-clusters/)
+
+- [Logging]({{<baseurl>}}/rancher/v2.x/en/troubleshooting/logging/)
+
+    Read more about what log levels can be configured and how to configure a log level.
+
diff --git a/content/rancher/v2.x/en/troubleshooting/logging/_index.md b/content/rancher/v2.x/en/troubleshooting/logging/_index.md
new file mode 100644
index 00000000000..50024334901
--- /dev/null
+++ b/content/rancher/v2.x/en/troubleshooting/logging/_index.md
@@ -0,0 +1,48 @@
+---
+title: Logging
+weight: 110
+---
+
+The following log levels are used in Rancher:
+
+| Name    | Description |
+|---------|-------------|
+| `info`  | Logs informational messages. This is the default log level. |
+| `debug` | Logs more detailed messages that can be used to debug. |
+| `trace` | Logs very detailed messages on internal functions. This is very verbose and can contain sensitive information. |
+
+### How to configure a log level
+
+* Kubernetes install
+ * Configure debug log level
+```
+$ KUBECONFIG=./kube_config_rancher-cluster.yml
+$ kubectl --kubeconfig $KUBECONFIG -n cattle-system get pods -l app=rancher | grep '1/1' | awk '{ print $1 }' | while read rancherpod; do kubectl --kubeconfig $KUBECONFIG -n cattle-system exec $rancherpod -- loglevel --set debug; done
+OK
+OK
+OK
+$ kubectl --kubeconfig $KUBECONFIG -n cattle-system logs -l app=rancher
+```
+
+ * Configure info log level
+```
+$ KUBECONFIG=./kube_config_rancher-cluster.yml
+$ kubectl --kubeconfig $KUBECONFIG -n cattle-system get pods -l app=rancher | grep '1/1' | awk '{ print $1 }' | while read rancherpod; do kubectl --kubeconfig $KUBECONFIG -n cattle-system exec $rancherpod -- loglevel --set info; done
+OK
+OK
+OK
+```
+
+* Docker Install
+ * Configure debug log level
+```
+$ docker exec -ti <container_id> loglevel --set debug
+OK
+$ docker logs -f <container_id>
+```
+
+ * Configure info log level
+```
+$ docker exec -ti <container_id> loglevel --set info
+OK
+```