Skip to content

Commit

Permalink
Correct doc for Kubernetes Events input (#1214)
Browse files Browse the repository at this point in the history 
Signed-off-by: Jack Henschel <[email protected]>
  • Loading branch information
@jacksgt
jacksgt authored Oct 9, 2023
1 parent cff63cb commit c638eca
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions pipeline/inputs/kubernetes-events.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,22 @@ Kubernetes exports it events through the API server. This input plugin allows to
| 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_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_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. | |
| 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.
In the following configuration file, the input plugin *kubernetes_events* collects events every 5 seconds (default for *interval_nsec*) and exposes them through the [standard output plugin](../outputs/standard-output.md) on the console.

```text
[SERVICE]
Expand All @@ -47,6 +47,4 @@ kube_url https://kubernetes.default.svc
[OUTPUT]
name stdout
match *
```
```

0 comments on commit c638eca

Please sign in to comment.