diff --git a/Makefile b/Makefile index f76de658b..db20c9ce0 100644 --- a/Makefile +++ b/Makefile @@ -13,6 +13,7 @@ build: .PHONY: test test: build + helm repo update set -e && \ for chart in $(FEATURE_CHARTS); do \ make -C charts/$$chart test; \ diff --git a/charts/feature-annotation-autodiscovery/Chart.yaml b/charts/feature-annotation-autodiscovery/Chart.yaml index 2de14ccb7..786c43fcf 100644 --- a/charts/feature-annotation-autodiscovery/Chart.yaml +++ b/charts/feature-annotation-autodiscovery/Chart.yaml @@ -3,6 +3,8 @@ apiVersion: v2 name: k8s-monitoring-feature-annotation-autodiscovery description: Gathers metrics automatically based on Kubernetes Pod and Service annotations icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg +sources: + - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-annotation-autodiscovery version: 1.0.0 appVersion: 1.0.0 maintainers: diff --git a/charts/feature-annotation-autodiscovery/Makefile b/charts/feature-annotation-autodiscovery/Makefile index 605b55098..82a837825 100644 --- a/charts/feature-annotation-autodiscovery/Makefile +++ b/charts/feature-annotation-autodiscovery/Makefile @@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json .PHONY: test test: build helm lint . - ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts . + ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts . ifdef HAS_HELM_UNITTEST helm unittest . else diff --git a/charts/feature-annotation-autodiscovery/README.md b/charts/feature-annotation-autodiscovery/README.md index 92018742e..8642d7234 100644 --- a/charts/feature-annotation-autodiscovery/README.md +++ b/charts/feature-annotation-autodiscovery/README.md @@ -1,14 +1,38 @@ + + # k8s-monitoring-feature-annotation-autodiscovery ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) - Gathers metrics automatically based on Kubernetes Pod and Service annotations +The annotation-based autodiscovery feature makes it very simple to add scrape targets. With this feature enabled, any +Kubernetes Pods or Services with the `k8s.grafana.com/scrape` annotation set to `true` will be automatically discovered +and scraped by the collector. There are several other annotations that can be used to customize the behavior of the +scrape configuration, such as: + +* `k8s.grafana.com/job`: The value to use for the `job` label. +* `k8s.grafana.com/instance`: The value to use for the `instance` label. +* `k8s.grafana.com/metrics.path`: The path to scrape for metrics. Defaults to `/metrics`. +* `k8s.grafana.com/metrics.portNumber`: The port on the Pod or Service to scrape for metrics. This is used to target a specific port by its number, rather than all ports. +* `k8s.grafana.com/metrics.portName`: The named port on the Pod or Service to scrape for metrics. This is used to target a specific port by its name, rather than all ports. +* `k8s.grafana.com/metrics.scheme`: The scheme to use when scraping metrics. Defaults to `http`. +* `k8s.grafana.com/metrics.scrapeInterval`: The scrape interval to use when scraping metrics. Defaults to `60s`. + ## Maintainers | Name | Email | Url | | ---- | ------ | --- | | petewall | | | + + +## Source Code + +* + + ## Values @@ -60,6 +84,3 @@ Gathers metrics automatically based on Kubernetes Pod and Service annotations |-----|------|---------|-------------| | global.maxCacheSize | int | `100000` | Sets the max_cache_size for every prometheus.relabel component. ([docs](https://grafana.com/docs/alloy/latest/reference/components/prometheus.relabel/#arguments)) This should be at least 2x-5x your largest scrape target or samples appended rate. | | global.scrapeInterval | string | `"60s"` | How frequently to scrape metrics. | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) diff --git a/charts/feature-annotation-autodiscovery/README.md.gotmpl b/charts/feature-annotation-autodiscovery/README.md.gotmpl new file mode 100644 index 000000000..9a3635076 --- /dev/null +++ b/charts/feature-annotation-autodiscovery/README.md.gotmpl @@ -0,0 +1,32 @@ + + +{{ template "chart.header" . }} +{{ template "chart.deprecationWarning" . }} +{{ template "chart.badgesSection" . }} +{{ template "chart.description" . }} +{{ template "chart.homepageLine" . }} + +The annotation-based autodiscovery feature makes it very simple to add scrape targets. With this feature enabled, any +Kubernetes Pods or Services with the `k8s.grafana.com/scrape` annotation set to `true` will be automatically discovered +and scraped by the collector. There are several other annotations that can be used to customize the behavior of the +scrape configuration, such as: + +* `k8s.grafana.com/job`: The value to use for the `job` label. +* `k8s.grafana.com/instance`: The value to use for the `instance` label. +* `k8s.grafana.com/metrics.path`: The path to scrape for metrics. Defaults to `/metrics`. +* `k8s.grafana.com/metrics.portNumber`: The port on the Pod or Service to scrape for metrics. This is used to target a specific port by its number, rather than all ports. +* `k8s.grafana.com/metrics.portName`: The named port on the Pod or Service to scrape for metrics. This is used to target a specific port by its name, rather than all ports. +* `k8s.grafana.com/metrics.scheme`: The scheme to use when scraping metrics. Defaults to `http`. +* `k8s.grafana.com/metrics.scrapeInterval`: The scrape interval to use when scraping metrics. Defaults to `60s`. + +{{ template "chart.maintainersSection" . }} + + +{{ template "chart.sourcesSection" . }} + + +{{ template "chart.requirementsSection" . }} +{{ template "chart.valuesSection" . }} diff --git a/charts/feature-application-observability/Chart.yaml b/charts/feature-application-observability/Chart.yaml index 2a61ef764..6df221163 100644 --- a/charts/feature-application-observability/Chart.yaml +++ b/charts/feature-application-observability/Chart.yaml @@ -3,6 +3,8 @@ apiVersion: v2 name: k8s-monitoring-feature-application-observability description: Gathers application data icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg +sources: + - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-application-observability version: 1.0.0 appVersion: 1.0.0 maintainers: diff --git a/charts/feature-application-observability/Makefile b/charts/feature-application-observability/Makefile index 605b55098..82a837825 100644 --- a/charts/feature-application-observability/Makefile +++ b/charts/feature-application-observability/Makefile @@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json .PHONY: test test: build helm lint . - ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts . + ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts . ifdef HAS_HELM_UNITTEST helm unittest . else diff --git a/charts/feature-application-observability/README.md b/charts/feature-application-observability/README.md index 34f945e0c..4579a2410 100644 --- a/charts/feature-application-observability/README.md +++ b/charts/feature-application-observability/README.md @@ -1,14 +1,28 @@ + + # k8s-monitoring-feature-application-observability ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) - Gathers application data +The Application Observability feature enables the collection of application telemetry data. Enabling this feature +requires enabling one or more receivers where data will be sent from the application. + ## Maintainers | Name | Email | Url | | ---- | ------ | --- | | petewall | | | + + +## Source Code + +* + + ## Values @@ -74,6 +88,3 @@ Gathers application data | traces.enabled | bool | `true` | | | traces.filters | object | `{"span":[],"spanevent":[]}` | Apply a filter to traces received via the OTLP or OTLP HTTP receivers. ([docs](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.filter/)) | | traces.transforms | object | `{"resource":[],"span":[],"spanevent":[]}` | Apply a transformation to traces received via the OTLP or OTLP HTTP receivers. ([docs](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.transform/)) | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) diff --git a/charts/feature-application-observability/README.md.gotmpl b/charts/feature-application-observability/README.md.gotmpl new file mode 100644 index 000000000..3bf7f6e39 --- /dev/null +++ b/charts/feature-application-observability/README.md.gotmpl @@ -0,0 +1,22 @@ + + +{{ template "chart.header" . }} +{{ template "chart.deprecationWarning" . }} +{{ template "chart.badgesSection" . }} +{{ template "chart.description" . }} +{{ template "chart.homepageLine" . }} + +The Application Observability feature enables the collection of application telemetry data. Enabling this feature +requires enabling one or more receivers where data will be sent from the application. + +{{ template "chart.maintainersSection" . }} + + +{{ template "chart.sourcesSection" . }} + + +{{ template "chart.requirementsSection" . }} +{{ template "chart.valuesSection" . }} diff --git a/charts/feature-cluster-events/Chart.yaml b/charts/feature-cluster-events/Chart.yaml index 314c88c6b..dbd3b8024 100644 --- a/charts/feature-cluster-events/Chart.yaml +++ b/charts/feature-cluster-events/Chart.yaml @@ -3,6 +3,8 @@ apiVersion: v2 name: k8s-monitoring-feature-cluster-events description: Gathers Kubernetes Events icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg +sources: + - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-cluster-events version: 1.0.0 appVersion: 1.0.0 maintainers: diff --git a/charts/feature-cluster-events/Makefile b/charts/feature-cluster-events/Makefile index 605b55098..82a837825 100644 --- a/charts/feature-cluster-events/Makefile +++ b/charts/feature-cluster-events/Makefile @@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json .PHONY: test test: build helm lint . - ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts . + ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts . ifdef HAS_HELM_UNITTEST helm unittest . else diff --git a/charts/feature-cluster-events/README.md b/charts/feature-cluster-events/README.md index 11364e731..86b86fad9 100644 --- a/charts/feature-cluster-events/README.md +++ b/charts/feature-cluster-events/README.md @@ -1,14 +1,28 @@ + + # k8s-monitoring-feature-cluster-events ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) - Gathers Kubernetes Events +The Cluster Events feature enables the collection of Kubernetes events from the cluster. Events are captured as logs and +are annotated with additional metadata to make them easier to search and filter. + ## Maintainers | Name | Email | Url | | ---- | ------ | --- | | petewall | | | + + +## Source Code + +* + + ## Values @@ -31,6 +45,3 @@ Gathers Kubernetes Events |-----|------|---------|-------------| | 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) | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) diff --git a/charts/feature-cluster-events/README.md.gotmpl b/charts/feature-cluster-events/README.md.gotmpl new file mode 100644 index 000000000..a02e7dff0 --- /dev/null +++ b/charts/feature-cluster-events/README.md.gotmpl @@ -0,0 +1,22 @@ + + +{{ template "chart.header" . }} +{{ template "chart.deprecationWarning" . }} +{{ template "chart.badgesSection" . }} +{{ template "chart.description" . }} +{{ template "chart.homepageLine" . }} + +The Cluster Events feature enables the collection of Kubernetes events from the cluster. Events are captured as logs and +are annotated with additional metadata to make them easier to search and filter. + +{{ template "chart.maintainersSection" . }} + + +{{ template "chart.sourcesSection" . }} + + +{{ template "chart.requirementsSection" . }} +{{ template "chart.valuesSection" . }} diff --git a/charts/feature-cluster-metrics/Chart.yaml b/charts/feature-cluster-metrics/Chart.yaml index 2ef061e15..f4f0b17d6 100644 --- a/charts/feature-cluster-metrics/Chart.yaml +++ b/charts/feature-cluster-metrics/Chart.yaml @@ -3,6 +3,8 @@ apiVersion: v2 name: k8s-monitoring-feature-cluster-metrics description: Gathers Kubernetes Cluster metrics icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg +sources: + - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-cluster-metrics version: 1.0.0 appVersion: 1.0.0 maintainers: diff --git a/charts/feature-cluster-metrics/Makefile b/charts/feature-cluster-metrics/Makefile index e465f2aa3..82a837825 100644 --- a/charts/feature-cluster-metrics/Makefile +++ b/charts/feature-cluster-metrics/Makefile @@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json .PHONY: test test: build helm lint . - ct lint --config .ct.yaml --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts . + ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts . ifdef HAS_HELM_UNITTEST helm unittest . else diff --git a/charts/feature-cluster-metrics/README.md b/charts/feature-cluster-metrics/README.md index b2b12632e..6c6dce0b4 100644 --- a/charts/feature-cluster-metrics/README.md +++ b/charts/feature-cluster-metrics/README.md @@ -132,6 +132,12 @@ action on the metric list, including filtering based on label or other actions. | petewall | | | + +## Source Code + +* + + ## Requirements | Repository | Name | Version | diff --git a/charts/feature-cluster-metrics/README.md.gotmpl b/charts/feature-cluster-metrics/README.md.gotmpl index 673d1e606..7f7bbff98 100644 --- a/charts/feature-cluster-metrics/README.md.gotmpl +++ b/charts/feature-cluster-metrics/README.md.gotmpl @@ -130,9 +130,11 @@ action on the metric list, including filtering based on label or other actions. {{ template "chart.maintainersSection" . }} + + {{ template "chart.sourcesSection" . }} + - {{ template "chart.requirementsSection" . }} diff --git a/charts/feature-frontend-observability/Chart.yaml b/charts/feature-frontend-observability/Chart.yaml index 67494e88d..48febcb38 100644 --- a/charts/feature-frontend-observability/Chart.yaml +++ b/charts/feature-frontend-observability/Chart.yaml @@ -3,6 +3,8 @@ apiVersion: v2 name: k8s-monitoring-feature-frontend-observability description: Gathers frontend data icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg +sources: + - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-frontend-observability version: 1.0.0 appVersion: 1.0.0 maintainers: diff --git a/charts/feature-frontend-observability/Makefile b/charts/feature-frontend-observability/Makefile index 605b55098..82a837825 100644 --- a/charts/feature-frontend-observability/Makefile +++ b/charts/feature-frontend-observability/Makefile @@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json .PHONY: test test: build helm lint . - ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts . + ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts . ifdef HAS_HELM_UNITTEST helm unittest . else diff --git a/charts/feature-frontend-observability/README.md b/charts/feature-frontend-observability/README.md index 08ecfedf5..f77eb29c4 100644 --- a/charts/feature-frontend-observability/README.md +++ b/charts/feature-frontend-observability/README.md @@ -1,14 +1,28 @@ + + # k8s-monitoring-feature-frontend-observability ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) - Gathers frontend data +The Frontend Observability feature enables the collection of telemetry data from Frontend Applications, instrumented by +[Grafana Faro](https://github.com/grafana/faro-web-sdk). + ## Maintainers | Name | Email | Url | | ---- | ------ | --- | | petewall | | | + + +## Source Code + +* + + ## Values @@ -19,6 +33,3 @@ Gathers frontend data | fullnameOverride | string | `""` | Full name override | | nameOverride | string | `""` | Name override | | port | int | `12347` | Port to listen for HTTP traffic on. | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) diff --git a/charts/feature-frontend-observability/README.md.gotmpl b/charts/feature-frontend-observability/README.md.gotmpl new file mode 100644 index 000000000..c644e9a96 --- /dev/null +++ b/charts/feature-frontend-observability/README.md.gotmpl @@ -0,0 +1,22 @@ + + +{{ template "chart.header" . }} +{{ template "chart.deprecationWarning" . }} +{{ template "chart.badgesSection" . }} +{{ template "chart.description" . }} +{{ template "chart.homepageLine" . }} + +The Frontend Observability feature enables the collection of telemetry data from Frontend Applications, instrumented by +[Grafana Faro](https://github.com/grafana/faro-web-sdk). + +{{ template "chart.maintainersSection" . }} + + +{{ template "chart.sourcesSection" . }} + + +{{ template "chart.requirementsSection" . }} +{{ template "chart.valuesSection" . }} diff --git a/charts/feature-integrations/Chart.yaml b/charts/feature-integrations/Chart.yaml index 07be3d634..abfd3f630 100644 --- a/charts/feature-integrations/Chart.yaml +++ b/charts/feature-integrations/Chart.yaml @@ -3,6 +3,8 @@ apiVersion: v2 name: k8s-monitoring-feature-integrations description: Service integrations icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg +sources: + - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-integrations version: 1.0.0 appVersion: 1.0.0 maintainers: diff --git a/charts/feature-integrations/Makefile b/charts/feature-integrations/Makefile index 4ae063a41..469ba242e 100644 --- a/charts/feature-integrations/Makefile +++ b/charts/feature-integrations/Makefile @@ -19,6 +19,7 @@ docs/integrations/%.md: integrations/%-values.yaml $$(wildcard docs/integrations schema-mods/definitions/%-integration.schema.json: integrations/%-values.yaml docker run --platform linux/amd64 --rm -v $(shell pwd):/src ghcr.io/grafana/helm-docs-and-schema-gen $(shell echo $< | sed 's/integrations\/\([-a-z]*\)-values.yaml/\1/') integration +NUMBER_OF_INTEGRATION_VALUES_FILES := $(words $(INTEGRATION_VALUES_FILES)) NUMBER_OF_INTEGRATION_VALUES_FILES := $(words $(INTEGRATION_VALUES_FILES)) schema-mods/integration-list.json: $(INTEGRATION_VALUES_FILES) @echo '{' > $@ @@ -53,19 +54,6 @@ templates/_integration_types.tpl: $(INTEGRATION_VALUES_FILES) values.schema.json: values.yaml $(INTEGRATION_SCHEMA_FILES) $(SCHEMA_MODS_JSON_FILES) $(SCHEMA_MODS_JQ_FILES) schema-mods/integration-list.json ../../scripts/schema-gen.sh . -docs/integrations/README.md: $(INTEGRATION_DOCS_FILES) - echo "# Integrations" > $@ - echo "" >> $@ - echo "This directory contains the values files for the integrations that are available." >> $@ - echo "" >> $@ - echo "## Integrations" >> $@ - echo "" >> $@ - echo "| Name | Docs |" >> $@ - echo "|------|------|" >> $@ - for file in $(INTEGRATION_DOCS_FILES); do \ - echo "| $$(echo $${file} | sed 's/\.\/docs\/integrations\/\([-a-z]*\).md/\1/') | [Docs]($$(echo $${file} | sed 's/docs\/integrations\/\([-a-z]*.md\)/\1/')) |" >> $@; \ - done - README.md: values.yaml Chart.yaml $$(wildcard README.md.gotmpl) ifdef HAS_HELM_DOCS helm-docs @@ -78,15 +66,14 @@ clean: rm -f README.md values.schema.json schema-mods/integration-list.json templates/_integration_types.tpl rm -f $(INTEGRATION_SCHEMA_FILES) rm -f $(INTEGRATION_DOCS_FILES) - rm -f docs/integrations/README.md .PHONY: build -build: README.md Chart.lock values.schema.json templates/_integration_types.tpl docs/integrations/README.md +build: README.md $(INTEGRATION_DOCS_FILES) Chart.lock values.schema.json templates/_integration_types.tpl .PHONY: test test: build helm lint . - ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts . + ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts . ifdef HAS_HELM_UNITTEST helm unittest . else diff --git a/charts/feature-integrations/README.md b/charts/feature-integrations/README.md index 6ae98b2cd..08e29fbd9 100644 --- a/charts/feature-integrations/README.md +++ b/charts/feature-integrations/README.md @@ -1,14 +1,63 @@ + + # k8s-monitoring-feature-integrations ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) - Service integrations +The Integrations feature builds in configuration for many common applications and services. + +The current integrations that are available from this feature are: + +| Integration | Description | Data Types | Docs | +| --- | --- | --- | --- | +| [Grafana Alloy](https://grafana.com/docs/alloy) | Telemetry data collector | Metrics | [Docs](./docs/integrations/alloy.md) | +| [cert-manager](https://cert-manager.io/) | x.509 certificate management for Kubernetes | Metrics | [Docs](./docs/integrations/cert-manager.md) | +| [etcd](https://etcd.io/) | Distributed key-value store | Metrics | [Docs](./docs/integrations/etcd.md) | + +## Usage + +To enable an integration, create an instance of it, with any configuration to aid in service discovery. For example: + +```yaml +cert-manager: + instances: + - name: cert-manager + namespace: kube-system + labelSelectors: + app.kubernetes.io/name: cert-manager +``` + +You can specify multiple instances of the same integration to match multiple instances of that service. For example: + +```yaml +alloy: + instances: + - name: alloy-metrics + labelSelectors: + app.kubernetes.io/name: alloy-metrics + - name: alloy-receivers + labelSelectors: + app.kubernetes.io/name: alloy-receivers +``` + +For all possible values for a specific integration, see the [documentation](./docs) page for that integration. + ## Maintainers | Name | Email | Url | | ---- | ------ | --- | | petewall | | | + + +## Source Code + +* + + ## Values @@ -43,6 +92,3 @@ Service integrations |-----|------|---------|-------------| | global.maxCacheSize | int | `100000` | Sets the max_cache_size for every prometheus.relabel component. ([docs](https://grafana.com/docs/alloy/latest/reference/components/prometheus.relabel/#arguments)) This should be at least 2x-5x your largest scrape target or samples appended rate. | | global.scrapeInterval | string | `"60s"` | How frequently to scrape metrics. | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) diff --git a/charts/feature-integrations/README.md.gotmpl b/charts/feature-integrations/README.md.gotmpl new file mode 100644 index 000000000..0aa8dcd78 --- /dev/null +++ b/charts/feature-integrations/README.md.gotmpl @@ -0,0 +1,57 @@ + + +{{ template "chart.header" . }} +{{ template "chart.deprecationWarning" . }} +{{ template "chart.badgesSection" . }} +{{ template "chart.description" . }} +{{ template "chart.homepageLine" . }} + +The Integrations feature builds in configuration for many common applications and services. + +The current integrations that are available from this feature are: + +| Integration | Description | Data Types | Docs | +| --- | --- | --- | --- | +| [Grafana Alloy](https://grafana.com/docs/alloy) | Telemetry data collector | Metrics | [Docs](./docs/integrations/alloy.md) | +| [cert-manager](https://cert-manager.io/) | x.509 certificate management for Kubernetes | Metrics | [Docs](./docs/integrations/cert-manager.md) | +| [etcd](https://etcd.io/) | Distributed key-value store | Metrics | [Docs](./docs/integrations/etcd.md) | + +## Usage + +To enable an integration, create an instance of it, with any configuration to aid in service discovery. For example: + +```yaml +cert-manager: + instances: + - name: cert-manager + namespace: kube-system + labelSelectors: + app.kubernetes.io/name: cert-manager +``` + +You can specify multiple instances of the same integration to match multiple instances of that service. For example: + +```yaml +alloy: + instances: + - name: alloy-metrics + labelSelectors: + app.kubernetes.io/name: alloy-metrics + - name: alloy-receivers + labelSelectors: + app.kubernetes.io/name: alloy-receivers +``` + +For all possible values for a specific integration, see the [documentation](./docs) page for that integration. + +{{ template "chart.maintainersSection" . }} + + +{{ template "chart.sourcesSection" . }} + + +{{ template "chart.requirementsSection" . }} +{{ template "chart.valuesSection" . }} diff --git a/charts/feature-integrations/docs/integrations/README.md b/charts/feature-integrations/docs/integrations/README.md deleted file mode 100644 index 0458b8e56..000000000 --- a/charts/feature-integrations/docs/integrations/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Integrations - -This directory contains the values files for the integrations that are available. - -## Integrations - -| Name | Docs | -|------|------| -| alloy | [Docs](./alloy.md) | -| cert-manager | [Docs](./cert-manager.md) | -| etcd | [Docs](./etcd.md) | diff --git a/charts/feature-integrations/docs/integrations/alloy.md b/charts/feature-integrations/docs/integrations/alloy.md index 919c947fe..5054f91ed 100644 --- a/charts/feature-integrations/docs/integrations/alloy.md +++ b/charts/feature-integrations/docs/integrations/alloy.md @@ -1,4 +1,5 @@ # alloy + ## Values ### Discovery Settings diff --git a/charts/feature-integrations/docs/integrations/cert-manager.md b/charts/feature-integrations/docs/integrations/cert-manager.md index b9518dac6..873fe8cfd 100644 --- a/charts/feature-integrations/docs/integrations/cert-manager.md +++ b/charts/feature-integrations/docs/integrations/cert-manager.md @@ -1,4 +1,5 @@ # cert-manager + ## Values ### Discovery Settings diff --git a/charts/feature-integrations/docs/integrations/etcd.md b/charts/feature-integrations/docs/integrations/etcd.md index 4e16e297b..5651aab6c 100644 --- a/charts/feature-integrations/docs/integrations/etcd.md +++ b/charts/feature-integrations/docs/integrations/etcd.md @@ -1,4 +1,5 @@ # etcd + ## Values ### Discovery Settings diff --git a/charts/feature-pod-logs/Chart.yaml b/charts/feature-pod-logs/Chart.yaml index 5295bbf6e..c92e46168 100644 --- a/charts/feature-pod-logs/Chart.yaml +++ b/charts/feature-pod-logs/Chart.yaml @@ -3,6 +3,8 @@ apiVersion: v2 name: k8s-monitoring-feature-pod-logs description: Kubernetes Observability feature for gathering Pod logs. type: application +sources: + - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-pod-logs version: 1.0.0 appVersion: 1.0.0 maintainers: diff --git a/charts/feature-pod-logs/Makefile b/charts/feature-pod-logs/Makefile index 605b55098..82a837825 100644 --- a/charts/feature-pod-logs/Makefile +++ b/charts/feature-pod-logs/Makefile @@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json .PHONY: test test: build helm lint . - ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts . + ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts . ifdef HAS_HELM_UNITTEST helm unittest . else diff --git a/charts/feature-pod-logs/README.md b/charts/feature-pod-logs/README.md index 568e324f3..c0865361b 100644 --- a/charts/feature-pod-logs/README.md +++ b/charts/feature-pod-logs/README.md @@ -1,14 +1,27 @@ + + # k8s-monitoring-feature-pod-logs ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) - Kubernetes Observability feature for gathering Pod logs. +The Pod Logs feature enables the collection of logs from Kubernetes Pods on the cluster. + ## Maintainers | Name | Email | Url | | ---- | ------ | --- | | petewall | | | + + +## Source Code + +* + + ## Values @@ -39,6 +52,3 @@ Kubernetes Observability feature for gathering Pod logs. | extraDiscoveryRules | string | `""` | Rules to filter pods for log gathering. Only used for "volumes" or "kubernetesApi" gather methods. | | extraLogProcessingStages | string | `""` | Stage blocks to be added to the loki.process component for pod logs. ([docs](https://grafana.com/docs/alloy/latest/reference/components/loki.process/#blocks)) This value is templated so that you can refer to other values from this file. | | gatherMethod | string | `"volumes"` | The method to gather pod logs. Options are "volumes", "kubernetesApi", "OpenShiftClusterLogForwarder" (experimental). | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) diff --git a/charts/feature-pod-logs/README.md.gotmpl b/charts/feature-pod-logs/README.md.gotmpl new file mode 100644 index 000000000..cc5641692 --- /dev/null +++ b/charts/feature-pod-logs/README.md.gotmpl @@ -0,0 +1,21 @@ + + +{{ template "chart.header" . }} +{{ template "chart.deprecationWarning" . }} +{{ template "chart.badgesSection" . }} +{{ template "chart.description" . }} +{{ template "chart.homepageLine" . }} + +The Pod Logs feature enables the collection of logs from Kubernetes Pods on the cluster. + +{{ template "chart.maintainersSection" . }} + + +{{ template "chart.sourcesSection" . }} + + +{{ template "chart.requirementsSection" . }} +{{ template "chart.valuesSection" . }} diff --git a/charts/feature-profiling/Chart.yaml b/charts/feature-profiling/Chart.yaml index 8c4be7db4..bac3663a7 100644 --- a/charts/feature-profiling/Chart.yaml +++ b/charts/feature-profiling/Chart.yaml @@ -3,6 +3,8 @@ apiVersion: v2 name: k8s-monitoring-feature-profiling description: Gathers profiles from eBPF, Java, and pprof sources. icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg +sources: + - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-profiling version: 1.0.0 appVersion: 1.0.0 maintainers: diff --git a/charts/feature-profiling/Makefile b/charts/feature-profiling/Makefile index 605b55098..82a837825 100644 --- a/charts/feature-profiling/Makefile +++ b/charts/feature-profiling/Makefile @@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json .PHONY: test test: build helm lint . - ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts . + ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts . ifdef HAS_HELM_UNITTEST helm unittest . else diff --git a/charts/feature-profiling/README.md b/charts/feature-profiling/README.md index 82f0cd7e5..d3ffa4e33 100644 --- a/charts/feature-profiling/README.md +++ b/charts/feature-profiling/README.md @@ -1,14 +1,27 @@ + + # k8s-monitoring-feature-profiling ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) - Gathers profiles from eBPF, Java, and pprof sources. +The Profiling feature enables the collection of profiles from the processes running in the cluster. + ## Maintainers | Name | Email | Url | | ---- | ------ | --- | | petewall | | | + + +## Source Code + +* + + ## Values @@ -45,6 +58,3 @@ Gathers profiles from eBPF, Java, and pprof sources. | pprof.extraDiscoveryRules | string | `""` | Rule blocks to be added to the discovery.relabel component for eBPF profile sources. These relabeling rules are applied pre-scrape against the targets from service discovery. Before the scrape, any remaining target labels that start with `__` (i.e. `__meta_kubernetes*`) are dropped. ([docs](https://grafana.com/docs/alloy/latest/reference/components/discovery.relabel/#rule-block)) | | pprof.namespaces | list | `[]` | Which namespaces to look for pods with profiles. | | pprof.types | object | `{"block":true,"cpu":true,"fgprof":true,"godeltaprof_block":false,"godeltaprof_memory":false,"godeltaprof_mutex":false,"goroutine":true,"memory":true,"mutex":true}` | Profile types to gather | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) diff --git a/charts/feature-profiling/README.md.gotmpl b/charts/feature-profiling/README.md.gotmpl new file mode 100644 index 000000000..6f0a67074 --- /dev/null +++ b/charts/feature-profiling/README.md.gotmpl @@ -0,0 +1,21 @@ + + +{{ template "chart.header" . }} +{{ template "chart.deprecationWarning" . }} +{{ template "chart.badgesSection" . }} +{{ template "chart.description" . }} +{{ template "chart.homepageLine" . }} + +The Profiling feature enables the collection of profiles from the processes running in the cluster. + +{{ template "chart.maintainersSection" . }} + + +{{ template "chart.sourcesSection" . }} + + +{{ template "chart.requirementsSection" . }} +{{ template "chart.valuesSection" . }} diff --git a/charts/feature-prometheus-operator-objects/Chart.yaml b/charts/feature-prometheus-operator-objects/Chart.yaml index ef4c57a1a..595b86e9b 100644 --- a/charts/feature-prometheus-operator-objects/Chart.yaml +++ b/charts/feature-prometheus-operator-objects/Chart.yaml @@ -3,6 +3,8 @@ apiVersion: v2 name: k8s-monitoring-feature-prometheus-operator-objects description: Gathers metrics using Prometheus Operator Objects icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg +sources: + - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-prometheus-operator-objects version: 1.0.0 appVersion: 1.0.0 maintainers: diff --git a/charts/feature-prometheus-operator-objects/Makefile b/charts/feature-prometheus-operator-objects/Makefile index e465f2aa3..82a837825 100644 --- a/charts/feature-prometheus-operator-objects/Makefile +++ b/charts/feature-prometheus-operator-objects/Makefile @@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json .PHONY: test test: build helm lint . - ct lint --config .ct.yaml --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts . + ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts . ifdef HAS_HELM_UNITTEST helm unittest . else diff --git a/charts/feature-prometheus-operator-objects/README.md b/charts/feature-prometheus-operator-objects/README.md index 2a5583fca..7068ffe4d 100644 --- a/charts/feature-prometheus-operator-objects/README.md +++ b/charts/feature-prometheus-operator-objects/README.md @@ -1,21 +1,40 @@ + + # k8s-monitoring-feature-prometheus-operator-objects ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) - Gathers metrics using Prometheus Operator Objects +The Prometheus Operator Objects feature enables the discovery, processing, and utilization of certain Prometheus +Operator objects. Currently, this feature supports the following objects: + +| Object Type | Description | +|-------------|-------------| +| [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.ServiceMonitor) | A ServiceMonitor defines how to scrape metrics from Kubernetes Services. | +| [PodMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.PodMonitor) | A PodMonitor defines how to scrape metrics from Kubernetes Pods. | +| [Probe](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Probe) | A Probe defines how to scrape metrics from prober exporters. | + ## Maintainers | Name | Email | Url | | ---- | ------ | --- | | petewall | | | + + +## Source Code + +* + ## Requirements | Repository | Name | Version | |------------|------|---------| | https://prometheus-community.github.io/helm-charts | crds(prometheus-operator-crds) | 14.0.0 | - + ## Values ### CRDs @@ -73,6 +92,3 @@ Gathers metrics using Prometheus Operator Objects | serviceMonitors.namespaces | list | `[]` | Which namespaces to look for ServiceMonitor objects. | | serviceMonitors.scrapeInterval | string | 60s | How frequently to scrape metrics from ServiceMonitor objects. Only used if the ServiceMonitor does not specify the scrape interval. Overrides global.scrapeInterval | | serviceMonitors.selector | string | `""` | Selector to filter which ServiceMonitor objects to use. | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) diff --git a/charts/feature-prometheus-operator-objects/README.md.gotmpl b/charts/feature-prometheus-operator-objects/README.md.gotmpl new file mode 100644 index 000000000..2934e19e4 --- /dev/null +++ b/charts/feature-prometheus-operator-objects/README.md.gotmpl @@ -0,0 +1,29 @@ + + +{{ template "chart.header" . }} +{{ template "chart.deprecationWarning" . }} +{{ template "chart.badgesSection" . }} +{{ template "chart.description" . }} +{{ template "chart.homepageLine" . }} + +The Prometheus Operator Objects feature enables the discovery, processing, and utilization of certain Prometheus +Operator objects. Currently, this feature supports the following objects: + +| Object Type | Description | +|-------------|-------------| +| [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.ServiceMonitor) | A ServiceMonitor defines how to scrape metrics from Kubernetes Services. | +| [PodMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.PodMonitor) | A PodMonitor defines how to scrape metrics from Kubernetes Pods. | +| [Probe](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Probe) | A Probe defines how to scrape metrics from prober exporters. | + +{{ template "chart.maintainersSection" . }} + + +{{ template "chart.sourcesSection" . }} + + +{{ template "chart.requirementsSection" . }} + +{{ template "chart.valuesSection" . }} diff --git a/charts/k8s-monitoring-test/Makefile b/charts/k8s-monitoring-test/Makefile index 605b55098..82a837825 100644 --- a/charts/k8s-monitoring-test/Makefile +++ b/charts/k8s-monitoring-test/Makefile @@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json .PHONY: test test: build helm lint . - ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts . + ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts . ifdef HAS_HELM_UNITTEST helm unittest . else diff --git a/charts/k8s-monitoring/.ct.yaml b/charts/k8s-monitoring/.ct.yaml index ab9af6816..4f6602823 100644 --- a/charts/k8s-monitoring/.ct.yaml +++ b/charts/k8s-monitoring/.ct.yaml @@ -1,3 +1,5 @@ --- chart-repos: - grafana=https://grafana.github.io/helm-charts +helm-dependency-extra-args: + - --skip-refresh diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-annotation-autodiscovery-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-annotation-autodiscovery-1.0.0.tgz index 7b5459b87..80a8b6ed6 100644 Binary files a/charts/k8s-monitoring/charts/k8s-monitoring-feature-annotation-autodiscovery-1.0.0.tgz and b/charts/k8s-monitoring/charts/k8s-monitoring-feature-annotation-autodiscovery-1.0.0.tgz differ diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-application-observability-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-application-observability-1.0.0.tgz index 937d7bf0e..d437736b5 100644 Binary files a/charts/k8s-monitoring/charts/k8s-monitoring-feature-application-observability-1.0.0.tgz and b/charts/k8s-monitoring/charts/k8s-monitoring-feature-application-observability-1.0.0.tgz differ diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-events-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-events-1.0.0.tgz index 2cfab3988..7c5a08ef3 100644 Binary files a/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-events-1.0.0.tgz and b/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-events-1.0.0.tgz differ diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-metrics-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-metrics-1.0.0.tgz index 47bc9aa59..848f64d89 100644 Binary files a/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-metrics-1.0.0.tgz and b/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-metrics-1.0.0.tgz differ diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-frontend-observability-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-frontend-observability-1.0.0.tgz index 4f26b2917..fde9b7f36 100644 Binary files a/charts/k8s-monitoring/charts/k8s-monitoring-feature-frontend-observability-1.0.0.tgz and b/charts/k8s-monitoring/charts/k8s-monitoring-feature-frontend-observability-1.0.0.tgz differ diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-integrations-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-integrations-1.0.0.tgz index b16e82113..b3f0c743a 100644 Binary files a/charts/k8s-monitoring/charts/k8s-monitoring-feature-integrations-1.0.0.tgz and b/charts/k8s-monitoring/charts/k8s-monitoring-feature-integrations-1.0.0.tgz differ diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-pod-logs-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-pod-logs-1.0.0.tgz index 00a8ff141..47b04349b 100644 Binary files a/charts/k8s-monitoring/charts/k8s-monitoring-feature-pod-logs-1.0.0.tgz and b/charts/k8s-monitoring/charts/k8s-monitoring-feature-pod-logs-1.0.0.tgz differ diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-profiling-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-profiling-1.0.0.tgz index 7bbe61d9c..0bc2e3027 100644 Binary files a/charts/k8s-monitoring/charts/k8s-monitoring-feature-profiling-1.0.0.tgz and b/charts/k8s-monitoring/charts/k8s-monitoring-feature-profiling-1.0.0.tgz differ diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-prometheus-operator-objects-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-prometheus-operator-objects-1.0.0.tgz index 20c89e653..ae6e66e71 100644 Binary files a/charts/k8s-monitoring/charts/k8s-monitoring-feature-prometheus-operator-objects-1.0.0.tgz and b/charts/k8s-monitoring/charts/k8s-monitoring-feature-prometheus-operator-objects-1.0.0.tgz differ diff --git a/charts/k8s-monitoring/docs/examples/features/annotation-autodiscovery/default/README.md b/charts/k8s-monitoring/docs/examples/features/annotation-autodiscovery/default/README.md index 931cced74..4b533bd32 100644 --- a/charts/k8s-monitoring/docs/examples/features/annotation-autodiscovery/default/README.md +++ b/charts/k8s-monitoring/docs/examples/features/annotation-autodiscovery/default/README.md @@ -7,15 +7,15 @@ This example shows how to enable the annotation-based autodiscovery feature, which makes it very simple to add scrape targets. With this feature enabled, any Kubernetes Pods or Services with the `k8s.grafana.com/scrape` annotation set to `true` will be automatically discovered and scraped by the collector. There are several other annotations that can be -used to customize the scrape configuration, such as: - -* `k8s.grafana.com/job`: The value to use for the `job` label. -* `k8s.grafana.com/instance`: The value to use for the `instance` label. -* `k8s.grafana.com/metrics.path`: The path to scrape for metrics. Defaults to `/metrics`. -* `k8s.grafana.com/metrics.portNumber`: The port on the Pod or Service to scrape for metrics. This is used to target a specific port by its number, rather than all ports. -* `k8s.grafana.com/metrics.portName`: The named port on the Pod or Service to scrape for metrics. This is used to target a specific port by its name, rather than all ports. -* `k8s.grafana.com/metrics.scheme`: The scheme to use when scraping metrics. Defaults to `http`. -* `k8s.grafana.com/metrics.scrapeInterval`: The scrape interval to use when scraping metrics. Defaults to `60s`. +used to customize the behavior of the scrape configuration, such as: + +* `k8s.grafana.com/job`: The value to use for the `job` label. +* `k8s.grafana.com/instance`: The value to use for the `instance` label. +* `k8s.grafana.com/metrics.path`: The path to scrape for metrics. Defaults to `/metrics`. +* `k8s.grafana.com/metrics.portNumber`: The port on the Pod or Service to scrape for metrics. This is used to target a specific port by its number, rather than all ports. +* `k8s.grafana.com/metrics.portName`: The named port on the Pod or Service to scrape for metrics. This is used to target a specific port by its name, rather than all ports. +* `k8s.grafana.com/metrics.scheme`: The scheme to use when scraping metrics. Defaults to `http`. +* `k8s.grafana.com/metrics.scrapeInterval`: The scrape interval to use when scraping metrics. Defaults to `60s`. For more information, see the [Annotation Autodiscovery feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-annotation-autodiscovery). diff --git a/charts/k8s-monitoring/docs/examples/features/annotation-autodiscovery/default/description.txt b/charts/k8s-monitoring/docs/examples/features/annotation-autodiscovery/default/description.txt index 3ddc13070..0266cd6dd 100644 --- a/charts/k8s-monitoring/docs/examples/features/annotation-autodiscovery/default/description.txt +++ b/charts/k8s-monitoring/docs/examples/features/annotation-autodiscovery/default/description.txt @@ -3,14 +3,14 @@ This example shows how to enable the annotation-based autodiscovery feature, which makes it very simple to add scrape targets. With this feature enabled, any Kubernetes Pods or Services with the `k8s.grafana.com/scrape` annotation set to `true` will be automatically discovered and scraped by the collector. There are several other annotations that can be -used to customize the scrape configuration, such as: +used to customize the behavior of the scrape configuration, such as: -* `k8s.grafana.com/job`: The value to use for the `job` label. -* `k8s.grafana.com/instance`: The value to use for the `instance` label. -* `k8s.grafana.com/metrics.path`: The path to scrape for metrics. Defaults to `/metrics`. -* `k8s.grafana.com/metrics.portNumber`: The port on the Pod or Service to scrape for metrics. This is used to target a specific port by its number, rather than all ports. -* `k8s.grafana.com/metrics.portName`: The named port on the Pod or Service to scrape for metrics. This is used to target a specific port by its name, rather than all ports. -* `k8s.grafana.com/metrics.scheme`: The scheme to use when scraping metrics. Defaults to `http`. -* `k8s.grafana.com/metrics.scrapeInterval`: The scrape interval to use when scraping metrics. Defaults to `60s`. +* `k8s.grafana.com/job`: The value to use for the `job` label. +* `k8s.grafana.com/instance`: The value to use for the `instance` label. +* `k8s.grafana.com/metrics.path`: The path to scrape for metrics. Defaults to `/metrics`. +* `k8s.grafana.com/metrics.portNumber`: The port on the Pod or Service to scrape for metrics. This is used to target a specific port by its number, rather than all ports. +* `k8s.grafana.com/metrics.portName`: The named port on the Pod or Service to scrape for metrics. This is used to target a specific port by its name, rather than all ports. +* `k8s.grafana.com/metrics.scheme`: The scheme to use when scraping metrics. Defaults to `http`. +* `k8s.grafana.com/metrics.scrapeInterval`: The scrape interval to use when scraping metrics. Defaults to `60s`. For more information, see the [Annotation Autodiscovery feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-annotation-autodiscovery). diff --git a/charts/k8s-monitoring/tests/integration/control-plane-monitoring/values.yaml b/charts/k8s-monitoring/tests/integration/control-plane-monitoring/values.yaml index e9f540aaa..413e2abe9 100644 --- a/charts/k8s-monitoring/tests/integration/control-plane-monitoring/values.yaml +++ b/charts/k8s-monitoring/tests/integration/control-plane-monitoring/values.yaml @@ -5,7 +5,7 @@ cluster: destinations: - name: localPrometheus type: prometheus - url: https://prometheus-server.prometheus.svc:9090/api/v1/write + url: http://prometheus-server.prometheus.svc:9090/api/v1/write - name: localLoki type: loki url: http://loki.loki.svc:3100/loki/api/v1/push diff --git a/scripts/docs-and-schema-image/create-docs-and-schema.sh b/scripts/docs-and-schema-image/create-docs-and-schema.sh index cbfa2a1bf..089b530d7 100755 --- a/scripts/docs-and-schema-image/create-docs-and-schema.sh +++ b/scripts/docs-and-schema-image/create-docs-and-schema.sh @@ -49,6 +49,7 @@ if [ -f "${INPUT_TEMPLATE}" ]; then cp "${INPUT_TEMPLATE}" README.md.gotmpl else echo "# ${NAME}" > README.md.gotmpl + echo "" >> README.md.gotmpl echo '{{ template "chart.valuesSection" . }}' >> README.md.gotmpl fi