Lab: Diagnostic Trace

1. List the pods for the example application deployment; for example:

   oc get pods
   

   Example output:

   NAME                          READY   STATUS    RESTARTS   AGE
   libertydiag-b98748954-mgj64   1/1     Running   0          97s
   

2. Open a shell into the pod by replacing $POD with a pod name from the previous command:

   oc rsh -t $POD
   

   For example:

   oc rsh -t libertydiag-b98748954-mgj64
   

3. Copy and paste the following command and press Enter. Liberty will dynamically update the diagnostic trace configuration in the server.

echo '<?xml version="1.0" encoding="UTF-8"?><server><logging traceSpecification="*=info:com.ibm.ws.webcontainer*=all:com.ibm.wsspi.webcontainer*=all:HTTPChannel=all:GenericBNF=all:HTTPDispatcher=all" maxFileSize="100" maxFiles="10" /></server>' > /config/configDropins/overrides/trace.xml

1. In the Topology view of the Developer perspective, click on the libertydiag circle, then click the Resources tab in the drawer on the right, and then click on the one pod that's running:
   
2. Click on the Terminal tab to open a remote shell into the running container in the pod:
   
3. Copy and paste the following command and press Enter. Liberty will dynamically update the diagnostic trace configuration in the server.

echo '<?xml version="1.0" encoding="UTF-8"?><server><logging traceSpecification="*=info:com.ibm.ws.webcontainer*=all:com.ibm.wsspi.webcontainer*=all:HTTPChannel=all:GenericBNF=all:HTTPDispatcher=all" maxFileSize="100" maxFiles="10" /></server>' > /config/configDropins/overrides/trace.xml

1. Request the following web page from your terminal to simulate an HTTP request:

   1. macOS, Linux, or Windows with Cygwin:

      curl -k -s "https://$(oc get route libertydiag "--output=jsonpath={.spec.host}")/servlet/Sleep"
      

   2. Windows with Command Prompt:

      1. Ensure you have curl for Windows installed

      2. List the application's URL:

         oc get route libertydiag "--output=jsonpath={.spec.host}{'\n'}"
         

      3. Execute the following command, replacing $HOST with the output of the previous command:

         curl -k -s "https://$HOST/servlet/Sleep"
         

1. Click on the /servlet/Sleep link from the libertydiag application homepage:
   

1. List the pods for the example application deployment; for example:

   oc get pods
   

   Example output:

   NAME                          READY   STATUS    RESTARTS   AGE
   libertydiag-b98748954-mgj64   1/1     Running   0          97s
   

2. Open a shell into the pod by replacing $POD with a pod name from the previous command:

   oc rsh -t $POD
   

   For example:

   oc rsh -t libertydiag-b98748954-mgj64
   

3. Copy and paste the following command and press Enter. Liberty will dynamically update the diagnostic trace configuration in the server back to its original value.

   rm /config/configDropins/overrides/trace.xml
   

1. In the Topology view of the Developer perspective, click on the libertydiag circle, then click the Resources tab in the drawer on the right, and then click on the one pod that's running:
   
2. Click on the Terminal tab to open a remote shell into the running container in the pod:
   
3. Copy and paste the following command and press Enter. Liberty will dynamically update the diagnostic trace configuration in the server back to its original value.

   rm /config/configDropins/overrides/trace.xml
   

1. List the pods for the example application deployment; for example:

   oc get pods
   

   Example output:

   NAME                          READY   STATUS    RESTARTS   AGE
   libertydiag-ddf5f95b6-wj6dm   1/1     Running   0          97s
   

2. Download the logs by replacing $POD with a pod name from above. Note that oc cp does not support wildcards so the whole directory (or a single file) must be downloaded.

   oc cp $POD:/logs .
   

   For example:

   oc cp libertydiag-ddf5f95b6-wj6dm:/logs .
   

