Merge pull request #765 from themr0c/retrieving-che-logs

Retrieving Che logs

src/main/_data/sidebars/che_7_docs.yml

@@ -79,6 +79,9 @@ entries:
     #- title: Customizing plug-in registry
       #url: customizing-plug-in-registry.html
       #output: web
+    - title: Retrieving Che logs
+      url: retrieving-che-logs.html
+      output: web
     - title: Monitoring Che
       url: monitoring-che.html
       output: web

src/main/pages/che-7/administration-guide/assembly_monitoring-che.adoc

@@ -30,13 +30,12 @@ image::monitoring/monitoring-che-stack-structure.png[link="{imagesdir}/monitorin
 == Enabling Che metrics collections
 
 [id='prerequisites-{context}',discrete]
-== Prerequisites
+.Prerequisites
 
 * Installed Prometheus 2.9.1 or above. See more link:https://prometheus.io/docs/introduction/first_steps/[https://prometheus.io/docs/introduction/first_steps/].
 * Installed Grafana 6.0 or above. See more at link:https://grafana.com/docs/installation/[https://grafana.com/docs/installation/]
 
-[discrete]
-== Procedure
+.Procedure
 
 . Set the `CHE_METRICS_ENABLED=true` environment variable
 . Expose the `8087` port as a service on the che-master host

src/main/pages/che-7/administration-guide/assembly_retrieving-che-logs.adoc

@@ -0,0 +1,33 @@
+---
+title: Retrieving Che logs
+keywords: 
+tags: 
+  - logs
+sidebar: che_7_docs
+permalink: che-7/retrieving-che-logs.html
+folder: che-7/administration-guide
+summary: 
+---
+
+:parent-context-of-retrieving-che-logs: {context}
+
+[id='retrieving-che-logs_{context}']
+= Retrieving Che logs
+
+:context: retrieving-che-logs
+
+This is a catalog of the location and instructions to retrieve application logs (for admins and for users).
+
+include::proc_viewing-kubernetes-events.adoc[leveloffset=+1]
+
+include::assembly_viewing-che-server-logs.adoc[leveloffset=+1]
+
+include::assembly_viewing-external-service-logs.adoc[leveloffset=+1]
+
+include::assembly_viewing-che-workspaces-logs.adoc[leveloffset=+1]
+
+// TODO: include::proc_viewing-che-operator-logs.adoc[leveloffset=+1]
+
+// TODO: include::proc_viewing-chectl-logs.adoc[leveloffset=+1]
+
+:context: {parent-context-of-retrieving-che-logs}

src/main/pages/che-7/administration-guide/assembly_troubleshooting-for-che-administrators.adoc

@@ -19,16 +19,17 @@ summary:
 This paragraph is the assembly introduction. It explains what the user will accomplish by working through the modules in the assembly and sets the context for the user story the assembly is based on. Can include more than one paragraph. Consider using the information from the user story.
 
 [id='prerequisites-{context}']
-== Prerequisites
+.Prerequisites
 
 * A bulleted list of conditions that must be satisfied before the user starts following this assembly.
 * You can also link to other modules or assemblies the user must follow before starting this assembly.
 * Delete the section title and bullets if the assembly has no prerequisites.
 
 
-Include modules here.
 
+include::proc_removing-user-data.adoc[leveloffset=+1]
 
+include::assembly_retrieving-che-logs.adoc[leveloffset=+1]
 
 [id='related-information-{context}']
 == Related information

src/main/pages/che-7/administration-guide/assembly_viewing-che-server-logs.adoc

@@ -0,0 +1,18 @@
+// Module included in the following assemblies:
+//
+// retrieving-che-logs
+
+:parent-context-of-viewing-che-server-logs: {context}
+
+[id='viewing-che-server-logs_{context}']
+= Viewing Che server logs
+
+:context: viewing-che-server-logs
+
+This section describes how to view the Che server logs on the console and on the command line.
+
+include::proc_viewing-che-server-logs-in-the-web-console.adoc[leveloffset=+1]
+
+include::proc_viewing-che-server-logs-on-the-cli.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-che-server-logs}

src/main/pages/che-7/administration-guide/assembly_viewing-che-theia-ide-logs.adoc

