# Kubernetes event logs

To stream Kubernetes events into your workspace startup logs, you can use Coder's [`coder-logstream-kube`](https://github.com/coder/coder-logstream-kube) tool.
`coder-logstream-kube` provides useful information about the workspace pod or deployment, such as:

* Causes of pod provisioning failures, or why a pod is stuck in a pending state.
* Visibility into when pods are OOMKilled, or when they are evicted.

## Installation

Install the `coder-logstream-kube` helm chart on the cluster where the deployment is running.

```sh
helm repo add coder-logstream-kube https://helm.coder.com/logstream-kube
helm install coder-logstream-kube coder-logstream-kube/coder-logstream-kube \
    --namespace coder \
    --set url=<your-coder-url-including-http-or-https>
```

## Example logs

Here is an example of the logs you can expect to see in the workspace startup logs:

### Normal pod deployment

![normal pod deployment](/docs/@main/images/admin/integrations/coder-logstream-kube-logs-normal.png)

### Wrong image

![Wrong image name](/docs/@main/images/admin/integrations/coder-logstream-kube-logs-wrong-image.png)

### Kubernetes quota exceeded

![Kubernetes quota exceeded](/docs/@main/images/admin/integrations/coder-logstream-kube-logs-quota-exceeded.png)

### Pod crash loop

![Pod crash loop](/docs/@main/images/admin/integrations/coder-logstream-kube-logs-pod-crashed.png)

## How it works

Kubernetes provides an [informers](https://pkg.go.dev/k8s.io/client-go/informers) API that streams pod and event data from the API server.

coder-logstream-kube listens for pod creation events with containers that have the CODER\_AGENT\_TOKEN environment variable set.
All pod events are streamed as logs to the Coder API using the agent token for authentication.
For more details, see the [coder-logstream-kube](https://github.com/coder/coder-logstream-kube) repository.