3. You should be able to find the Sleep request executed above; for example:

   [1/3/23 16:48:19:462 UTC] 0000006d id=00000000 com.ibm.ws.webcontainer.servlet.ServletWrapper               > handleRequest ServletWrapper[com.example.servlet.Sleep:[/servlet/Sleep]] ,request-> com.ibm.ws.webcontainer40.srt.SRTServletRequest40@20a8494e ,response-> com.ibm.ws.webcontainer40.srt.SRTServletResponse40@86c16c72 ENTRY
   
   [1/3/23 16:48:19:473 UTC] 0000006d id=00000000 com.example.util.BaseServlet                                 I libertydiag: Invoking com.example.servlet.Sleep by anonymous (10.254.20.1)... []
   
   [1/3/23 16:48:20:482 UTC] 0000006d id=00000000 com.example.util.BaseServlet                                 I libertydiag: Done com.example.servlet.Sleep
   
   [1/3/23 16:48:20:495 UTC] 0000006d id=7d221183 com.ibm.ws.webcontainer.osgi.DynamicVirtualHost              3 Webcontainer handleRequest complete for--> [/servlet/Sleep], mapped webApp context [com.ibm.ws.webcontainer40.osgi.webapp.WebApp40@35a6e71f[libertydiag#libertydiag.war]], inboundConnection --> [com.ibm.ws.http.dispatcher.internal.channel.HttpDispatcherLink@22dbf0bd], this --> com.ibm.ws.webcontainer.osgi.DynamicVirtualHost$2@7d221183
   

Files other than native logs (equivalent to Liberty's console.log) cannot be downloaded through the browser. You must use the command line steps above. Alternatively, you may use the Terminal tab of the pod and cat the file in the browser.

1. List the pods for the example application deployment; for example:

   oc get pods
   

   Example output:

   NAME                          READY   STATUS    RESTARTS   AGE
   libertydiag-b98748954-mgj64   1/1     Running   0          97s
   

2. Create a trace.yaml file, replacing $POD with the name of the pod from the previous command (e.g. libertydiag-b98748954-mgj64):

   apiVersion: liberty.websphere.ibm.com/v1
   kind: WebSphereLibertyTrace
   metadata:
     name: libertytrace1
     annotations:
       day2operation.openliberty.io/targetKinds: Pod
   spec:
     license:
       accept: true
     podName: $POD
     traceSpecification: "*=info:com.ibm.ws.webcontainer*=all:com.ibm.wsspi.webcontainer*=all:HTTPChannel=all:GenericBNF=all:HTTPDispatcher=all"
     maxFileSize: 100
     maxFiles: 5
     disable: false
   

3. Apply the YAML:

   oc apply -f trace.yaml
   

1. Ensure the perspective is set to Developer in the top left:
   
2. Set your current namespace/project to what you were provided. For example:
   
3. In the Topology view of the Developer perspective, click on the libertydiag circle, then click the Resources tab in the drawer on the right, and then copy the name of the pod that's running:
   
4. Click Operator Backed on the +Add page:
   
5. Click WebSphereLibertyTrace and then click Create
6. Expand License and check accept
7. Paste the pod name from the step above into the podName text box.

8. Set the traceSpecification to:

   *=info:com.ibm.ws.webcontainer*=all:com.ibm.wsspi.webcontainer*=all:HTTPChannel=all:GenericBNF=all:HTTPDispatcher=all
   

9. Set maxFileSize to 100

10. Click Create

1. Request the following web page from your terminal to simulate an HTTP request:

   1. macOS, Linux, or Windows with Cygwin:

      curl -k -s "https://$(oc get route libertydiag "--output=jsonpath={.spec.host}")/servlet/Sleep"
      

   2. Windows with Command Prompt:

      1. Ensure you have curl for Windows installed

      2. List the application's URL:

         oc get route libertydiag "--output=jsonpath={.spec.host}{'\n'}"
         

      3. Execute the following command, replacing $HOST with the output of the previous command:

         curl -k -s "https://$HOST/servlet/Sleep"
         

1. Click on the /servlet/Sleep link from the libertydiag application homepage:
   

1. List WebSphereLibertyTrace custom resources; for example:

   oc get wltrace
   

   Example output:

   NAME            PODNAME                      TRACING
   libertytrace1   libertydiag-5fdf699f-sfwqn   True
   

2. Delete the custom resource you created earlier; for example:

   oc delete wltrace libertytrace1
   

1. Click on Search, click the Resources drop down, search for trace, check WebSphereLibertyTrace, click the vertical ellipses next to the custom resource created earlier, click Delete WebSphereLibertyTrace, and click Delete:
   

1. List the pods for the example application deployment; for example:

   oc get pods
   

   Example output:

   NAME                          READY   STATUS    RESTARTS   AGE
   libertydiag-ddf5f95b6-wj6dm   1/1     Running   0          97s
   

2. Download the logs by replacing $POD with a pod name from above and $NAMESPACE with your namespace. Note that oc cp does not support wildcards so the whole directory (or a single file) must be downloaded.

   oc cp $POD:/serviceability/$NAMESPACE/$POD/ .
   

   For example:

   oc cp libertydiag-ddf5f95b6-wj6dm:/serviceability/user15-namespace/libertydiag-ddf5f95b6-wj6dm/ .
   

3. You should be able to find the Sleep request executed above; for example:

   [1/3/23 16:48:19:462 UTC] 0000006d id=00000000 com.ibm.ws.webcontainer.servlet.ServletWrapper               > handleRequest ServletWrapper[com.example.servlet.Sleep:[/servlet/Sleep]] ,request-> com.ibm.ws.webcontainer40.srt.SRTServletRequest40@20a8494e ,response-> com.ibm.ws.webcontainer40.srt.SRTServletResponse40@86c16c72 ENTRY
   
   [1/3/23 16:48:19:473 UTC] 0000006d id=00000000 com.example.util.BaseServlet                                 I libertydiag: Invoking com.example.servlet.Sleep by anonymous (10.254.20.1)... []
   
   [1/3/23 16:48:20:482 UTC] 0000006d id=00000000 com.example.util.BaseServlet                                 I libertydiag: Done com.example.servlet.Sleep
   
   [1/3/23 16:48:20:495 UTC] 0000006d id=7d221183 com.ibm.ws.webcontainer.osgi.DynamicVirtualHost              3 Webcontainer handleRequest complete for--> [/servlet/Sleep], mapped webApp context [com.ibm.ws.webcontainer40.osgi.webapp.WebApp40@35a6e71f[libertydiag#libertydiag.war]], inboundConnection --> [com.ibm.ws.http.dispatcher.internal.channel.HttpDispatcherLink@22dbf0bd], this --> com.ibm.ws.webcontainer.osgi.DynamicVirtualHost$2@7d221183
   

Files other than native logs (equivalent to Liberty's console.log) cannot be downloaded through the browser. You must use the command line steps above. Alternatively, you may use the Terminal tab of the pod and cat the file in the browser.