@@ -0,0 +1,14 @@
+:parent-context-of-viewing-che-theia-ide-logs: {context}
+
+[id='viewing-che-theia-ide-logs_{context}']
+= Viewing Che-Theia IDE logs
+
+:context: viewing-theia-ide-logs
+
+This section describes how to view Che-Theia IDE logs, on the command line and in the OpenShift web console.
+
+include::proc_viewing-che-theia-ide-logs-on-the-cli.adoc[leveloffset=+1]
+
+include::proc_viewing-che-theia-ide-logs-in-the-web-console.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-che-theia-ide-logs}

src/main/pages/che-7/administration-guide/assembly_viewing-che-workspaces-logs.adoc

@@ -0,0 +1,16 @@
+:parent-context-of-viewing-che-workspaces-logs: {context}
+
+[id='viewing-che-workspaces-logs_{context}']
+= Viewing Che workspaces logs
+
+:context: viewing-che-workspaces-logs
+
+This section describes how to view Che workspaces logs.
+
+// TODO: include::proc_viewing-plug-in-broker-logs.adoc[leveloffset=+1]
+
+include::assembly_viewing-che-theia-ide-logs.adoc[leveloffset=+1]
+
+include::assembly_viewing-logs-from-language-servers-and-debug-adapters.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-che-workspaces-logs}

src/main/pages/che-7/administration-guide/assembly_viewing-external-service-logs.adoc

@@ -0,0 +1,20 @@
+// Module included in the following assemblies:
+//
+// retrieving-che-logs
+
+:parent-context-of-viewing-external-service-logs: {context}
+
+[id='viewing-external-service-logs_{context}']
+= Viewing external service logs
+
+This section describes how the view the logs from external services related to Che server.
+
+include::assembly_viewing-keycloak-logs.adoc[leveloffset=+1]
+
+include::proc_viewing-postgresql-server-logs.adoc[leveloffset=+1]
+
+// TODO: include::proc_viewing-prometheus-logs.adoc[leveloffset=+1]
+
+// TODO: include::proc_viewing-grafana-logs.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-external-service-logs}

src/main/pages/che-7/administration-guide/assembly_viewing-keycloak-logs.adoc

@@ -0,0 +1,16 @@
+:parent-context-of-viewing-keycloak-logs: {context}
+
+[id='viewing-keycloak-logs_{context}']
+= Viewing Keycloak logs
+
+:context: viewing-keycloak-logs
+
+The Keycloak OpenID provider consists of two parts: Server and IDE. It writes its diagnostics or error information to several logs.
+
+include::proc_viewing-keycloak-server-logs.adoc[leveloffset=+1]
+
+include::proc_viewing-keycloak-client-logs-on-firefox.adoc[leveloffset=+1]
+
+include::proc_viewing-keycloak-client-logs-on-google-chrome.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-keycloak-logs}

src/main/pages/che-7/administration-guide/assembly_viewing-logs-for-camel.adoc

@@ -0,0 +1,12 @@
+:parent-context-of-viewing-logs-for-camel: {context}
+
+[id='viewing-logs-for-camel_{context}']
+= Viewing logs for Camel
+
+:context: viewing-logs-for-camel
+
+include::proc_verifying-the-state-of-the-camel-language-server.adoc[leveloffset=+1]
+
+include::proc_viewing-camel-logs-in-the-output-panel.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-logs-for-camel}

src/main/pages/che-7/administration-guide/assembly_viewing-logs-for-dotnet-with-netcoredebugoutput-plug-in.adoc

@@ -0,0 +1,14 @@
+:parent-context-of-viewing-logs-for-dotnet-with-netcoredebugoutput-plug-in: {context}
+
+[id='viewing-logs-for-dotnet-with-netcoredebugoutput-plug-in_{context}']
+= Viewing logs for Dotnet with NetcoredebugOutput plug-in
+
+:context: viewing-logs-for-dotnet-with-netcoredebugoutput-plug-in
+
+include::ref_netcoredebugoutput-plug-in.adoc[leveloffset=+1]
+
+include::proc_verifying-the-state-of-the-netcoredebugoutput-plug-in.adoc[leveloffset=+1]
+
+include::proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-logs-for-dotnet-with-netcoredebugoutput-plug-in}

src/main/pages/che-7/administration-guide/assembly_viewing-logs-for-dotnet-with-omnisharp-theia-plug-in.adoc

