Each pod the service runs on has its own logs. These logs contain information which pertains to the instance of the API running within the pod. The sort of information that can be obtained from the Kubernetes logs is as follows:
- Application and server hosting information such as local ports, versions and active profiles.
- Incoming requests (does not contain sensitive information) i.e. request type, request URL and request body.
Since traffic to the pods is load balanced, multiple logs may need to be checked for each pod the service runs on. For this reason we'd recommend using Kibana when numerous pods are running.
Ensure you are able to access Cloud Platform's Kubernetes cluster via the Kubernetes CLI. This can be done by running
kubectl get namespaces. A successful call will return a list of all namespaces within the cluster.
If not Follow Cloud Platform's documentation on how to set this up.
- Get the unique names of the pods that are running.
kubectl get pods -n hmpps-integration-api-<environment>
- Using the name of the pods, you can retrieve the logs via the following command:
kubectl logs -n hmpps-integration-api-<environment> <podname>
If successful, your terminal will display the logs for this pod.
You can optionally follow the logs in your terminal by appending the
-fflag onto the end of the logs command.
A consumer is getting unexpected data from the API, in such a scenario we can obtain the request details from the log and reproduce it ourselves.
It may also be beneficial to visit our Kubernetes Useful Commands page.