Skip to content

Commit 214c564

Browse files
authored
in_kubernetes_events: add documentation (#1171)
Signed-off-by: lecaros <[email protected]>
1 parent a6d049c commit 214c564

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@
9595
* [Health](pipeline/inputs/health.md)
9696
* [Kafka](pipeline/inputs/kafka.md)
9797
* [Kernel Logs](pipeline/inputs/kernel-logs.md)
98+
* [Kubernetes Events](pipeline/inputs/kubernetes-events.md)
9899
* [Memory Metrics](pipeline/inputs/memory-metrics.md)
99100
* [MQTT](pipeline/inputs/mqtt.md)
100101
* [Network I/O Log Based Metrics](pipeline/inputs/network-io-metrics.md)
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
description: >-
3+
Collects Kubernetes Events
4+
---
5+
6+
# Kubernetes Events
7+
8+
Kubernetes exports it events through the API server. This input plugin allows to retrieve those events as logs and get them processed through the pipeline.
9+
10+
## Configuration
11+
12+
13+
| Key | Description | Default |
14+
|---------------------|---------------------------------------------------------------------------------------|------------------------------------------------------|
15+
| db | Set a database file to keep track of recorded Kubernetes events | |
16+
| db.sync | Set a database sync method. values: extra, full, normal and off | normal |
17+
| interval_sec | Set the polling interval for each channel. | 0 |
18+
| interval_nsec | Set the polling interval for each channel (sub seconds: nanoseconds) | 500000000 |
19+
| kube_url | API Server end-point | https://kubernetes.default.svc |
20+
| kube_ca_file | Kubernetes TLS CA file | /var/run/secrets/kubernetes.io/serviceaccount/ca.crt |
21+
| kube_ca_path | Kubernetes TLS ca path | |
22+
| kube_token_file | Kubernetes authorization token file. | /var/run/secrets/kubernetes.io/serviceaccount/token |
23+
| kube_token_ttl | kubernetes token ttl, until it is reread from the token file. | 10m |
24+
| kube_request_limit | kubernetes limit parameter for events query, no limit applied when set to 0. | 0 |
25+
| kube_retention_time | Kubernetes retention time for events. | 1h |
26+
| kube_namespace | Kubernetes namespace to query events from. Gets events from all namespaces by default | |
27+
| tls.debug | Debug level between 0 (nothing) and 4 (every detail). | 0 |
28+
| tls.verify | Enable or disable verification of TLS peer certificate. | On |
29+
| tls.vhost | Set optional TLS virtual host. | |
30+
31+
## Getting Started
32+
33+
### Simple Configuration File
34+
35+
In the following configuration file, the input plugin _windows_exporter_metrics collects _metrics every 2 seconds and exposes them through our [Prometheus Exporter](../outputs/prometheus-exporter.md) output plugin on HTTP/TCP port 2021.
36+
37+
```text
38+
[SERVICE]
39+
flush 1
40+
log_level info
41+
42+
[INPUT]
43+
name kubernetes_events
44+
tag k8s_events
45+
kube_url https://kubernetes.default.svc
46+
47+
[OUTPUT]
48+
name stdout
49+
match *
50+
51+
52+
```

0 commit comments

Comments
 (0)