@@ -0,0 +1,16 @@
+:parent-context-of-viewing-logs-for-dotnet-with-omnisharp-theia-plug-in: {context}
+
+[id='viewing-logs-for-dotnet-with-omnisharp-theia-plug-in_{context}']
+= Viewing logs for Dotnet with Omnisharp-Theia plug-in
+
+:context: viewing-logs-for-dotnet-with-omnisharp-theia-plug-in
+
+include::ref_omnisharp-theia-plug-in.adoc[leveloffset=+1]
+
+include::proc_verifying-the-state-of-the-omnisharp-theia-plug-in-language-server.adoc[leveloffset=+1]
+
+include::proc_checking-omnisharp-theia-plug-in-language-server-features.adoc[leveloffset=+1]
+
+include::proc_viewing-omnisharp-theia-plug-in-logs-in-the-output-panel.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-logs-for-dotnet-with-omnisharp-theia-plug-in}

src/main/pages/che-7/administration-guide/assembly_viewing-logs-for-go.adoc

@@ -0,0 +1,16 @@
+:parent-context-of-viewing-logs-for-go: {context}
+
+[id='viewing-logs-for-go_{context}']
+= Viewing logs for Go
+
+This section describes how to view logs for the Go language server.
+
+:context: viewing-logs-for-go
+
+include::proc_finding-the-gopath.adoc[leveloffset=+1]
+
+include::proc_viewing-debug-console-log-for-go.adoc[leveloffset=+1]
+
+include::proc_viewing-go-logs-output-in-the-output-panel.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-logs-for-go}

src/main/pages/che-7/administration-guide/assembly_viewing-logs-for-intelephense.adoc

@@ -0,0 +1,12 @@
+:parent-context-of-viewing-logs-for-intelephense: {context}
+
+[id='viewing-logs-for-intelephense_{context}']
+= Viewing logs for Intelephense
+
+:context: viewing-logs-for-intelephense
+
+include::proc_logging-the-intelephense-client-server-communication.adoc[leveloffset=+1]
+
+include::proc_viewing-intelephense-events-in-the-output-panel.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-logs-for-intelephense}

src/main/pages/che-7/administration-guide/assembly_viewing-logs-for-java.adoc

@@ -0,0 +1,18 @@
+:parent-context-of-viewing-logs-for-java: {context}
+
+[id='viewing-logs-for-java_{context}']
+= Viewing logs for Java
+
+:context: viewing-logs-for-java
+
+Other than the general diagnostics, there are link:https://github.com/redhat-developer/vscode-java[Language Support for Java (Eclipse JDT Language Server)] plug-in actions that the user can perform.
+
+include::proc_verifying-the-state-of-the-eclipse-jdt-language-server.adoc[leveloffset=+1]
+
+include::proc_verifying-the-eclipse-jdt-language-server-features.adoc[leveloffset=+1]
+
+include::proc_viewing-java-language-server-log.adoc[leveloffset=+1]
+
+include::proc_logging-the-java-language-server-protocol-lsp-messages.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-logs-for-java}

src/main/pages/che-7/administration-guide/assembly_viewing-logs-for-typescript.adoc

@@ -0,0 +1,14 @@
+:parent-context-of-viewing-logs-for-typescript: {context}
+
+[id='viewing-logs-for-typescript_{context}']
+= Viewing logs for Typescript
+
+:context: viewing-logs-for-typescript
+
+include::proc_enabling-the-label-switched-protocol-lsp-tracing.adoc[leveloffset=+1]
+
+include::proc_viewing-typescript-language-server-log.adoc[leveloffset=+1]
+
+include::proc_viewing-typescript-logs-output-in-the-output-panel.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-logs-for-typescript}

src/main/pages/che-7/administration-guide/assembly_viewing-logs-for-xml.adoc

@@ -0,0 +1,18 @@
+:parent-context-of-viewing-logs-for-xml: {context}
+
+[id='viewing-logs-for-xml_{context}']
+= Viewing logs for XML
+
+:context: viewing-logs-for-xml
+
+Other than the general diagnostics, there are XML plug-in specific actions that the user can perform.
+
+include::proc_verifying-the-state-of-the-xml-language-server.adoc[leveloffset=+1]
+
+include::proc_checking-xml-language-server-feature-flags.adoc[leveloffset=+1]
+
+include::proc_enabling-xml-language-server-protocol-lsp-tracing.adoc[leveloffset=+1]
+
+include::proc_viewing-xml-language-server-log.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-logs-for-xml}

