materialize-monitoring Helm Reference#

Unified observability stack for Materialize: Alloy-based pipeline, optional bundled backends (Loki / Thanos / Grafana / Alertmanager), and the dashboards / alerts / rules that consume the Materialize metrics surface.

Source Code#

• https://github.com/MaterializeInc/materialize-monitoring/tree/main/charts/materialize-monitoring

Requirements#

Kubernetes: >=1.27.0-0

Storage Requirements#

Using Thanos or Loki (in the default bundled-stack profile) requires object storage (such as an AWS S3 bucket) for long-term storage.

In development, Thanos may use a PVC for less-reliable storage. Loki however will not run without object storage. You may consider Garage or RustFS or MinIO for manually provisioned object storage.

Included Subcharts#

Values#

Globals#

Values that are passed to all subcharts

[]

Main chart configuration#

Configuration for the main chart

Subchart enablement (Helm tags)#

Group toggles for subchart enablement. Subchart enablement has two layers, in precedence order:

1. Per-chart circuit breaker (<chart>.enabled). Each subchart dependency carries a condition: <chart>.enabled in Chart.yaml. The corresponding enabled: key is left commented-out under each subchart block in values.yaml; uncommenting it force-includes (true) or force-excludes (false) that chart regardless of any tag state. Helm evaluates condition: first and only falls through to tags when the path is absent from values, so this is a hard override.
2. Helm tags (the tags: block). When no <chart>.enabled is set, enablement is decided by tags. Each dependency in Chart.yaml carries a group tag (e.g. bundled-backends) and a per-chart tag (e.g. loki); a dependency is included if any of its tags evaluates true (OR semantics). To opt one chart out of an otherwise-enabled group, set the group tag false and flip the per-chart tags individually — or use the circuit breaker.

Group ↔ chart mapping:

The tag defaults match profile=bundled-stack. Other profiles flip bundled-backends off and the pipeline exporters appropriately; see the profile preset values files under examples/.

Materialize Integration#

Materialize-specific configuration values.

[]

[
  "/metrics/public"
]

Pipeline configuration#

Pipeline configuration values that drive Alloy behavior and defaults.

The Alloy pipeline is the flagship deliverable of this chart. Pipeline configuration is expressed in values, rendered into ConfigMaps under templates/pipelines/, and consumed by the Alloy agent and gateway release instances.

Cardinality reduction configuration#

Configuration for cardinality reduction in Alloy gateway

[
  "pod",
  "node",
  "zone",
  "region"
]

Exporter configuration#

Configuration for exporters attached to the Alloy gateway

{}

{}

Monitoring configurations#

Configuration for dashboards, rules, and alerts

Underlying content is generated into pre-rendered/ from the sources under packages/ and embedded via .Files.Get.

{}

[
  "env-*"
]

Rule configuration#

Configuration for rules

Alert configuration#

Configuration for alerts

Scraper configuration#

Configuration for scrapers

Grafana connection configuration#

How to talk to a grafana instance

{}

{}

{}

{}

Bundled subchart configurations#

Configuration for bundled subcharts

Alloy Agent#

Alloy collector instance running close to scrape targets. Pre-egress shaping happens here.

Alloy Gateway#

Alloy gateway instance. Cardinality reduction and backend-specific egress happen here.

Loki#

Bundled Loki backend for logs.

Thanos#

Bundled Thanos backend for long-term metrics.

{
  "enabled": true
}

{
  "enabled": true,
  "mode": "standalone"
}

{
  "enabled": true
}

{
  "resolution1h": "365d",
  "resolution5m": "90d",
  "resolutionRaw": "30d"
}

{
  "enabled": false
}

{
  "enabled": false
}

Grafana Operator#

Bundled Grafana-operator for managing Grafana instances.

Upstream references:

• https://grafana.github.io/grafana-operator/docs/installation/helm/#values
• https://github.com/grafana/grafana-operator/blob/master/deploy/helm/grafana-operator/values.yaml

{
  "immutable": false
}

Grafana Instance#

Bundled Grafana for dashboard rendering.

Upstream reference:

• https://github.com/grafana-community/helm-charts/blob/main/charts/grafana/values.yaml

Alertmanager#

Bundled Alertmanager for routing alerts emitted by the rule packages.

Kube State Metrics#

kube-state-metrics for Kubernetes resource-state metrics consumed by Materialize-adjacent dashboards.

Metrics Server#

metrics-server for pod and node resource usage; only needed when the cluster does not already ship one.