docs: document metrics.interval configuration option (#167)

honeycombio · Aug 24, 2022 · 9b40585 · 9b40585
1 parent 1177d40
commit 9b40585
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/charts/honeycomb/README.md b/charts/honeycomb/README.md
@@ -91,6 +91,7 @@ The following table lists the configurable parameters of the Honeycomb chart, an
 | `metrics.dataset`               | Name of Honeycomb dataset for Kubernetes metrics                                                                                                                                                                                            | `kubernetes-metrics`                              |
 | `metrics.clusterName`           | Name of Kubernetes cluster to use for metrics                                                                                                                                                                                               | `k8s-cluster`                                     |
 | `metrics.metricGroups`          | Resource groups (node, pod, container, volume) to collect metrics from                                                                                                                                                                      | `node, pod`                                       |
+| `metrics.interval`              | Scrape interval in seconds                                                                                                                                                                                                                  | `nil`                                             |
 | `metrics.omitLabels`            | Pod labels to omit from being emitted as fields in metrics                                                                                                                                                                                  | `nil`                                             |
 | `metrics.additionalFields`      | Additional fields to add to each metric (overrides global setting)                                                                                                                                                                          | `nil`                                             |
 | `nameOverride`                  | String to partially override honeycomb.fullname template with a string (will append the release name)                                                                                                                                       | `nil`                                             |

diff --git a/charts/honeycomb/values.yaml b/charts/honeycomb/values.yaml
@@ -35,6 +35,7 @@ metrics:
   metricGroups:
     - node
     - pod
+  # interval: 20 ## honeycomb-agent defaults to 10
   # omitLabels:
   #   - "private_label"
   # additionalFields: