k3s/docs/user-guide/logging.md

144 lines
5.5 KiB
Markdown
Raw Normal View History

2015-07-12 04:04:52 +00:00
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
2015-07-16 17:02:26 +00:00
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
If you are using a released version of Kubernetes, you should
refer to the docs that go with that version.
2015-12-14 18:37:38 +00:00
<!-- TAG RELEASE_LINK, added by the munger automatically -->
2015-07-16 17:02:26 +00:00
<strong>
2015-11-03 18:17:57 +00:00
The latest release of this document can be found
[here](http://releases.k8s.io/release-1.1/docs/user-guide/logging.md).
2015-07-16 17:02:26 +00:00
Documentation for other releases can be found at
[releases.k8s.io](http://releases.k8s.io).
</strong>
--
2015-07-13 22:15:35 +00:00
2015-07-12 04:04:52 +00:00
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
2015-07-17 22:35:41 +00:00
# Logging
**Table of Contents**
<!-- BEGIN MUNGE: GENERATED_TOC -->
- [Logging](#logging)
- [Logging by Kubernetes Components](#logging-by-kubernetes-components)
- [Examining the logs of running containers](#examining-the-logs-of-running-containers)
- [Cluster level logging to Google Cloud Logging](#cluster-level-logging-to-google-cloud-logging)
- [Cluster level logging with Elasticsearch and Kibana](#cluster-level-logging-with-elasticsearch-and-kibana)
- [Ingesting Application Log Files](#ingesting-application-log-files)
- [Known issues](#known-issues)
<!-- END MUNGE: GENERATED_TOC -->
## Logging by Kubernetes Components
2015-07-17 22:35:41 +00:00
2015-07-14 16:37:37 +00:00
Kubernetes components, such as kubelet and apiserver, use the [glog](https://godoc.org/github.com/golang/glog) logging library. Developer conventions for logging severity are described in [docs/devel/logging.md](../devel/logging.md).
2015-06-23 21:23:52 +00:00
## Examining the logs of running containers
2015-07-17 22:35:41 +00:00
2015-06-23 21:23:52 +00:00
The logs of a running container may be fetched using the command `kubectl logs`. For example, given
this pod specification [counter-pod.yaml](../../examples/blog-logging/counter-pod.yaml), which has a container which writes out some text to standard
output every second. (You can find different pod specifications [here](logging-demo/).)
2015-07-17 02:01:02 +00:00
<!-- BEGIN MUNGE: EXAMPLE ../../examples/blog-logging/counter-pod.yaml -->
2015-07-18 23:48:49 +00:00
```yaml
apiVersion: v1
kind: Pod
metadata:
name: counter
spec:
containers:
- name: count
image: ubuntu:14.04
args: [bash, -c,
'for ((i = 0; ; i++)); do echo "$i: $(date)"; sleep 1; done']
2015-06-23 21:23:52 +00:00
```
2015-07-17 02:01:02 +00:00
2015-09-08 00:43:09 +00:00
[Download example](../../examples/blog-logging/counter-pod.yaml?raw=true)
<!-- END MUNGE: EXAMPLE ../../examples/blog-logging/counter-pod.yaml -->
2015-06-23 21:23:52 +00:00
we can run the pod:
2015-07-17 02:01:02 +00:00
2015-07-18 23:48:49 +00:00
```console
$ kubectl create -f ./counter-pod.yaml
pods/counter
2015-06-23 21:23:52 +00:00
```
2015-07-17 02:01:02 +00:00
2015-06-23 21:23:52 +00:00
and then fetch the logs:
2015-07-17 02:01:02 +00:00
2015-07-18 23:48:49 +00:00
```console
2015-06-23 21:23:52 +00:00
$ kubectl logs counter
0: Tue Jun 2 21:37:31 UTC 2015
1: Tue Jun 2 21:37:32 UTC 2015
2: Tue Jun 2 21:37:33 UTC 2015
3: Tue Jun 2 21:37:34 UTC 2015
4: Tue Jun 2 21:37:35 UTC 2015
5: Tue Jun 2 21:37:36 UTC 2015
...
```
2015-07-17 02:01:02 +00:00
2015-06-23 21:23:52 +00:00
If a pod has more than one container then you need to specify which container's log files should
be fetched e.g.
2015-07-17 02:01:02 +00:00
2015-07-18 23:48:49 +00:00
```console
2015-06-23 21:23:52 +00:00
$ kubectl logs kube-dns-v3-7r1l9 etcd
2015/06/23 00:43:10 etcdserver: start to snapshot (applied: 30003, lastsnap: 20002)
2015/06/23 00:43:10 etcdserver: compacted log at index 30003
2015/06/23 00:43:10 etcdserver: saved snapshot at index 30003
2015/06/23 02:05:42 etcdserver: start to snapshot (applied: 40004, lastsnap: 30003)
2015/06/23 02:05:42 etcdserver: compacted log at index 40004
2015/06/23 02:05:42 etcdserver: saved snapshot at index 40004
2015/06/23 03:28:31 etcdserver: start to snapshot (applied: 50005, lastsnap: 40004)
2015/06/23 03:28:31 etcdserver: compacted log at index 50005
2015/06/23 03:28:31 etcdserver: saved snapshot at index 50005
2015/06/23 03:28:56 filePurge: successfully removed file default.etcd/member/wal/0000000000000000-0000000000000000.wal
2015/06/23 04:51:03 etcdserver: start to snapshot (applied: 60006, lastsnap: 50005)
2015/06/23 04:51:03 etcdserver: compacted log at index 60006
2015/06/23 04:51:03 etcdserver: saved snapshot at index 60006
...
```
2015-06-23 21:23:52 +00:00
## Cluster level logging to Google Cloud Logging
2015-07-17 22:35:41 +00:00
2015-07-14 16:37:37 +00:00
The getting started guide [Cluster Level Logging to Google Cloud Logging](../getting-started-guides/logging.md)
2015-06-23 21:23:52 +00:00
explains how container logs are ingested into [Google Cloud Logging](https://cloud.google.com/logging/docs/)
and shows how to query the ingested logs.
2015-06-23 21:23:52 +00:00
## Cluster level logging with Elasticsearch and Kibana
2015-07-17 22:35:41 +00:00
2015-07-14 16:37:37 +00:00
The getting started guide [Cluster Level Logging with Elasticsearch and Kibana](../getting-started-guides/logging-elasticsearch.md)
2015-06-23 21:23:52 +00:00
describes how to ingest cluster level logs into Elasticsearch and view them using Kibana.
2015-06-23 21:23:52 +00:00
## Ingesting Application Log Files
2015-07-17 22:35:41 +00:00
2015-06-23 21:23:52 +00:00
Cluster level logging only collects the standard output and standard error output of the applications
2015-11-03 18:17:57 +00:00
running in containers. The guide [Collecting log files within containers with Fluentd](http://releases.k8s.io/release-1.1/contrib/logging/fluentd-sidecar-gcp/README.md) explains how the log files of applications can also be ingested into Google Cloud logging.
2015-07-15 00:47:34 +00:00
## Known issues
Kubernetes does log rotation for Kubernetes components and docker containers. The command `kubectl logs` currently only read the latest logs, not all historical ones.
2015-07-15 00:47:34 +00:00
2015-07-14 00:13:09 +00:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
2015-07-14 16:37:37 +00:00
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/logging.md?pixel)]()
2015-07-14 00:13:09 +00:00
<!-- END MUNGE: GENERATED_ANALYTICS -->