Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update example docs #1023

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@
(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`)
-->
# Example: features/auto-instrumentation/beyla-metrics-and-traces/values.yaml
# Auto-Instrumentation with Beyla for Metrics and Traces

This example demonstrates how to enable the auto-instrumentation feature, which deploys Grafana Beyla to automatically
instrument your application for metrics collection. It also coordinates with the Application Observability feature to
generate traces for your application.

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
(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`)
-->
# Example: features/auto-instrumentation/beyla-metrics/values.yaml
# Auto-Instrumentation with Beyla for Metrics

This example demonstrates how to enable the auto-instrumentation feature, which deploys Grafana Beyla to automatically
instrument your application for metrics collection.

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
(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`)
-->
# Example: features/cluster-events/default/values.yaml
# Cluster Events

This example demonstrates how to enable the Cluster Events feature to gather Kubernetes Cluster Events from the
Kubernetes API server and deliver them to a logs destination.

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
(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`)
-->
# Example: features/cluster-metrics/control-plane-monitoring/values.yaml
# Cluster Metrics with Control Plane Monitoring

This example demonstrates how to enable the Cluster Metrics feature to gather metrics about the Kubernetes Cluster,
including the control plane components, and deliver them to a metrics destination.

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
(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`)
-->
# Example: features/cluster-metrics/default/values.yaml
# Cluster Metrics

This example demonstrates how to enable the Cluster Metrics feature to gather metrics about the Kubernetes Cluster and
deliver them to a metrics destination.

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
(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`)
-->
# Example: features/integrations/alloy/values.yaml
# Integration: Alloy

This example demonstrates how to gather metrics from
[Grafana Alloy](https://grafana.com/oss/alloy-opentelemetry-collector/).

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
(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`)
-->
# Example: features/integrations/cert-manager/values.yaml
# Integration: cert-manager

This example demonstrates how to gather metrics from [cert-manager](https://cert-manager.io/).

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
(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`)
-->
# Example: features/integrations/etcd/values.yaml
# Integration: etcd

This example demonstrates how to gather metrics from [etcd](https://etcd.io/).

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
(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`)
-->
# Example: features/integrations/loki/values.yaml
# Integration: Loki

This example demonstrates how to gather metrics and logs from [Grafana Loki](https://grafana.com/oss/loki/).

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
(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`)
-->
# MySQL Integration
# Integration: Loki

This example shows how to load two MySQL integration instances, which utilize Alloy's [prometheus.exporter.mysql](https://grafana.com/docs/alloy/latest/reference/components/prometheus/prometheus.exporter.mysql/) component
to scrape metrics from the MySQL database. It also modifies the Pod Logs feature to add special log handling for MySQL
pods. The username and password for the `prod-db` example are stored in a Kubernetes secret.
This example demonstrates how to gather metrics and logs from [MySQL](https://www.mysql.com/).

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
(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`)
-->
# Example: features/node-logs/default/values.yaml
# Node Logs

This example demonstrates how to gather logs from the Nodes in your Kubernetes cluster.

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
(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`)
-->
# Example: features/pod-logs/default/values.yaml
# Pod Logs

This example demonstrates how to gather logs from the Pods in your Kubernetes cluster.

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
(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`)
-->
# Example: features/profiling/default/values.yaml
# Profiling

This example demonstrates how to enable the Profiling feature to gather profiles from your Kubernetes cluster and
deliver them to Pyroscope.

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
(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`)
-->
# Example: features/prometheus-operator-objects/default/values.yaml
# Prometheus Operator Objects

This example demonstrates how to enable the Prometheus Operator Objects feature to discover and gather metrics from
PodMonitors, ServiceMonitors, and Probes in your Kubernetes cluster.

## Values

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

53 changes: 4 additions & 49 deletions charts/k8s-monitoring/docs/examples/meta-monitoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,39 +25,20 @@ integrations:
instances:
# monitor the collector gathering and sending meta-monitoring metrics/logs to the meta-monitoring cluster
- name: alloy-singleton
namespaces:
- logs
# monitor the collectors gathering and sending metrics/logs to the local cluster
- name: alloy-metrics
namespaces:
- collectors
- name: alloy-logs
namespaces:
- collectors
- name: alloy-profiles
namespaces:
- collectors
- name: alloy-receiver
namespaces:
- collectors
- name: alloy-singleton
namespaces:
- collectors
namespaces: [logs]
loki:
instances:
- name: loki
labelSelectors:
app.kubernetes.io/name: loki
logs:
enabled: true
namespaces:
- logs
namespaces: [logs]

clusterEvents:
enabled: true
collector: alloy-singleton
namespaces:
- logs
namespaces: [logs]

clusterMetrics:
enabled: true
Expand All @@ -74,16 +55,6 @@ clusterMetrics:
source_labels = ["namespace"]
regex = "logs"
}
apiServer:
enabled: false
kubeControllerManager:
enabled: false
kubeDNS:
enabled: false
kubeProxy:
enabled: false
kubeScheduler:
enabled: false
kube-state-metrics:
enabled: true
namespaces:
Expand All @@ -107,29 +78,13 @@ clusterMetrics:
enabled: false
deploy: false

nodeLogs:
enabled: false

podLogs:
enabled: true
gatherMethod: kubernetesApi
collector: alloy-singleton
namespaces:
- logs
namespaces: [logs]

# Collectors
alloy-singleton:
enabled: true

alloy-metrics:
enabled: false

alloy-logs:
enabled: false

alloy-profiles:
enabled: false

alloy-receiver:
enabled: false
```
Empty file.
Empty file.
Empty file.
Empty file.
Loading
Loading