Skip to content

in_kubernetes_events: add documentation #1171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 26, 2023
Merged

in_kubernetes_events: add documentation #1171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@
* [Health](pipeline/inputs/health.md)
* [Kafka](pipeline/inputs/kafka.md)
* [Kernel Logs](pipeline/inputs/kernel-logs.md)
* [Kubernetes Events](pipeline/inputs/kubernetes-events.md)
* [Memory Metrics](pipeline/inputs/memory-metrics.md)
* [MQTT](pipeline/inputs/mqtt.md)
* [Network I/O Log Based Metrics](pipeline/inputs/network-io-metrics.md)
Expand Down
52 changes: 52 additions & 0 deletions pipeline/inputs/kubernetes-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
description: >-
Collects Kubernetes Events
---

# Kubernetes Events

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.

## Configuration


| Key | Description | Default |
|---------------------|---------------------------------------------------------------------------------------|------------------------------------------------------|
| db | Set a database file to keep track of recorded Kubernetes events | |
| db.sync | Set a database sync method. values: extra, full, normal and off | normal |
| interval_sec | Set the polling interval for each channel. | 0 |
| interval_nsec | Set the polling interval for each channel (sub seconds: nanoseconds) | 500000000 |
| kube_url | API Server end-point | https://kubernetes.default.svc |
| kube_ca_file | Kubernetes TLS CA file | /var/run/secrets/kubernetes.io/serviceaccount/ca.crt |
| kube_ca_path | Kubernetes TLS ca path | |
| kube_token_file | Kubernetes authorization token file. | /var/run/secrets/kubernetes.io/serviceaccount/token |
| kube_token_ttl | kubernetes token ttl, until it is reread from the token file. | 10m |
| kube_request_limit | kubernetes limit parameter for events query, no limit applied when set to 0. | 0 |
| kube_retention_time | Kubernetes retention time for events. | 1h |
| kube_namespace | Kubernetes namespace to query events from. Gets events from all namespaces by default | |
| tls.debug | Debug level between 0 (nothing) and 4 (every detail). | 0 |
| tls.verify | Enable or disable verification of TLS peer certificate. | On |
| tls.vhost | Set optional TLS virtual host. | |

## Getting Started

### Simple Configuration File

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.

```text
[SERVICE]
flush 1
log_level info

[INPUT]
name kubernetes_events
tag k8s_events
kube_url https://kubernetes.default.svc

[OUTPUT]
name stdout
match *


```