Add additional information for debugging Daprd in Kubernetes #1614
Labels
content/missing-information
More information requested or needed
platform/Kubernetes
Applicable to the Kubernetes hosting environment
What content needs to be created or modified?
There needs to be 1) some cross references between a couple documents and 2) there needs to be added information. Both described below.
This Issue is a response to a request @msfussell made to me on Dapr Discord at https://discord.com/channels/778680217417809931/778680217417809934/860021956392910918
Describe the solution you'd like
Cross references:
This doc, https://docs.dapr.io/operations/troubleshooting/logs-troubleshooting/ ("Configure and view dapr logs") needs to reference this doc https://docs.dapr.io/developing-applications/debugging/debug-k8s/debug-daprd/ ("Debug daprd on Kubernetes") which describes in depth debugging, not just log based debugging.
And, vice versa as well. Namely, "Debug daprd on Kubernetes" needs to reference "Configure and view dapr logs".
Additional material:
Both of the above documents could also provide a link to the Dapr Community Meeting where Yaron described how to use kubectl to debug daprd and apps on Kubernetes. This is an excellent resource. The link to the YouTube community meeting is
https://www.youtube.com/watch?v=pniLPRbuLD8
The material in Yaron's presentation (above) could also be written down and placed in another new document called something like "Using kubectl to debug Daprd and Apps running on Kubernetes". I say this since Yaron's material goes beyond mere logs by examining the details of various Kubernetes objects via kubectl.
However, writing another document is a significant job, but worthwhile nevertheless. A shorter term fix would be to attach a list of commonly used kubectl commands to the existing "Configure and view dapr logs" document. Below is a list of the kubectl commands I typically use. Many of them originally came from Yaron's Community meeting presentation:
Kubectl commands frequently used in debugging daprd and apps running on Kubernetes:
kubectl get all
kubectl get all --n <someNamespace>
kubectl get all --all-namespaces
kubectl get pods
kubectl get events --n <someNamespace>
kubectl get events --sort-by=.metadata.creationTimestamp --n <someNamespace>
kubectl get services
kubectl logs <podId> daprd
kubectl logs <podId> <myAppContainerName>
kuebctl logs <deploymentId> daprd
kubectl logs <deploymentId> <myAppContainerName>
kubectl describe pod <podId>
kubectl describe deploy <deployId>
kubectl describe replicaset <replicasetId>
To Restart a pod: kubectl delete pod <podId> which causes the replicaset controller to restart the pod after the delete.
That's it!
Where should the new material be placed?
See above.
The associated pull request from dapr/dapr, dapr/components-contrib, or other Dapr code repos
Additional context
The text was updated successfully, but these errors were encountered: