66 lines
3.1 KiB
Markdown
66 lines
3.1 KiB
Markdown
<!--
|
|
(NOTE: Do not edit README.md directly. It is a generated file!)
|
|
( To make changes, please modify README.md.gotmpl and run `helm-docs`)
|
|
-->
|
|
|
|
# feature-cluster-events
|
|
|
|
 
|
|
Gathers Kubernetes Events
|
|
|
|
The Cluster Events feature enables the collection of Kubernetes events from the cluster.
|
|
|
|
## How it works
|
|
|
|
Events are captured as logs and are annotated with additional metadata to make them easier to search and filter.
|
|
|
|
## Testing
|
|
|
|
This chart contains unit tests to verify the generated configuration. The hidden value `deployAsConfigMap` will render
|
|
the generated configuration into a ConfigMap object. While this ConfigMap is not used during regular operation, you can
|
|
use it to show the outcome of a given values file.
|
|
|
|
The unit tests use this ConfigMap to create an object with the configuration that can be asserted against. To run the
|
|
tests, use `helm test`.
|
|
|
|
Be sure perform actual integration testing in a live environment in the main [k8s-monitoring](../..) chart.
|
|
|
|
## Maintainers
|
|
|
|
| Name | Email | Url |
|
|
| ---- | ------ | --- |
|
|
| petewall | <pete.wall@grafana.com> | |
|
|
<!-- markdownlint-disable no-bare-urls -->
|
|
<!-- markdownlint-disable list-marker-space -->
|
|
## Source Code
|
|
|
|
* <https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-cluster-events>
|
|
<!-- markdownlint-enable list-marker-space -->
|
|
<!-- markdownlint-enable no-bare-urls -->
|
|
|
|
## Values
|
|
|
|
### Gather settings
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| excludeNamespaces | list | `[]` | List of namespaces to ignore events for. |
|
|
| logFormat | string | `"logfmt"` | Log format used to forward cluster events. Allowed values: `logfmt` (default), `json`. |
|
|
| namespaces | list | `[]` | List of namespaces to watch for events (`[]` means all namespaces) |
|
|
|
|
### Processing settings
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| extraLogProcessingStages | string | `""` | Stage blocks to be added to the loki.process component for cluster events. ([docs](https://grafana.com/docs/alloy/latest/reference/components/loki/loki.process/#blocks)) This value is templated so that you can refer to other values from this file. |
|
|
| jobLabel | string | `"integrations/kubernetes/eventhandler"` | The value for the job label. |
|
|
| labelsToKeep | list | `["job","level","namespace","node","source"]` | The list of labels to keep on the logs, all other pipeline labels will be dropped. |
|
|
| structuredMetadata | object | `{}` | The structured metadata mappings to set. To not set any structured metadata, set this to an empty object (e.g. `{}`) Format: `<key>: <extracted_key>`. Example: structuredMetadata: component: component kind: kind name: name |
|
|
|
|
### General settings
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| fullnameOverride | string | `""` | Full name override |
|
|
| nameOverride | string | `""` | Name override |
|