mirror of https://github.com/k3s-io/k3s
204 lines
12 KiB
Markdown
204 lines
12 KiB
Markdown
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
|
|
|
|
<!-- BEGIN STRIP_FOR_RELEASE -->
|
|
|
|
<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.
|
|
|
|
<!-- TAG RELEASE_LINK, added by the munger automatically -->
|
|
<strong>
|
|
The latest release of this document can be found
|
|
[here](http://releases.k8s.io/release-1.3/docs/design/event_compression.md).
|
|
|
|
Documentation for other releases can be found at
|
|
[releases.k8s.io](http://releases.k8s.io).
|
|
</strong>
|
|
--
|
|
|
|
<!-- END STRIP_FOR_RELEASE -->
|
|
|
|
<!-- END MUNGE: UNVERSIONED_WARNING -->
|
|
|
|
# Kubernetes Event Compression
|
|
|
|
This document captures the design of event compression.
|
|
|
|
## Background
|
|
|
|
Kubernetes components can get into a state where they generate tons of events.
|
|
|
|
The events can be categorized in one of two ways:
|
|
|
|
1. same - The event is identical to previous events except it varies only on
|
|
timestamp.
|
|
2. similar - The event is identical to previous events except it varies on
|
|
timestamp and message.
|
|
|
|
For example, when pulling a non-existing image, Kubelet will repeatedly generate
|
|
`image_not_existing` and `container_is_waiting` events until upstream components
|
|
correct the image. When this happens, the spam from the repeated events makes
|
|
the entire event mechanism useless. It also appears to cause memory pressure in
|
|
etcd (see [#3853](http://issue.k8s.io/3853)).
|
|
|
|
The goal is introduce event counting to increment same events, and event
|
|
aggregation to collapse similar events.
|
|
|
|
## Proposal
|
|
|
|
Each binary that generates events (for example, `kubelet`) should keep track of
|
|
previously generated events so that it can collapse recurring events into a
|
|
single event instead of creating a new instance for each new event. In addition,
|
|
if many similar events are created, events should be aggregated into a single
|
|
event to reduce spam.
|
|
|
|
Event compression should be best effort (not guaranteed). Meaning, in the worst
|
|
case, `n` identical (minus timestamp) events may still result in `n` event
|
|
entries.
|
|
|
|
## Design
|
|
|
|
Instead of a single Timestamp, each event object
|
|
[contains](http://releases.k8s.io/HEAD/pkg/api/types.go#L1111) the following
|
|
fields:
|
|
* `FirstTimestamp unversioned.Time`
|
|
* The date/time of the first occurrence of the event.
|
|
* `LastTimestamp unversioned.Time`
|
|
* The date/time of the most recent occurrence of the event.
|
|
* On first occurrence, this is equal to the FirstTimestamp.
|
|
* `Count int`
|
|
* The number of occurrences of this event between FirstTimestamp and
|
|
LastTimestamp.
|
|
* On first occurrence, this is 1.
|
|
|
|
Each binary that generates events:
|
|
* Maintains a historical record of previously generated events:
|
|
* Implemented with
|
|
["Least Recently Used Cache"](https://github.com/golang/groupcache/blob/master/lru/lru.go)
|
|
in [`pkg/client/record/events_cache.go`](../../pkg/client/record/events_cache.go).
|
|
* Implemented behind an `EventCorrelator` that manages two subcomponents:
|
|
`EventAggregator` and `EventLogger`.
|
|
* The `EventCorrelator` observes all incoming events and lets each
|
|
subcomponent visit and modify the event in turn.
|
|
* The `EventAggregator` runs an aggregation function over each event. This
|
|
function buckets each event based on an `aggregateKey` and identifies the event
|
|
uniquely with a `localKey` in that bucket.
|
|
* The default aggregation function groups similar events that differ only by
|
|
`event.Message`. Its `localKey` is `event.Message` and its aggregate key is
|
|
produced by joining:
|
|
* `event.Source.Component`
|
|
* `event.Source.Host`
|
|
* `event.InvolvedObject.Kind`
|
|
* `event.InvolvedObject.Namespace`
|
|
* `event.InvolvedObject.Name`
|
|
* `event.InvolvedObject.UID`
|
|
* `event.InvolvedObject.APIVersion`
|
|
* `event.Reason`
|
|
* If the `EventAggregator` observes a similar event produced 10 times in a 10
|
|
minute window, it drops the event that was provided as input and creates a new
|
|
event that differs only on the message. The message denotes that this event is
|
|
used to group similar events that matched on reason. This aggregated `Event` is
|
|
then used in the event processing sequence.
|
|
* The `EventLogger` observes the event out of `EventAggregation` and tracks
|
|
the number of times it has observed that event previously by incrementing a key
|
|
in a cache associated with that matching event.
|
|
* The key in the cache is generated from the event object minus
|
|
timestamps/count/transient fields, specifically the following events fields are
|
|
used to construct a unique key for an event:
|
|
* `event.Source.Component`
|
|
* `event.Source.Host`
|
|
* `event.InvolvedObject.Kind`
|
|
* `event.InvolvedObject.Namespace`
|
|
* `event.InvolvedObject.Name`
|
|
* `event.InvolvedObject.UID`
|
|
* `event.InvolvedObject.APIVersion`
|
|
* `event.Reason`
|
|
* `event.Message`
|
|
* The LRU cache is capped at 4096 events for both `EventAggregator` and
|
|
`EventLogger`. That means if a component (e.g. kubelet) runs for a long period
|
|
of time and generates tons of unique events, the previously generated events
|
|
cache will not grow unchecked in memory. Instead, after 4096 unique events are
|
|
generated, the oldest events are evicted from the cache.
|
|
* When an event is generated, the previously generated events cache is checked
|
|
(see [`pkg/client/unversioned/record/event.go`](http://releases.k8s.io/HEAD/pkg/client/record/event.go)).
|
|
* If the key for the new event matches the key for a previously generated
|
|
event (meaning all of the above fields match between the new event and some
|
|
previously generated event), then the event is considered to be a duplicate and
|
|
the existing event entry is updated in etcd:
|
|
* The new PUT (update) event API is called to update the existing event
|
|
entry in etcd with the new last seen timestamp and count.
|
|
* The event is also updated in the previously generated events cache with
|
|
an incremented count, updated last seen timestamp, name, and new resource
|
|
version (all required to issue a future event update).
|
|
* If the key for the new event does not match the key for any previously
|
|
generated event (meaning none of the above fields match between the new event
|
|
and any previously generated events), then the event is considered to be
|
|
new/unique and a new event entry is created in etcd:
|
|
* The usual POST/create event API is called to create a new event entry in
|
|
etcd.
|
|
* An entry for the event is also added to the previously generated events
|
|
cache.
|
|
|
|
## Issues/Risks
|
|
|
|
* Compression is not guaranteed, because each component keeps track of event
|
|
history in memory
|
|
* An application restart causes event history to be cleared, meaning event
|
|
history is not preserved across application restarts and compression will not
|
|
occur across component restarts.
|
|
* Because an LRU cache is used to keep track of previously generated events,
|
|
if too many unique events are generated, old events will be evicted from the
|
|
cache, so events will only be compressed until they age out of the events cache,
|
|
at which point any new instance of the event will cause a new entry to be
|
|
created in etcd.
|
|
|
|
## Example
|
|
|
|
Sample kubectl output:
|
|
|
|
```console
|
|
FIRSTSEEN LASTSEEN COUNT NAME KIND SUBOBJECT REASON SOURCE MESSAGE
|
|
Thu, 12 Feb 2015 01:13:02 +0000 Thu, 12 Feb 2015 01:13:02 +0000 1 kubernetes-node-4.c.saad-dev-vms.internal Minion starting {kubelet kubernetes-node-4.c.saad-dev-vms.internal} Starting kubelet.
|
|
Thu, 12 Feb 2015 01:13:09 +0000 Thu, 12 Feb 2015 01:13:09 +0000 1 kubernetes-node-1.c.saad-dev-vms.internal Minion starting {kubelet kubernetes-node-1.c.saad-dev-vms.internal} Starting kubelet.
|
|
Thu, 12 Feb 2015 01:13:09 +0000 Thu, 12 Feb 2015 01:13:09 +0000 1 kubernetes-node-3.c.saad-dev-vms.internal Minion starting {kubelet kubernetes-node-3.c.saad-dev-vms.internal} Starting kubelet.
|
|
Thu, 12 Feb 2015 01:13:09 +0000 Thu, 12 Feb 2015 01:13:09 +0000 1 kubernetes-node-2.c.saad-dev-vms.internal Minion starting {kubelet kubernetes-node-2.c.saad-dev-vms.internal} Starting kubelet.
|
|
Thu, 12 Feb 2015 01:13:05 +0000 Thu, 12 Feb 2015 01:13:12 +0000 4 monitoring-influx-grafana-controller-0133o Pod failedScheduling {scheduler } Error scheduling: no nodes available to schedule pods
|
|
Thu, 12 Feb 2015 01:13:05 +0000 Thu, 12 Feb 2015 01:13:12 +0000 4 elasticsearch-logging-controller-fplln Pod failedScheduling {scheduler } Error scheduling: no nodes available to schedule pods
|
|
Thu, 12 Feb 2015 01:13:05 +0000 Thu, 12 Feb 2015 01:13:12 +0000 4 kibana-logging-controller-gziey Pod failedScheduling {scheduler } Error scheduling: no nodes available to schedule pods
|
|
Thu, 12 Feb 2015 01:13:05 +0000 Thu, 12 Feb 2015 01:13:12 +0000 4 skydns-ls6k1 Pod failedScheduling {scheduler } Error scheduling: no nodes available to schedule pods
|
|
Thu, 12 Feb 2015 01:13:05 +0000 Thu, 12 Feb 2015 01:13:12 +0000 4 monitoring-heapster-controller-oh43e Pod failedScheduling {scheduler } Error scheduling: no nodes available to schedule pods
|
|
Thu, 12 Feb 2015 01:13:20 +0000 Thu, 12 Feb 2015 01:13:20 +0000 1 kibana-logging-controller-gziey BoundPod implicitly required container POD pulled {kubelet kubernetes-node-4.c.saad-dev-vms.internal} Successfully pulled image "kubernetes/pause:latest"
|
|
Thu, 12 Feb 2015 01:13:20 +0000 Thu, 12 Feb 2015 01:13:20 +0000 1 kibana-logging-controller-gziey Pod scheduled {scheduler } Successfully assigned kibana-logging-controller-gziey to kubernetes-node-4.c.saad-dev-vms.internal
|
|
```
|
|
|
|
This demonstrates what would have been 20 separate entries (indicating
|
|
scheduling failure) collapsed/compressed down to 5 entries.
|
|
|
|
## Related Pull Requests/Issues
|
|
|
|
* Issue [#4073](http://issue.k8s.io/4073): Compress duplicate events.
|
|
* PR [#4157](http://issue.k8s.io/4157): Add "Update Event" to Kubernetes API.
|
|
* PR [#4206](http://issue.k8s.io/4206): Modify Event struct to allow
|
|
compressing multiple recurring events in to a single event.
|
|
* PR [#4306](http://issue.k8s.io/4306): Compress recurring events in to a
|
|
single event to optimize etcd storage.
|
|
* PR [#4444](http://pr.k8s.io/4444): Switch events history to use LRU cache
|
|
instead of map.
|
|
|
|
|
|
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
|
[]()
|
|
<!-- END MUNGE: GENERATED_ANALYTICS -->
|