Files
container.training/slides/k8s/logs-cli.md
2020-07-09 15:32:21 +02:00

167 lines
3.7 KiB
Markdown

# Accessing logs from the CLI
- The `kubectl logs` command has limitations:
- it cannot stream logs from multiple pods at a time
- when showing logs from multiple pods, it mixes them all together
- We are going to see how to do it better
---
## Doing it manually
- We *could* (if we were so inclined) write a program or script that would:
- take a selector as an argument
- enumerate all pods matching that selector (with `kubectl get -l ...`)
- fork one `kubectl logs --follow ...` command per container
- annotate the logs (the output of each `kubectl logs ...` process) with their origin
- preserve ordering by using `kubectl logs --timestamps ...` and merge the output
--
- We *could* do it, but thankfully, others did it for us already!
---
## Stern
[Stern](https://github.com/wercker/stern) is an open source project
by [Wercker](http://www.wercker.com/).
From the README:
*Stern allows you to tail multiple pods on Kubernetes and multiple containers within the pod. Each result is color coded for quicker debugging.*
*The query is a regular expression so the pod name can easily be filtered and you don't need to specify the exact id (for instance omitting the deployment id). If a pod is deleted it gets removed from tail and if a new pod is added it automatically gets tailed.*
Exactly what we need!
---
## Checking if Stern is installed
- Run `stern` (without arguments) to check if it's installed:
```
$ stern
Tail multiple pods and containers from Kubernetes
Usage:
stern pod-query [flags]
```
- If it's missing, let's see how to install it
---
## Installing Stern
- Stern is written in Go, and Go programs are usually shipped as a single binary
- We just need to download that binary and put it in our `PATH`!
- Binary releases are available [here](https://github.com/wercker/stern/releases) on GitHub
- The following commands will install Stern on a Linux Intel 64 bit machine:
```bash
sudo curl -L -o /usr/local/bin/stern \
https://github.com/wercker/stern/releases/download/1.11.0/stern_linux_amd64
sudo chmod +x /usr/local/bin/stern
```
- On macOS, we can also `brew install stern` or `sudo port install stern`
<!-- ##VERSION## -->
---
## Using Stern
- There are two ways to specify the pods whose logs we want to see:
- `-l` followed by a selector expression (like with many `kubectl` commands)
- with a "pod query," i.e. a regex used to match pod names
- These two ways can be combined if necessary
.exercise[
- View the logs for all the pingpong containers:
```bash
stern pingpong
```
<!--
```wait seq=```
```key ^C```
-->
]
---
## Stern convenient options
- The `--tail N` flag shows the last `N` lines for each container
(Instead of showing the logs since the creation of the container)
- The `-t` / `--timestamps` flag shows timestamps
- The `--all-namespaces` flag is self-explanatory
.exercise[
- View what's up with the `weave` system containers:
```bash
stern --tail 1 --timestamps --all-namespaces weave
```
<!--
```wait weave-npc```
```key ^C```
-->
]
---
## Using Stern with a selector
- When specifying a selector, we can omit the value for a label
- This will match all objects having that label (regardless of the value)
- Everything created with `kubectl run` has a label `run`
- Everything created with `kubectl create deployment` has a label `app`
- We can use that property to view the logs of all the pods created with `kubectl create deployment`
.exercise[
- View the logs for all the things started with `kubectl create deployment`:
```bash
stern -l app
```
<!--
```wait seq=```
```key ^C```
-->
]
???
:EN:- Viewing pod logs from the CLI
:FR:- Consulter les logs des pods depuis la CLI