Working on docuemntation and examples

Signed-off-by: Pete Wall <pete.wall@grafana.com>

charts/feature-application-observability/templates/_validation.tpl

@@ -7,7 +7,7 @@
   {{- $msg = append $msg "  receivers:" }}
   {{- $msg = append $msg "    grpc:" }}
   {{- $msg = append $msg "      enabled: true" }}
-  {{- $msg = append $msg "See https://github.com/grafana/k8s-monitoring-helm/blob/main/charts/feature-application-observability for more details." }}
+  {{- $msg = append $msg "See https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-application-observability for more details." }}
   {{- fail (join "\n" $msg) }}
 {{- end }}
 {{- end }}

charts/feature-application-observability/tests/validation_test.yaml

@@ -16,4 +16,4 @@ tests:
               receivers:
                 grpc:
                   enabled: true
-            See https://github.com/grafana/k8s-monitoring-helm/blob/main/charts/feature-application-observability for more details.
+            See https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-application-observability for more details.

charts/feature-cluster-metrics/templates/_node_exporter.alloy.tpl

@@ -35,7 +35,7 @@ node_exporter.kubernetes "targets" {
 
 node_exporter.scrape "metrics" {
   targets = node_exporter.kubernetes.targets.output
-  job_name = "integrations/node_exporter"
+  job_label = "integrations/node_exporter"
   clustering = true
 {{- if $metricAllowList }}
   keep_metrics = "up|{{ $metricAllowList | fromYamlArray | join "|" }}"

charts/k8s-monitoring-test/README.md

@@ -8,7 +8,7 @@
 ![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)
 A Helm chart for testing the Kubernetes Monitoring Helm chart
 
-This chart is intended for testing the [k8s-monitoring](https://github.com/grafana/k8s-monitoring-helm/blob/main/charts/k8s-monitoring/README.md) chart.
+This chart is intended for testing the [k8s-monitoring](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring) chart.
 
 It allows for a way to encode queries that will be used to ensure that telemetry data collected by the k8s-monitoring
 chart is actually delivered to the desired destinations.

charts/k8s-monitoring-test/README.md.gotmpl

@@ -9,7 +9,7 @@
 {{ template "chart.description" . }}
 {{ template "chart.homepageLine" . }}
 
-This chart is intended for testing the [k8s-monitoring](https://github.com/grafana/k8s-monitoring-helm/blob/main/charts/k8s-monitoring/README.md) chart.
+This chart is intended for testing the [k8s-monitoring](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring) chart.
 
 It allows for a way to encode queries that will be used to ensure that telemetry data collected by the k8s-monitoring
 chart is actually delivered to the desired destinations.

charts/k8s-monitoring/Chart.lock

@@ -42,4 +42,4 @@ dependencies:
   repository: https://grafana.github.io/helm-charts
   version: 0.7.0
 digest: sha256:a7478342074296ebf188fa7f1f61da0acebcf11cbe7293a9c5b933d834bcc30e
-generated: "2024-10-03T20:05:57.43541-05:00"
+generated: "2024-10-04T12:14:37.212524-05:00"

charts/k8s-monitoring/Makefile

@@ -64,6 +64,7 @@ EXAMPLE_RELEASE_NAME=ko
 EXAMPLE_VALUES_FILES = $(shell find docs/examples -name values.yaml)
 EXAMPLE_OUTPUT_FILES = $(EXAMPLE_VALUES_FILES:values.yaml=output.yaml)
 EXAMPLE_ALLOY_FILES = $(foreach file,$(EXAMPLE_VALUES_FILES),$(call alloy_configs, $(file)))
+EXAMPLE_README_FILES = $(EXAMPLE_VALUES_FILES:values.yaml=README.md)
 
 alloy_configs = $(shell \
 	DIR="$(shell dirname $(1))/" yq e 'with_entries(select(.key == "alloy-*")) | select(.[].enabled == true) | to_entries | env(DIR) + .[].key + ".alloy"' $(1) \
@@ -93,13 +94,31 @@ Chart.lock: Chart.yaml
 %/alloy-profiles.alloy: %/output.yaml
 	yq 'select(.kind=="ConfigMap" and .metadata.name=="$(EXAMPLE_RELEASE_NAME)-alloy-profiles") | .data["config.alloy"]' $< > $@
 
+%/README.md: %/values.yaml $$(wildcard %/description.txt)
+	echo '<!--' > $@
+	echo '(NOTE: Do not edit README.md directly. It is a generated file!)' >> $@
+	echo '(      To make changes, please modify values.yaml or description.txt and run `make examples`)' >> $@
+	echo '-->' >> $@
+
+	if [ -f $$(dirname $@)/description.txt ]; then \
+		cat $$(dirname $@)/description.txt >> $@; \
+	else \
+		echo $< | sed -e "s/docs\/examples\//# Example: /" >> $@; \
+	fi
+	echo '' >> $@
+	echo '## Values' >> $@
+	echo '' >> $@
+	echo '```yaml' >> $@
+	cat $< >> $@
+	echo '```' >> $@
+
 .PHONY: examples
-examples: $(EXAMPLE_OUTPUT_FILES) $(EXAMPLE_ALLOY_FILES)
+examples: $(EXAMPLE_OUTPUT_FILES) $(EXAMPLE_ALLOY_FILES) $(EXAMPLE_README_FILES)
 
 .PHONY: clean
 clean:
 	rm -f README.md values.schema.json templates/destinations/_destination_types.tpl schema-mods/destination-list.json $(DESTINATION_SCHEMA_FILES) $(DESTINATION_DOCS_FILES)
-	rm -f $(EXAMPLE_OUTPUT_FILES) $(EXAMPLE_ALLOY_FILES)
+	rm -f $(EXAMPLE_OUTPUT_FILES) $(EXAMPLE_ALLOY_FILES) $(EXAMPLE_README_FILES)
 
 # Build targets
 .PHONY: build

charts/k8s-monitoring/README.md

@@ -196,15 +196,15 @@ podLogs:
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| annotationAutodiscovery | object | Disabled | Annotation Autodiscovery enables gathering metrics from Kubernetes Pods and Services discovered by special annotations. Requires a destination that supports metrics. To see the valid options, please see the [Annotation Autodiscovery feature documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/annotation-autodiscovery). |
+| annotationAutodiscovery | object | Disabled | Annotation Autodiscovery enables gathering metrics from Kubernetes Pods and Services discovered by special annotations. Requires a destination that supports metrics. To see the valid options, please see the [Annotation Autodiscovery feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-annotation-autodiscovery). |
 | annotationAutodiscovery.destinations | list | `[]` | The destinations where cluster metrics will be sent. If empty, all metrics-capable destinations will be used. |
 | annotationAutodiscovery.enabled | bool | `false` | Enable gathering metrics from Kubernetes Pods and Services discovered by special annotations. |
 
 ### Features - Application Observability
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| applicationObservability | object | Disabled | Application Observability. Requires destinations that supports metrics, logs, and traces. To see the valid options, please see the [Application Observability feature documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/application-observability). |
+| applicationObservability | object | Disabled | Application Observability. Requires destinations that supports metrics, logs, and traces. To see the valid options, please see the [Application Observability feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-application-observability). |
 | applicationObservability.destinations | list | `[]` | The destinations where application data will be sent. If empty, all capable destinations will be used. |
 | applicationObservability.enabled | bool | `false` | Enable gathering Kubernetes Pod logs. |
 
@@ -218,29 +218,29 @@ podLogs:
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| clusterEvents | object | Disabled | Cluster events. Requires a destination that supports logs. To see the valid options, please see the [Cluster Events feature documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/cluster-events). |
+| clusterEvents | object | Disabled | Cluster events. Requires a destination that supports logs. To see the valid options, please see the [Cluster Events feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-cluster-events). |
 | clusterEvents.destinations | list | `[]` | The destinations where cluster events will be sent. If empty, all logs-capable destinations will be used. |
 | clusterEvents.enabled | bool | `false` | Enable gathering Kubernetes Cluster events. |
 
 ### Features - Cluster Metrics
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| clusterMetrics | object | Disabled | Cluster Monitoring enables observability and monitoring for your Kubernetes Cluster itself. Requires a destination that supports metrics. To see the valid options, please see the [Cluster Monitoring feature documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/cluster-metrics). |
+| clusterMetrics | object | Disabled | Cluster Monitoring enables observability and monitoring for your Kubernetes Cluster itself. Requires a destination that supports metrics. To see the valid options, please see the [Cluster Monitoring feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-cluster-metrics). |
 | clusterMetrics.destinations | list | `[]` | The destinations where cluster metrics will be sent. If empty, all metrics-capable destinations will be used. |
 | clusterMetrics.enabled | bool | `false` | Enable gathering Kubernetes Cluster metrics. |
 
 ### Destinations
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| destinations | list | `[]` | The list of destinations where telemetry data will be sent. See the [destinations documentation](https://github.com/grafana/grafana-telemetry-collector-helm/blob/main/charts/kubernetes-observability/docs/destinations/README.md) for more information. |
+| destinations | list | `[]` | The list of destinations where telemetry data will be sent. See the [destinations documentation](https://github.com/grafana/k8s-monitoring-helm/blob/main/charts/k8s-monitoring/docs/destinations/README.md) for more information. |
 
 ### Features - Frontend Observability
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| frontendObservability | object | Disabled | Front-end Observability enables the Faro receiver for accepting traces and logs from front-end applications. Requires a destination that supports metrics, logs, and traces. To see the valid options, please see the [Front-end Observability feature documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/frontend-observability). |
+| frontendObservability | object | Disabled | Front-end Observability enables the Faro receiver for accepting traces and logs from front-end applications. Requires a destination that supports metrics, logs, and traces. To see the valid options, please see the [Front-end Observability feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-frontend-observability). |
 | frontendObservability.destinations | list | `[]` | The destinations where cluster events will be sent. If empty, all traces and logs-capable destinations will be used. |
 | frontendObservability.enabled | bool | `false` | Enable gathering front-end observability data. |
 
@@ -256,31 +256,31 @@ podLogs:
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| integrations | object | No integrations enabled | Service Integrations enables gathering telemetry data for common services and applications deployed to Kubernetes. To see the valid options, please see the [Service Integrations documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/integrations). |
+| integrations | object | No integrations enabled | Service Integrations enables gathering telemetry data for common services and applications deployed to Kubernetes. To see the valid options, please see the [Service Integrations documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-integrations). |
 | integrations.destinations | list | `[]` | The destinations where cluster events will be sent. If empty, all logs-capable destinations will be used. |
 | integrations.enabled | bool | `true` | Enable Service Integrations. |
 
 ### Features - Pod Logs
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| podLogs | object | Disabled | Pod logs. Requires a destination that supports logs. To see the valid options, please see the [Pod Logs feature documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/pod-logs). |
+| podLogs | object | Disabled | Pod logs. Requires a destination that supports logs. To see the valid options, please see the [Pod Logs feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-pod-logs). |
 | podLogs.destinations | list | `[]` | The destinations where logs will be sent. If empty, all logs-capable destinations will be used. |
 | podLogs.enabled | bool | `false` | Enable gathering Kubernetes Pod logs. |
 
 ### Features - Profiling
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| profiling | object | Disabled | Profiling enables gathering profiles from applications. Requires a destination that supports profiles. To see the valid options, please see the [Profiling feature documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/profiling). |
+| profiling | object | Disabled | Profiling enables gathering profiles from applications. Requires a destination that supports profiles. To see the valid options, please see the [Profiling feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-profiling). |
 | profiling.destinations | list | `[]` | The destinations where profiles will be sent. If empty, all profiles-capable destinations will be used. |
 | profiling.enabled | bool | `false` | Enable gathering profiles from applications. |
 
 ### Features - Prometheus Operator Objects
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| prometheusOperatorObjects | object | Disabled | Prometheus Operator Objects enables the gathering of metrics from objects like Probes, PodMonitors, and ServiceMonitors. Requires a destination that supports metrics. To see the valid options, please see the [Prometheus Operator Objects feature documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/prometheus-operator-objects). |
+| prometheusOperatorObjects | object | Disabled | Prometheus Operator Objects enables the gathering of metrics from objects like Probes, PodMonitors, and ServiceMonitors. Requires a destination that supports metrics. To see the valid options, please see the [Prometheus Operator Objects feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-prometheus-operator-objects). |
 | prometheusOperatorObjects.destinations | list | `[]` | The destinations where metrics will be sent. If empty, all metrics-capable destinations will be used. |
 | prometheusOperatorObjects.enabled | bool | `false` | Enable gathering metrics from Prometheus Operator Objects. |
 

charts/k8s-monitoring/docs/Features.md

@@ -5,7 +5,7 @@ These are the current features supported in this Helm chart:
 -   [Cluster Metrics](#cluster-metrics)
 -   [Cluster Events](#cluster-events)
 -   [Application Observability](#application-observability)
--   [Annotation Autodisocvery](#annotation-autodiscovery)
+-   [Annotation Autodiscovery](#annotation-autodiscovery)
 -   [Prometheus Operator Objects](#prometheus-operator-objects)
 -   [Pod Logs](#pod-logs)
 -   [Service Integrations](#service-integrations)
@@ -14,54 +14,54 @@ These are the current features supported in this Helm chart:
 
 ## Cluster Metrics
 
-[Documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/cluster-metrics)
+[Documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-cluster-metrics)
 
 Collects metrics about the Kubernetes cluster.
 
 ## Cluster Events
 
-[Documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/cluster-events)
+[Documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-cluster-events)
 
 Collects Kubernetes Cluster events.
 
 ## Application Observability
 
-[Documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/application-observability)
+[Documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-application-observability)
 
 Open receivers to collect telemetry data from instrumented applications.
 
 ## Annotation Autodiscovery
 
-[Documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/annotation-autodiscovery)
+[Documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-annotation-autodiscovery)
 
 Collects metrics from Pods and Services that use a specific annotation.
 
 ## Prometheus Operator Objects
 
-[Documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/prometheus-operator-objects)
+[Documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-prometheus-operator-objects)
 
 Collects metrics from Prometheus Operator objects, like PodMonitors and ServiceMonitors.
 
 ## Pod Logs
 
-[Documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/pod-logs)
+[Documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-pod-logs)
 
 Collects logs from Kubernetes Pods.
 
 ## Service Integrations
 
-[Documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/integrations)
+[Documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-integrations)
 
 Collects metrics and logs from a variety of popular services and integrations.
 
 ## Profiling
 
-[Documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/profiling)
+[Documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-profiling)
 
 Collect profiles using Pyroscope.
 
 ## Frontend Observability
 
-[Documentation](https://github.com/grafana/grafana-telemetry-collector-helm/tree/main/charts/frontend-observability)
+[Documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-frontend-observability)
 
 Open a Faro receiver to collect telemetry data from instrumented frontend applications.

charts/k8s-monitoring/docs/examples/features/annotation-autodiscovery/default/README.md

@@ -0,0 +1,39 @@
+<!--
+(NOTE: Do not edit README.md directly. It is a generated file!)
+(      To make changes, please modify values.yaml or description.txt and run `make examples`)
+-->
+# Annotation-based autodiscovery
+
+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`.
+
+For more information, see the [Annotation Autodiscovery feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-annotation-autodiscovery).
+
+## Values
+
+```yaml
+---
+cluster:
+  name: annotation-autodiscovery-cluster
+
+destinations:
+  - name: prometheus
+    type: prometheus
+    url: http://prometheus.prometheus.svc:9090/api/v1/write
+
+annotationAutodiscovery:
+  enabled: true
+
+alloy-metrics:
+  enabled: true
+```