Class CommonPrometheusFields

    • Method Detail

      • getAdditionalArgs

        public List<Argument> getAdditionalArgs()
        additionalArgs allows setting additional arguments for the 'prometheus' container.


        It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the Prometheus container which may cause issues if they are invalid or not supported by the given Prometheus version.


        In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument, the reconciliation will fail and an error will be logged.

      • setAdditionalArgs

        public void setAdditionalArgs​(List<Argument> additionalArgs)
        additionalArgs allows setting additional arguments for the 'prometheus' container.


        It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the Prometheus container which may cause issues if they are invalid or not supported by the given Prometheus version.


        In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument, the reconciliation will fail and an error will be logged.

      • getAdditionalScrapeConfigs

        public SecretKeySelector getAdditionalScrapeConfigs()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setAdditionalScrapeConfigs

        public void setAdditionalScrapeConfigs​(SecretKeySelector additionalScrapeConfigs)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getAffinity

        public Affinity getAffinity()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setAffinity

        public void setAffinity​(Affinity affinity)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getApiserverConfig

        public APIServerConfig getApiserverConfig()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setApiserverConfig

        public void setApiserverConfig​(APIServerConfig apiserverConfig)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getArbitraryFSAccessThroughSMs

        public ArbitraryFSAccessThroughSMsConfig getArbitraryFSAccessThroughSMs()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setArbitraryFSAccessThroughSMs

        public void setArbitraryFSAccessThroughSMs​(ArbitraryFSAccessThroughSMsConfig arbitraryFSAccessThroughSMs)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getAutomountServiceAccountToken

        public Boolean getAutomountServiceAccountToken()
        automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod. If the field isn't set, the operator mounts the service account token by default.


        **Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery. It is possible to use strategic merge patch to project the service account token into the 'prometheus' container.

      • setAutomountServiceAccountToken

        public void setAutomountServiceAccountToken​(Boolean automountServiceAccountToken)
        automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod. If the field isn't set, the operator mounts the service account token by default.


        **Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery. It is possible to use strategic merge patch to project the service account token into the 'prometheus' container.

      • getBodySizeLimit

        public String getBodySizeLimit()
        bodySizeLimit defines per-scrape on response body size. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit.

      • setBodySizeLimit

        public void setBodySizeLimit​(String bodySizeLimit)
        bodySizeLimit defines per-scrape on response body size. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit.

      • getConfigMaps

        public List<String> getConfigMaps()
        configMaps defines a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each ConfigMap is added to the StatefulSet definition as a volume named `configmap-<configmap-name>`. The ConfigMaps are mounted into /etc/prometheus/configmaps/<configmap-name> in the 'prometheus' container.
      • setConfigMaps

        public void setConfigMaps​(List<String> configMaps)
        configMaps defines a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each ConfigMap is added to the StatefulSet definition as a volume named `configmap-<configmap-name>`. The ConfigMaps are mounted into /etc/prometheus/configmaps/<configmap-name> in the 'prometheus' container.
      • getContainers

        public List<Container> getContainers()
        containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to the Pods or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch.


        The names of containers managed by the operator are: * `prometheus` * `config-reloader` * `thanos-sidecar`


        Overriding containers which are managed by the operator require careful testing, especially when upgrading to a new version of the operator.

      • setContainers

        public void setContainers​(List<Container> containers)
        containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to the Pods or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch.


        The names of containers managed by the operator are: * `prometheus` * `config-reloader` * `thanos-sidecar`


        Overriding containers which are managed by the operator require careful testing, especially when upgrading to a new version of the operator.

      • getConvertClassicHistogramsToNHCB

        public Boolean getConvertClassicHistogramsToNHCB()
        convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets.


        It requires Prometheus >= v3.4.0.

      • setConvertClassicHistogramsToNHCB

        public void setConvertClassicHistogramsToNHCB​(Boolean convertClassicHistogramsToNHCB)
        convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets.


        It requires Prometheus >= v3.4.0.

      • getDnsConfig

        public PodDNSConfig getDnsConfig()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setDnsConfig

        public void setDnsConfig​(PodDNSConfig dnsConfig)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getDnsPolicy

        public String getDnsPolicy()
        dnsPolicy defines the DNS policy for the pods.
      • setDnsPolicy

        public void setDnsPolicy​(String dnsPolicy)
        dnsPolicy defines the DNS policy for the pods.
      • getEnableFeatures

        public List<String> getEnableFeatures()
        enableFeatures enables access to Prometheus feature flags. By default, no features are enabled.


        Enabling features which are disabled by default is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.


        For more information see https://prometheus.io/docs/prometheus/latest/feature_flags/

      • setEnableFeatures

        public void setEnableFeatures​(List<String> enableFeatures)
        enableFeatures enables access to Prometheus feature flags. By default, no features are enabled.


        Enabling features which are disabled by default is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.


        For more information see https://prometheus.io/docs/prometheus/latest/feature_flags/

      • getEnableOTLPReceiver

        public Boolean getEnableOTLPReceiver()
        enableOTLPReceiver defines the Prometheus to be used as a receiver for the OTLP Metrics protocol.


        Note that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined.


        It requires Prometheus >= v2.47.0.

      • setEnableOTLPReceiver

        public void setEnableOTLPReceiver​(Boolean enableOTLPReceiver)
        enableOTLPReceiver defines the Prometheus to be used as a receiver for the OTLP Metrics protocol.


        Note that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined.


        It requires Prometheus >= v2.47.0.

      • getEnableRemoteWriteReceiver

        public Boolean getEnableRemoteWriteReceiver()
        enableRemoteWriteReceiver defines the Prometheus to be used as a receiver for the Prometheus remote write protocol.


        WARNING: This is not considered an efficient way of ingesting samples. Use it with caution for specific low-volume use cases. It is not suitable for replacing the ingestion via scraping and turning Prometheus into a push-based metrics collection system. For more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver


        It requires Prometheus >= v2.33.0.

      • setEnableRemoteWriteReceiver

        public void setEnableRemoteWriteReceiver​(Boolean enableRemoteWriteReceiver)
        enableRemoteWriteReceiver defines the Prometheus to be used as a receiver for the Prometheus remote write protocol.


        WARNING: This is not considered an efficient way of ingesting samples. Use it with caution for specific low-volume use cases. It is not suitable for replacing the ingestion via scraping and turning Prometheus into a push-based metrics collection system. For more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver


        It requires Prometheus >= v2.33.0.

      • getEnableServiceLinks

        public Boolean getEnableServiceLinks()
        enableServiceLinks defines whether information about services should be injected into pod's environment variables
      • setEnableServiceLinks

        public void setEnableServiceLinks​(Boolean enableServiceLinks)
        enableServiceLinks defines whether information about services should be injected into pod's environment variables
      • getEnforcedBodySizeLimit

        public String getEnforcedBodySizeLimit()
        enforcedBodySizeLimit when defined specifies a global limit on the size of uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail.


        It requires Prometheus >= v2.28.0.


        When both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.

        * Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value. * Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit.

      • setEnforcedBodySizeLimit

        public void setEnforcedBodySizeLimit​(String enforcedBodySizeLimit)
        enforcedBodySizeLimit when defined specifies a global limit on the size of uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail.


        It requires Prometheus >= v2.28.0.


        When both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.

        * Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value. * Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit.

      • getEnforcedKeepDroppedTargets

        public Long getEnforcedKeepDroppedTargets()
        enforcedKeepDroppedTargets when defined specifies a global limit on the number of targets dropped by relabeling that will be kept in memory. The value overrides any `spec.keepDroppedTargets` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is greater than zero and less than `spec.enforcedKeepDroppedTargets`.


        It requires Prometheus >= v2.47.0.


        When both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply: * Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.

        * Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value. * Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets.

      • setEnforcedKeepDroppedTargets

        public void setEnforcedKeepDroppedTargets​(Long enforcedKeepDroppedTargets)
        enforcedKeepDroppedTargets when defined specifies a global limit on the number of targets dropped by relabeling that will be kept in memory. The value overrides any `spec.keepDroppedTargets` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is greater than zero and less than `spec.enforcedKeepDroppedTargets`.


        It requires Prometheus >= v2.47.0.


        When both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply: * Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.

        * Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value. * Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets.

      • getEnforcedLabelLimit

        public Long getEnforcedLabelLimit()
        enforcedLabelLimit when defined specifies a global limit on the number of labels per sample. The value overrides any `spec.labelLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is greater than zero and less than `spec.enforcedLabelLimit`.


        It requires Prometheus >= v2.27.0.


        When both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.

        * Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value. * Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit.

      • setEnforcedLabelLimit

        public void setEnforcedLabelLimit​(Long enforcedLabelLimit)
        enforcedLabelLimit when defined specifies a global limit on the number of labels per sample. The value overrides any `spec.labelLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is greater than zero and less than `spec.enforcedLabelLimit`.


        It requires Prometheus >= v2.27.0.


        When both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.

        * Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value. * Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit.

      • getEnforcedLabelNameLengthLimit

        public Long getEnforcedLabelNameLengthLimit()
        enforcedLabelNameLengthLimit when defined specifies a global limit on the length of labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is greater than zero and less than `spec.enforcedLabelNameLengthLimit`.


        It requires Prometheus >= v2.27.0.


        When both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.

        * Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value. * Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit.

      • setEnforcedLabelNameLengthLimit

        public void setEnforcedLabelNameLengthLimit​(Long enforcedLabelNameLengthLimit)
        enforcedLabelNameLengthLimit when defined specifies a global limit on the length of labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is greater than zero and less than `spec.enforcedLabelNameLengthLimit`.


        It requires Prometheus >= v2.27.0.


        When both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.

        * Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value. * Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit.

      • getEnforcedLabelValueLengthLimit

        public Long getEnforcedLabelValueLengthLimit()
        enforcedLabelValueLengthLimit when not null defines a global limit on the length of labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is greater than zero and less than `spec.enforcedLabelValueLengthLimit`.


        It requires Prometheus >= v2.27.0.


        When both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.

        * Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value. * Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit.

      • setEnforcedLabelValueLengthLimit

        public void setEnforcedLabelValueLengthLimit​(Long enforcedLabelValueLengthLimit)
        enforcedLabelValueLengthLimit when not null defines a global limit on the length of labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is greater than zero and less than `spec.enforcedLabelValueLengthLimit`.


        It requires Prometheus >= v2.27.0.


        When both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.

        * Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value. * Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit.

      • getEnforcedNamespaceLabel

        public String getEnforcedNamespaceLabel()
        enforcedNamespaceLabel when not empty, a label will be added to:


        1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects. 2. All metrics generated from recording rules defined in `PrometheusRule` objects. 3. All alerts generated from alerting rules defined in `PrometheusRule` objects. 4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.


        The label will not added for objects referenced in `spec.excludedFromEnforcement`.


        The label's name is this field's value. The label's value is the namespace of the `ServiceMonitor`, `PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object.

      • setEnforcedNamespaceLabel

        public void setEnforcedNamespaceLabel​(String enforcedNamespaceLabel)
        enforcedNamespaceLabel when not empty, a label will be added to:


        1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects. 2. All metrics generated from recording rules defined in `PrometheusRule` objects. 3. All alerts generated from alerting rules defined in `PrometheusRule` objects. 4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.


        The label will not added for objects referenced in `spec.excludedFromEnforcement`.


        The label's name is this field's value. The label's value is the namespace of the `ServiceMonitor`, `PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object.

      • getEnforcedSampleLimit

        public Long getEnforcedSampleLimit()
        enforcedSampleLimit when defined specifies a global limit on the number of scraped samples that will be accepted. This overrides any `spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.sampleLimit` is greater than zero and less than `spec.enforcedSampleLimit`.


        It is meant to be used by admins to keep the overall number of samples/series under a desired limit.


        When both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.

        * Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value. * Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit.

      • setEnforcedSampleLimit

        public void setEnforcedSampleLimit​(Long enforcedSampleLimit)
        enforcedSampleLimit when defined specifies a global limit on the number of scraped samples that will be accepted. This overrides any `spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.sampleLimit` is greater than zero and less than `spec.enforcedSampleLimit`.


        It is meant to be used by admins to keep the overall number of samples/series under a desired limit.


        When both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.

        * Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value. * Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit.

      • getEnforcedTargetLimit

        public Long getEnforcedTargetLimit()
        enforcedTargetLimit when defined specifies a global limit on the number of scraped targets. The value overrides any `spec.targetLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is greater than zero and less than `spec.enforcedTargetLimit`.


        It is meant to be used by admins to to keep the overall number of targets under a desired limit.


        When both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.

        * Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value. * Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit.

      • setEnforcedTargetLimit

        public void setEnforcedTargetLimit​(Long enforcedTargetLimit)
        enforcedTargetLimit when defined specifies a global limit on the number of scraped targets. The value overrides any `spec.targetLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is greater than zero and less than `spec.enforcedTargetLimit`.


        It is meant to be used by admins to to keep the overall number of targets under a desired limit.


        When both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply: * Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0).

        If Prometheus version is >= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.

        * Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value. * Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit.

      • getExcludedFromEnforcement

        public List<ObjectReference> getExcludedFromEnforcement()
        excludedFromEnforcement defines the list of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects to be excluded from enforcing a namespace label of origin.


        It is only applicable if `spec.enforcedNamespaceLabel` set to true.

      • setExcludedFromEnforcement

        public void setExcludedFromEnforcement​(List<ObjectReference> excludedFromEnforcement)
        excludedFromEnforcement defines the list of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects to be excluded from enforcing a namespace label of origin.


        It is only applicable if `spec.enforcedNamespaceLabel` set to true.

      • getExternalLabels

        public Map<String,​String> getExternalLabels()
        externalLabels defines the labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager). Labels defined by `spec.replicaExternalLabelName` and `spec.prometheusExternalLabelName` take precedence over this list.
      • setExternalLabels

        public void setExternalLabels​(Map<String,​String> externalLabels)
        externalLabels defines the labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager). Labels defined by `spec.replicaExternalLabelName` and `spec.prometheusExternalLabelName` take precedence over this list.
      • getExternalUrl

        public String getExternalUrl()
        externalUrl defines the external URL under which the Prometheus service is externally available. This is necessary to generate correct URLs (for instance if Prometheus is accessible behind an Ingress resource).
      • setExternalUrl

        public void setExternalUrl​(String externalUrl)
        externalUrl defines the external URL under which the Prometheus service is externally available. This is necessary to generate correct URLs (for instance if Prometheus is accessible behind an Ingress resource).
      • getHostAliases

        public List<HostAlias> getHostAliases()
        hostAliases defines the optional list of hosts and IPs that will be injected into the Pod's hosts file if specified.
      • setHostAliases

        public void setHostAliases​(List<HostAlias> hostAliases)
        hostAliases defines the optional list of hosts and IPs that will be injected into the Pod's hosts file if specified.
      • getHostNetwork

        public Boolean getHostNetwork()
        hostNetwork defines the host's network namespace if true.


        Make sure to understand the security implications if you want to enable it (https://kubernetes.io/docs/concepts/configuration/overview/ ).


        When hostNetwork is enabled, this will set the DNS policy to `ClusterFirstWithHostNet` automatically (unless `.spec.DNSPolicy` is set to a different value).

      • setHostNetwork

        public void setHostNetwork​(Boolean hostNetwork)
        hostNetwork defines the host's network namespace if true.


        Make sure to understand the security implications if you want to enable it (https://kubernetes.io/docs/concepts/configuration/overview/ ).


        When hostNetwork is enabled, this will set the DNS policy to `ClusterFirstWithHostNet` automatically (unless `.spec.DNSPolicy` is set to a different value).

      • getHostUsers

        public Boolean getHostUsers()
        hostUsers supports the user space in Kubernetes.


        More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/


        The feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled. Starting Kubernetes 1.33, the feature is enabled by default.

      • setHostUsers

        public void setHostUsers​(Boolean hostUsers)
        hostUsers supports the user space in Kubernetes.


        More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/


        The feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled. Starting Kubernetes 1.33, the feature is enabled by default.

      • getIgnoreNamespaceSelectors

        public Boolean getIgnoreNamespaceSelectors()
        ignoreNamespaceSelectors when true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor and Probe objects will be ignored. They will only discover targets within the namespace of the PodMonitor, ServiceMonitor and Probe object.
      • setIgnoreNamespaceSelectors

        public void setIgnoreNamespaceSelectors​(Boolean ignoreNamespaceSelectors)
        ignoreNamespaceSelectors when true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor and Probe objects will be ignored. They will only discover targets within the namespace of the PodMonitor, ServiceMonitor and Probe object.
      • getImage

        public String getImage()
        image defines the container image name for Prometheus. If specified, it takes precedence over the `spec.baseImage`, `spec.tag` and `spec.sha` fields.


        Specifying `spec.version` is still necessary to ensure the Prometheus Operator knows which version of Prometheus is being configured.


        If neither `spec.image` nor `spec.baseImage` are defined, the operator will use the latest upstream version of Prometheus available at the time when the operator was released.

      • setImage

        public void setImage​(String image)
        image defines the container image name for Prometheus. If specified, it takes precedence over the `spec.baseImage`, `spec.tag` and `spec.sha` fields.


        Specifying `spec.version` is still necessary to ensure the Prometheus Operator knows which version of Prometheus is being configured.


        If neither `spec.image` nor `spec.baseImage` are defined, the operator will use the latest upstream version of Prometheus available at the time when the operator was released.

      • getImagePullPolicy

        public String getImagePullPolicy()
        imagePullPolicy defines the image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.


        Possible enum values:

        - `"Always"` means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.

        - `"IfNotPresent"` means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.

        - `"Never"` means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present

      • setImagePullPolicy

        public void setImagePullPolicy​(String imagePullPolicy)
        imagePullPolicy defines the image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.


        Possible enum values:

        - `"Always"` means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.

        - `"IfNotPresent"` means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.

        - `"Never"` means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present

      • getImagePullSecrets

        public List<LocalObjectReference> getImagePullSecrets()
        imagePullSecrets defines an optional list of references to Secrets in the same namespace to use for pulling images from registries. See http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
      • setImagePullSecrets

        public void setImagePullSecrets​(List<LocalObjectReference> imagePullSecrets)
        imagePullSecrets defines an optional list of references to Secrets in the same namespace to use for pulling images from registries. See http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
      • getInitContainers

        public List<Container> getInitContainers()
        initContainers allows injecting initContainers to the Pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator generated init containers if they share the same name and modifications are done via a strategic merge patch.


        The names of init container name managed by the operator are: * `init-config-reloader`.


        Overriding init containers which are managed by the operator require careful testing, especially when upgrading to a new version of the operator.

      • setInitContainers

        public void setInitContainers​(List<Container> initContainers)
        initContainers allows injecting initContainers to the Pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator generated init containers if they share the same name and modifications are done via a strategic merge patch.


        The names of init container name managed by the operator are: * `init-config-reloader`.


        Overriding init containers which are managed by the operator require careful testing, especially when upgrading to a new version of the operator.

      • getKeepDroppedTargets

        public Long getKeepDroppedTargets()
        keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.


        It requires Prometheus >= v2.47.0.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets.

      • setKeepDroppedTargets

        public void setKeepDroppedTargets​(Long keepDroppedTargets)
        keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.


        It requires Prometheus >= v2.47.0.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets.

      • getLabelLimit

        public Long getLabelLimit()
        labelLimit defines per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit.

      • setLabelLimit

        public void setLabelLimit​(Long labelLimit)
        labelLimit defines per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit.

      • getLabelNameLengthLimit

        public Long getLabelNameLengthLimit()
        labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit.

      • setLabelNameLengthLimit

        public void setLabelNameLengthLimit​(Long labelNameLengthLimit)
        labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit.

      • getLabelValueLengthLimit

        public Long getLabelValueLengthLimit()
        labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit.

      • setLabelValueLengthLimit

        public void setLabelValueLengthLimit​(Long labelValueLengthLimit)
        labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit.

      • getListenLocal

        public Boolean getListenLocal()
        listenLocal when true, the Prometheus server listens on the loopback address instead of the Pod IP's address.
      • setListenLocal

        public void setListenLocal​(Boolean listenLocal)
        listenLocal when true, the Prometheus server listens on the loopback address instead of the Pod IP's address.
      • getLogFormat

        public String getLogFormat()
        logFormat for Log level for Prometheus and the config-reloader sidecar.
      • setLogFormat

        public void setLogFormat​(String logFormat)
        logFormat for Log level for Prometheus and the config-reloader sidecar.
      • getLogLevel

        public String getLogLevel()
        logLevel for Prometheus and the config-reloader sidecar.
      • setLogLevel

        public void setLogLevel​(String logLevel)
        logLevel for Prometheus and the config-reloader sidecar.
      • getMaximumStartupDurationSeconds

        public Integer getMaximumStartupDurationSeconds()
        maximumStartupDurationSeconds defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. If set, the value should be greater than 60 (seconds). Otherwise it will be equal to 900 seconds (15 minutes).
      • setMaximumStartupDurationSeconds

        public void setMaximumStartupDurationSeconds​(Integer maximumStartupDurationSeconds)
        maximumStartupDurationSeconds defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. If set, the value should be greater than 60 (seconds). Otherwise it will be equal to 900 seconds (15 minutes).
      • getMinReadySeconds

        public Integer getMinReadySeconds()
        minReadySeconds defines the minimum number of seconds for which a newly created Pod should be ready without any of its container crashing for it to be considered available.


        If unset, pods will be considered available as soon as they are ready.

      • setMinReadySeconds

        public void setMinReadySeconds​(Integer minReadySeconds)
        minReadySeconds defines the minimum number of seconds for which a newly created Pod should be ready without any of its container crashing for it to be considered available.


        If unset, pods will be considered available as soon as they are ready.

      • getNameEscapingScheme

        public String getNameEscapingScheme()
        nameEscapingScheme defines the character escaping scheme that will be requested when scraping for metric and label names that do not conform to the legacy Prometheus character set.


        It requires Prometheus >= v3.4.0.

      • setNameEscapingScheme

        public void setNameEscapingScheme​(String nameEscapingScheme)
        nameEscapingScheme defines the character escaping scheme that will be requested when scraping for metric and label names that do not conform to the legacy Prometheus character set.


        It requires Prometheus >= v3.4.0.

      • getNameValidationScheme

        public String getNameValidationScheme()
        nameValidationScheme defines the validation scheme for metric and label names.


        It requires Prometheus >= v2.55.0.

      • setNameValidationScheme

        public void setNameValidationScheme​(String nameValidationScheme)
        nameValidationScheme defines the validation scheme for metric and label names.


        It requires Prometheus >= v2.55.0.

      • getNodeSelector

        public Map<String,​String> getNodeSelector()
        nodeSelector defines on which Nodes the Pods are scheduled.
      • setNodeSelector

        public void setNodeSelector​(Map<String,​String> nodeSelector)
        nodeSelector defines on which Nodes the Pods are scheduled.
      • getOtlp

        public OTLPConfig getOtlp()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setOtlp

        public void setOtlp​(OTLPConfig otlp)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getOverrideHonorLabels

        public Boolean getOverrideHonorLabels()
        overrideHonorLabels when true, Prometheus resolves label conflicts by renaming the labels in the scraped data

        to "exported_" for all targets created from ServiceMonitor, PodMonitor and

        ScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies. In practice,`OverrideHonorLabels:true` enforces `honorLabels:false` for all ServiceMonitor, PodMonitor and ScrapeConfig objects.

      • setOverrideHonorLabels

        public void setOverrideHonorLabels​(Boolean overrideHonorLabels)
        overrideHonorLabels when true, Prometheus resolves label conflicts by renaming the labels in the scraped data

        to "exported_" for all targets created from ServiceMonitor, PodMonitor and

        ScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies. In practice,`OverrideHonorLabels:true` enforces `honorLabels:false` for all ServiceMonitor, PodMonitor and ScrapeConfig objects.

      • getOverrideHonorTimestamps

        public Boolean getOverrideHonorTimestamps()
        overrideHonorTimestamps when true, Prometheus ignores the timestamps for all the targets created from service and pod monitors. Otherwise the HonorTimestamps field of the service or pod monitor applies.
      • setOverrideHonorTimestamps

        public void setOverrideHonorTimestamps​(Boolean overrideHonorTimestamps)
        overrideHonorTimestamps when true, Prometheus ignores the timestamps for all the targets created from service and pod monitors. Otherwise the HonorTimestamps field of the service or pod monitor applies.
      • getPaused

        public Boolean getPaused()
        paused defines when a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects.
      • setPaused

        public void setPaused​(Boolean paused)
        paused defines when a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects.
      • getPersistentVolumeClaimRetentionPolicy

        public io.fabric8.kubernetes.api.model.apps.StatefulSetPersistentVolumeClaimRetentionPolicy getPersistentVolumeClaimRetentionPolicy()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setPersistentVolumeClaimRetentionPolicy

        public void setPersistentVolumeClaimRetentionPolicy​(io.fabric8.kubernetes.api.model.apps.StatefulSetPersistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getPodManagementPolicy

        public String getPodManagementPolicy()
        podManagementPolicy defines the policy for creating/deleting pods when scaling up and down.


        Unlike the default StatefulSet behavior, the default policy is `Parallel` to avoid manual intervention in case a pod gets stuck during a rollout.


        Note that updating this value implies the recreation of the StatefulSet which incurs a service outage.

      • setPodManagementPolicy

        public void setPodManagementPolicy​(String podManagementPolicy)
        podManagementPolicy defines the policy for creating/deleting pods when scaling up and down.


        Unlike the default StatefulSet behavior, the default policy is `Parallel` to avoid manual intervention in case a pod gets stuck during a rollout.


        Note that updating this value implies the recreation of the StatefulSet which incurs a service outage.

      • getPodMetadata

        public EmbeddedObjectMetadata getPodMetadata()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setPodMetadata

        public void setPodMetadata​(EmbeddedObjectMetadata podMetadata)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getPodMonitorNamespaceSelector

        public LabelSelector getPodMonitorNamespaceSelector()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setPodMonitorNamespaceSelector

        public void setPodMonitorNamespaceSelector​(LabelSelector podMonitorNamespaceSelector)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getPodMonitorSelector

        public LabelSelector getPodMonitorSelector()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setPodMonitorSelector

        public void setPodMonitorSelector​(LabelSelector podMonitorSelector)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getPodTargetLabels

        public List<String> getPodTargetLabels()
        podTargetLabels are appended to the `spec.podTargetLabels` field of all PodMonitor and ServiceMonitor objects.
      • setPodTargetLabels

        public void setPodTargetLabels​(List<String> podTargetLabels)
        podTargetLabels are appended to the `spec.podTargetLabels` field of all PodMonitor and ServiceMonitor objects.
      • getPortName

        public String getPortName()
        portName used for the pods and governing service. Default: "web"
      • setPortName

        public void setPortName​(String portName)
        portName used for the pods and governing service. Default: "web"
      • getPriorityClassName

        public String getPriorityClassName()
        priorityClassName assigned to the Pods.
      • setPriorityClassName

        public void setPriorityClassName​(String priorityClassName)
        priorityClassName assigned to the Pods.
      • getProbeNamespaceSelector

        public LabelSelector getProbeNamespaceSelector()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setProbeNamespaceSelector

        public void setProbeNamespaceSelector​(LabelSelector probeNamespaceSelector)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getProbeSelector

        public LabelSelector getProbeSelector()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setProbeSelector

        public void setProbeSelector​(LabelSelector probeSelector)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getPrometheusExternalLabelName

        public String getPrometheusExternalLabelName()
        prometheusExternalLabelName defines the name of Prometheus external label used to denote the Prometheus instance name. The external label will _not_ be added when the field is set to the empty string (`""`).


        Default: "prometheus"

      • setPrometheusExternalLabelName

        public void setPrometheusExternalLabelName​(String prometheusExternalLabelName)
        prometheusExternalLabelName defines the name of Prometheus external label used to denote the Prometheus instance name. The external label will _not_ be added when the field is set to the empty string (`""`).


        Default: "prometheus"

      • getReloadStrategy

        public String getReloadStrategy()
        reloadStrategy defines the strategy used to reload the Prometheus configuration. If not specified, the configuration is reloaded using the /-/reload HTTP endpoint.
      • setReloadStrategy

        public void setReloadStrategy​(String reloadStrategy)
        reloadStrategy defines the strategy used to reload the Prometheus configuration. If not specified, the configuration is reloaded using the /-/reload HTTP endpoint.
      • getRemoteWrite

        public List<RemoteWriteSpec> getRemoteWrite()
        remoteWrite defines the list of remote write configurations.
      • setRemoteWrite

        public void setRemoteWrite​(List<RemoteWriteSpec> remoteWrite)
        remoteWrite defines the list of remote write configurations.
      • getRemoteWriteReceiverMessageVersions

        public List<String> getRemoteWriteReceiverMessageVersions()
        remoteWriteReceiverMessageVersions list of the protobuf message versions to accept when receiving the remote writes.


        It requires Prometheus >= v2.54.0.

      • setRemoteWriteReceiverMessageVersions

        public void setRemoteWriteReceiverMessageVersions​(List<String> remoteWriteReceiverMessageVersions)
        remoteWriteReceiverMessageVersions list of the protobuf message versions to accept when receiving the remote writes.


        It requires Prometheus >= v2.54.0.

      • getReplicaExternalLabelName

        public String getReplicaExternalLabelName()
        replicaExternalLabelName defines the name of Prometheus external label used to denote the replica name. The external label will _not_ be added when the field is set to the empty string (`""`).


        Default: "prometheus_replica"

      • setReplicaExternalLabelName

        public void setReplicaExternalLabelName​(String replicaExternalLabelName)
        replicaExternalLabelName defines the name of Prometheus external label used to denote the replica name. The external label will _not_ be added when the field is set to the empty string (`""`).


        Default: "prometheus_replica"

      • getReplicas

        public Integer getReplicas()
        replicas defines the number of replicas of each shard to deploy for a Prometheus deployment. `spec.replicas` multiplied by `spec.shards` is the total number of Pods created.


        Default: 1

      • setReplicas

        public void setReplicas​(Integer replicas)
        replicas defines the number of replicas of each shard to deploy for a Prometheus deployment. `spec.replicas` multiplied by `spec.shards` is the total number of Pods created.


        Default: 1

      • getResources

        public ResourceRequirements getResources()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setResources

        public void setResources​(ResourceRequirements resources)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getRoutePrefix

        public String getRoutePrefix()
        routePrefix defines the route prefix Prometheus registers HTTP handlers for.


        This is useful when using `spec.externalURL`, and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with `kubectl proxy`.

      • setRoutePrefix

        public void setRoutePrefix​(String routePrefix)
        routePrefix defines the route prefix Prometheus registers HTTP handlers for.


        This is useful when using `spec.externalURL`, and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with `kubectl proxy`.

      • getRuntime

        public RuntimeConfig getRuntime()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setRuntime

        public void setRuntime​(RuntimeConfig runtime)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getSampleLimit

        public Long getSampleLimit()
        sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit.

      • setSampleLimit

        public void setSampleLimit​(Long sampleLimit)
        sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit.

      • getSchedulerName

        public String getSchedulerName()
        schedulerName defines the scheduler to use for Pod scheduling. If not specified, the default scheduler is used.
      • setSchedulerName

        public void setSchedulerName​(String schedulerName)
        schedulerName defines the scheduler to use for Pod scheduling. If not specified, the default scheduler is used.
      • getScrapeClasses

        public List<ScrapeClass> getScrapeClasses()
        scrapeClasses defines the list of scrape classes to expose to scraping objects such as PodMonitors, ServiceMonitors, Probes and ScrapeConfigs.


        This is an *experimental feature*, it may change in any upcoming release in a breaking way.

      • setScrapeClasses

        public void setScrapeClasses​(List<ScrapeClass> scrapeClasses)
        scrapeClasses defines the list of scrape classes to expose to scraping objects such as PodMonitors, ServiceMonitors, Probes and ScrapeConfigs.


        This is an *experimental feature*, it may change in any upcoming release in a breaking way.

      • getScrapeClassicHistograms

        public Boolean getScrapeClassicHistograms()
        scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.


        Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.


        It requires Prometheus >= v3.5.0.

      • setScrapeClassicHistograms

        public void setScrapeClassicHistograms​(Boolean scrapeClassicHistograms)
        scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.


        Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.


        It requires Prometheus >= v3.5.0.

      • getScrapeConfigNamespaceSelector

        public LabelSelector getScrapeConfigNamespaceSelector()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setScrapeConfigNamespaceSelector

        public void setScrapeConfigNamespaceSelector​(LabelSelector scrapeConfigNamespaceSelector)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getScrapeConfigSelector

        public LabelSelector getScrapeConfigSelector()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setScrapeConfigSelector

        public void setScrapeConfigSelector​(LabelSelector scrapeConfigSelector)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getScrapeFailureLogFile

        public String getScrapeFailureLogFile()
        scrapeFailureLogFile defines the file to which scrape failures are logged. Reloading the configuration will reopen the file.


        If the filename has an empty path, e.g. 'file.log', The Prometheus Pods will mount the file into an emptyDir volume at `/var/log/prometheus`. If a full path is provided, e.g. '/var/log/prometheus/file.log', you must mount a volume in the specified directory and it must be writable. It requires Prometheus >= v2.55.0.

      • setScrapeFailureLogFile

        public void setScrapeFailureLogFile​(String scrapeFailureLogFile)
        scrapeFailureLogFile defines the file to which scrape failures are logged. Reloading the configuration will reopen the file.


        If the filename has an empty path, e.g. 'file.log', The Prometheus Pods will mount the file into an emptyDir volume at `/var/log/prometheus`. If a full path is provided, e.g. '/var/log/prometheus/file.log', you must mount a volume in the specified directory and it must be writable. It requires Prometheus >= v2.55.0.

      • getScrapeInterval

        public String getScrapeInterval()
        scrapeInterval defines interval between consecutive scrapes.


        Default: "30s"

      • setScrapeInterval

        public void setScrapeInterval​(String scrapeInterval)
        scrapeInterval defines interval between consecutive scrapes.


        Default: "30s"

      • getScrapeNativeHistograms

        public Boolean getScrapeNativeHistograms()
        scrapeNativeHistograms defines whether to enable scraping of native histograms. It requires Prometheus >= v3.8.0.
      • setScrapeNativeHistograms

        public void setScrapeNativeHistograms​(Boolean scrapeNativeHistograms)
        scrapeNativeHistograms defines whether to enable scraping of native histograms. It requires Prometheus >= v3.8.0.
      • getScrapeProtocols

        public List<String> getScrapeProtocols()
        scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred).


        If unset, Prometheus uses its default value.


        It requires Prometheus >= v2.49.0.


        `PrometheusText1.0.0` requires Prometheus >= v3.0.0.

      • setScrapeProtocols

        public void setScrapeProtocols​(List<String> scrapeProtocols)
        scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred).


        If unset, Prometheus uses its default value.


        It requires Prometheus >= v2.49.0.


        `PrometheusText1.0.0` requires Prometheus >= v3.0.0.

      • getScrapeTimeout

        public String getScrapeTimeout()
        scrapeTimeout defines the number of seconds to wait until a scrape request times out. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
      • setScrapeTimeout

        public void setScrapeTimeout​(String scrapeTimeout)
        scrapeTimeout defines the number of seconds to wait until a scrape request times out. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
      • getSecrets

        public List<String> getSecrets()
        secrets defines a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each Secret is added to the StatefulSet definition as a volume named `secret-<secret-name>`. The Secrets are mounted into /etc/prometheus/secrets/<secret-name> in the 'prometheus' container.
      • setSecrets

        public void setSecrets​(List<String> secrets)
        secrets defines a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each Secret is added to the StatefulSet definition as a volume named `secret-<secret-name>`. The Secrets are mounted into /etc/prometheus/secrets/<secret-name> in the 'prometheus' container.
      • getSecurityContext

        public PodSecurityContext getSecurityContext()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setSecurityContext

        public void setSecurityContext​(PodSecurityContext securityContext)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getServiceAccountName

        public String getServiceAccountName()
        serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.
      • setServiceAccountName

        public void setServiceAccountName​(String serviceAccountName)
        serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.
      • getServiceDiscoveryRole

        public String getServiceDiscoveryRole()
        serviceDiscoveryRole defines the service discovery role used to discover targets from `ServiceMonitor` objects and Alertmanager endpoints.


        If set, the value should be either "Endpoints" or "EndpointSlice". If unset, the operator assumes the "Endpoints" role.

      • setServiceDiscoveryRole

        public void setServiceDiscoveryRole​(String serviceDiscoveryRole)
        serviceDiscoveryRole defines the service discovery role used to discover targets from `ServiceMonitor` objects and Alertmanager endpoints.


        If set, the value should be either "Endpoints" or "EndpointSlice". If unset, the operator assumes the "Endpoints" role.

      • getServiceMonitorNamespaceSelector

        public LabelSelector getServiceMonitorNamespaceSelector()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setServiceMonitorNamespaceSelector

        public void setServiceMonitorNamespaceSelector​(LabelSelector serviceMonitorNamespaceSelector)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getServiceMonitorSelector

        public LabelSelector getServiceMonitorSelector()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setServiceMonitorSelector

        public void setServiceMonitorSelector​(LabelSelector serviceMonitorSelector)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getServiceName

        public String getServiceName()
        serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service. If defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels. If empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources, or `prometheus-agent-operated` for PrometheusAgent resources. When deploying multiple Prometheus/PrometheusAgent resources in the same namespace, it is recommended to specify a different value for each. See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.
      • setServiceName

        public void setServiceName​(String serviceName)
        serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service. If defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels. If empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources, or `prometheus-agent-operated` for PrometheusAgent resources. When deploying multiple Prometheus/PrometheusAgent resources in the same namespace, it is recommended to specify a different value for each. See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.
      • getShardingStrategy

        public ShardingStrategy getShardingStrategy()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setShardingStrategy

        public void setShardingStrategy​(ShardingStrategy shardingStrategy)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getShards

        public Integer getShards()
        shards defines the number of shards to distribute the scraped targets onto.


        `spec.replicas` multiplied by `spec.shards` is the total number of Pods being created.


        When not defined, the operator assumes only one shard.


        Note that scaling down shards will not reshard data onto the remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same instances. To query globally, use either * Thanos sidecar + querier for query federation and Thanos Ruler for rules. * Remote-write to send metrics to a central location.


        By default, the sharding of targets is performed on: * The `__address__` target's metadata label for PodMonitor, ServiceMonitor and ScrapeConfig resources. * The `__param_target__` label for Probe resources.


        Users can define their own sharding implementation by setting the `__tmp_hash` label during the target discovery with relabeling configuration (either in the monitoring resources or via scrape class).


        You can also disable sharding on a specific target by setting the `__tmp_disable_sharding` label with relabeling configuration. When the label value isn't empty, all Prometheus shards will scrape the target.

      • setShards

        public void setShards​(Integer shards)
        shards defines the number of shards to distribute the scraped targets onto.


        `spec.replicas` multiplied by `spec.shards` is the total number of Pods being created.


        When not defined, the operator assumes only one shard.


        Note that scaling down shards will not reshard data onto the remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same instances. To query globally, use either * Thanos sidecar + querier for query federation and Thanos Ruler for rules. * Remote-write to send metrics to a central location.


        By default, the sharding of targets is performed on: * The `__address__` target's metadata label for PodMonitor, ServiceMonitor and ScrapeConfig resources. * The `__param_target__` label for Probe resources.


        Users can define their own sharding implementation by setting the `__tmp_hash` label during the target discovery with relabeling configuration (either in the monitoring resources or via scrape class).


        You can also disable sharding on a specific target by setting the `__tmp_disable_sharding` label with relabeling configuration. When the label value isn't empty, all Prometheus shards will scrape the target.

      • getStorage

        public StorageSpec getStorage()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setStorage

        public void setStorage​(StorageSpec storage)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getTargetLimit

        public Long getTargetLimit()
        targetLimit defines a limit on the number of scraped targets that will be accepted. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit.

      • setTargetLimit

        public void setTargetLimit​(Long targetLimit)
        targetLimit defines a limit on the number of scraped targets that will be accepted. Only valid in Prometheus versions 2.45.0 and newer.


        Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit.

      • getTerminationGracePeriodSeconds

        public Long getTerminationGracePeriodSeconds()
        terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down) which may lead to data corruption.


        Defaults to 600 seconds.

      • setTerminationGracePeriodSeconds

        public void setTerminationGracePeriodSeconds​(Long terminationGracePeriodSeconds)
        terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down) which may lead to data corruption.


        Defaults to 600 seconds.

      • getTolerations

        public List<Toleration> getTolerations()
        tolerations defines the Pods' tolerations if specified.
      • setTolerations

        public void setTolerations​(List<Toleration> tolerations)
        tolerations defines the Pods' tolerations if specified.
      • getTopologySpreadConstraints

        public List<TopologySpreadConstraint> getTopologySpreadConstraints()
        topologySpreadConstraints defines the pod's topology spread constraints if specified.
      • setTopologySpreadConstraints

        public void setTopologySpreadConstraints​(List<TopologySpreadConstraint> topologySpreadConstraints)
        topologySpreadConstraints defines the pod's topology spread constraints if specified.
      • getTracingConfig

        public TracingConfig getTracingConfig()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setTracingConfig

        public void setTracingConfig​(TracingConfig tracingConfig)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getTsdb

        public TSDBSpec getTsdb()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setTsdb

        public void setTsdb​(TSDBSpec tsdb)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getUpdateStrategy

        public StatefulSetUpdateStrategy getUpdateStrategy()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setUpdateStrategy

        public void setUpdateStrategy​(StatefulSetUpdateStrategy updateStrategy)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getVersion

        public String getVersion()
        version of Prometheus being deployed. The operator uses this information to generate the Prometheus StatefulSet + configuration files.


        If not specified, the operator assumes the latest upstream version of Prometheus available at the time when the version of the operator was released.

      • setVersion

        public void setVersion​(String version)
        version of Prometheus being deployed. The operator uses this information to generate the Prometheus StatefulSet + configuration files.


        If not specified, the operator assumes the latest upstream version of Prometheus available at the time when the version of the operator was released.

      • getVolumeMounts

        public List<VolumeMount> getVolumeMounts()
        volumeMounts allows the configuration of additional VolumeMounts.


        VolumeMounts will be appended to other VolumeMounts in the 'prometheus' container, that are generated as a result of StorageSpec objects.

      • setVolumeMounts

        public void setVolumeMounts​(List<VolumeMount> volumeMounts)
        volumeMounts allows the configuration of additional VolumeMounts.


        VolumeMounts will be appended to other VolumeMounts in the 'prometheus' container, that are generated as a result of StorageSpec objects.

      • getVolumes

        public List<Volume> getVolumes()
        volumes allows the configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.
      • setVolumes

        public void setVolumes​(List<Volume> volumes)
        volumes allows the configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.
      • getWalCompression

        public Boolean getWalCompression()
        walCompression defines the compression of the write-ahead log (WAL) using Snappy.


        WAL compression is enabled by default for Prometheus >= 2.20.0


        Requires Prometheus v2.11.0 and above.

      • setWalCompression

        public void setWalCompression​(Boolean walCompression)
        walCompression defines the compression of the write-ahead log (WAL) using Snappy.


        WAL compression is enabled by default for Prometheus >= 2.20.0


        Requires Prometheus v2.11.0 and above.

      • getWeb

        public PrometheusWebSpec getWeb()
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • setWeb

        public void setWeb​(PrometheusWebSpec web)
        CommonPrometheusFields are the options available to both the Prometheus server and agent.
      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                          Object value)
      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)