podMonitor

podMonitor objects to be generated by the chart. Additional PodMonitors can be added by adding a dictionary key similar to the ‘main’ PodMonitor.

Type

object

Usage

Keys are identifiers for podMonitor instances.

podMonitor:
  main:
    enabled: true
    # ... configuration

  secondary:
    enabled: true
    # ... configuration

Instance Properties

Available properties:

Property	Type	Required	Default	Description
annotations	object / null	No	-	Annotations to set on the item.
controller	object	No	-	Controller whose pods to monitor.
enabled	boolean	No	true	Set to false to disable the PodMonitor.
forceRename	string	No	-	Override the default resource name. Mutually exclusive wi…
jobLabel	string	No	app.kubernetes.io/name	The label to use to retrieve the job name from the target…
labels	object / null	No	-	Labels to set on the item.
podMetricsEndpoints	array	No	-	Pod metrics endpoints allowed as part of this PodMonitor…
podTargetLabels	array	No	-	Transfers labels from the Kubernetes Pod onto the created…
prefix	string	No	“	Prefix to prepend to the resource name. Mutually exclusiv…
selector	object	No	-	Selector to select Pod objects.
suffix	string	No	-	Suffix to append to the resource name. Defaults to the re…

Property Details

forceRename

Override the default resource name. Mutually exclusive with prefix and suffix.

jobLabel

The label to use to retrieve the job name from the target pod’s metadata. Defaults to ‘app.kubernetes.io/name’. Helm templates can be used.

podMetricsEndpoints

Pod metrics endpoints allowed as part of this PodMonitor. Typical fields per endpoint include port, scheme, path, interval, scrapeTimeout. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#podmetricsendpoint for the full schema.

podTargetLabels

Transfers labels from the Kubernetes Pod onto the created metrics. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#podmonitorspec for details.

prefix

Prefix to prepend to the resource name. Mutually exclusive with forceRename.

suffix

Suffix to append to the resource name. Defaults to the resource identifier if there are multiple items, otherwise empty. Mutually exclusive with forceRename.

Related Pages

• controller
• selector