src/main/pages/che-7/administration-guide/assembly_viewing-logs-for-yaml.adoc

@@ -0,0 +1,16 @@
+:parent-context-of-viewing-logs-for-yaml: {context}
+
+[id='viewing-logs-for-yaml_{context}']
+= Viewing logs for YAML
+
+:context: viewing-logs-for-yaml
+
+This section describes the YAML plug-in specific actions that the user can perform, in addition to the general diagnostics ones.
+
+include::proc_verifying-the-state-of-the-yaml-language-server.adoc[leveloffset=+1]
+
+include::proc_checking-yaml-language-server-feature-flags.adoc[leveloffset=+1]
+
+include::proc_enabling-yaml-language-server-protocol-lsp-tracing.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-logs-for-yaml}

src/main/pages/che-7/administration-guide/assembly_viewing-logs-from-language-servers-and-debug-adapters.adoc

@@ -0,0 +1,38 @@
+:parent-context-of-viewing-logs-from-language-servers-and-debug-adapters: {context}
+
+[id='viewing-logs-from-language-servers-and-debug-adapters_{context}']
+= Viewing logs from language servers and debug adapters
+
+:context: viewing-logs-from-language-servers-and-debug-adapters
+
+include::proc_checking-important-logs.adoc[leveloffset=+1]
+
+include::proc_detecting-memory-problems.adoc[leveloffset=+1]
+
+include::proc_logging-the-client-server-traffic-for-debug-adapters.adoc[leveloffset=+1]
+
+include::proc_viewing-logs-for-python.adoc[leveloffset=+1]
+
+include::assembly_viewing-logs-for-go.adoc[leveloffset=+1]
+
+include::proc_viewing-logs-for-the-nodedebug-nodedebug2-adapter.adoc[leveloffset=+1]
+
+include::assembly_viewing-logs-for-typescript.adoc[leveloffset=+1]
+
+include::assembly_viewing-logs-for-java.adoc[leveloffset=+1]
+
+include::assembly_viewing-logs-for-intelephense.adoc[leveloffset=+1]
+
+include::proc_viewing-logs-for-php-debug.adoc[leveloffset=+1]
+
+include::assembly_viewing-logs-for-xml.adoc[leveloffset=+1]
+
+include::assembly_viewing-logs-for-yaml.adoc[leveloffset=+1]
+
+include::assembly_viewing-logs-for-dotnet-with-omnisharp-theia-plug-in.adoc[leveloffset=+1]
+
+include::assembly_viewing-logs-for-dotnet-with-netcoredebugoutput-plug-in.adoc[leveloffset=+1]
+
+include::assembly_viewing-logs-for-camel.adoc[leveloffset=+1]
+
+:context: {parent-context-of-viewing-logs-from-language-servers-and-debug-adapters}

src/main/pages/che-7/administration-guide/proc_checking-important-logs.adoc

@@ -0,0 +1,27 @@
+[id="checking-important-logs_{context}"]
+= Checking important logs
+
+This section describes how to check important logs.
+
+.Procedure
+
+. In the OpenShift web console, click *Applications* -> *Pods* to see a list of all the active workspaces.
+
+. Click on the name of the running pod where the workspace is running. The pod screen contains the list of all containers with additional information.
+
+. Choose a container and click on the container name.
++
+[TIP]
+====
+The most important logs are the `theia-ide` container and the plug-ins container logs. 
+====
+
+. On the container screen, navigate to the *Logs* section.
++
+[TIP]
+.Example
+====
+The following is an output log of the sidecar container running the Java plug-in.
+
+image::logs/checking-important-logs.png[]
+====

src/main/pages/che-7/administration-guide/proc_checking-omnisharp-theia-plug-in-language-server-features.adoc

@@ -0,0 +1,6 @@
+[id="checking-omnisharp-theia-plug-in-language-server-features_{context}"]
+= Checking Omnisharp Theia plug-in language server features
+
+.Procedure
+
+* If the OmniSharp.exe process is running, check if the language server features are working by opening a `.cs` file and trying the hover or completion features, or opening the *Problems* or *Outline* view.