CustomPrometheusRules

Scope: Cluster

Resource to store PrometheusRule. Details….

  • spec (object)

    Required value.

    • groups (array of objects)

      Alert group description.

      The structure of the groups is similar to that of prometheus-operator.

      Required value.

      • interval (string)
      • name (string)

        Required value.

      • rules (array of objects)

        Required value.

        • alert (string)
        • annotations (object)
        • expr (integer or string)

          Required value.

        • for (string)
        • labels (object)
        • record (string)

Resource to store PrometheusRule. Details….

  • spec (object)

    Required value.

    • groups (array of objects)

      Alert group description.

      The structure of the groups is similar to that of prometheus-operator.

      Required value.

      • interval (string)
      • name (string)

        Required value.

      • rules (array of objects)

        Required value.

        • alert (string)
        • annotations (object)
        • expr (integer or string)

          Required value.

        • for (string)
        • labels (object)
        • record (string)

GrafanaAdditionalDatasource

Scope: Cluster

The resource for connecting additional datasources to Grafana.

The resource parameters are described in details in the Grafana documentation.

  • spec (object)

    Required value.

    • access (string)

      Access mode.

      Allowed values: Proxy, Direct

      Required value.

    • basicAuth (boolean)

      Enable/disable basic auth.

    • basicAuthUser (string)

      Basic auth username.

    • database (string)

      Database name (if used).

    • jsonData (object)

      Fields to be converted to JSON and stored in jsonData.

    • secureJsonData (object)

      JSON-data object to be saved encrypted.

    • type (string)

      Datasource type.

      Required value.

    • url (string)

      Datasource URL.

      Example: "http://localhost:8080"

    • user (string)

      Database username.

    • withCredentials (boolean)

      Enable/disable with credentials headers

The resource for connecting additional datasources to Grafana.

The resource parameters are described in details in the Grafana documentation.

  • spec (object)

    Required value.

    • access (string)

      Access mode.

      Allowed values: proxy, direct

      Required value.

    • basicAuth (boolean)

      Enable/disable basic auth.

    • basicAuthUser (string)

      Basic auth username.

    • database (string)

      Database name (if used).

    • jsonData (object)

      Fields to be converted to JSON and stored in jsonData.

    • secureJsonData (object)

      JSON-data object to be saved encrypted.

    • type (string)

      Datasource type.

      Required value.

    • url (string)

      Datasource URL.

      Example: "http://localhost:8080"

    • user (string)

      Database username.

    • withCredentials (boolean)

      Enable/disable with credentials headers

GrafanaDashboardDefinition

Scope: Cluster

The resource for storing and managing Grafana Dashboards

  • spec (object)

    Required value.

    • definition (string)

      The dashboard’s JSON manifest.

      Caution! Make sure that there is no “local” id (at the .id address) in the manifest in addition to the uid.

      Required value.

    • folder (string)

      What folder to use for a dashboard. If the folder does not exist, it will be created.

      Example: "My Folder"

      Required value.

The resource for storing and managing Grafana Dashboards

  • spec (object)

    Required value.

    • definition (string)

      The dashboard’s JSON manifest.

      Caution! Make sure that there is no “local” id (at the .id address) in the manifest in addition to the uid.

      Required value.

    • folder (string)

      What folder to use for a dashboard. If the folder does not exist, it will be created.

      Example: "My Folder"

      Required value.

PrometheusRemoteWrite

Scope: Cluster

Resource for including ‘remote_write’ data from the local Prometheus into a separate longterm storage (E.g: VictoriaMetrics).

A cluster can have any number of such resources.

  • spec (object)

    Required value.

    • basicAuth (object)

      BasicAuth for the URL.

      • password (string)

        Password for the authentication.

        Required value.

      • username (string)

        Username for the authentication.

        Required value.

    • tlsConfig (object)

      TLS Config to use for remote write.

      • insecureSkipVerify (boolean)

        Disable target certificate validation.

        Default: false

    • url (string)

      The URL of the endpoint to send samples to.

      Example: "https://victoriametrics-test.domain.com/api/v1/write"

      Required value.

    • writeRelabelConfigs (array of objects)

      The list of remote write relabel configurations.

      For example, if you need to remove unnecessary metrics or perform data relabeling.

      • action (string)

        Action to perform based on regex matching.

        Default: "replace"

      • modulus (integer)

        Modulus to take of the hash of the source label values.

      • regex (string)

        Regular expression against which the extracted value is matched. Default is ‘(.*)’

        Default: "(.*)"

      • replacement (string)

        Replacement value against which a regex replace is performed if the regular expression matches.

        Regex capture groups are available.

        Default: "$1"

      • separator (string)

        Separator placed between concatenated source label values.

        Default: ";"

      • sourceLabels (array of strings)

        The source labels select values from existing labels.

        Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.

      • targetLabel (string)

        Label to which the resulting value is written in a replace action. It is mandatory for replace actions.

        Regex capture groups are available.

Resource for including ‘remote_write’ data from the local Prometheus into a separate longterm storage (E.g: VictoriaMetrics).

A cluster can have any number of such resources.

  • spec (object)

    Required value.

    • basicAuth (object)

      BasicAuth for the URL.

      • password (string)

        Password for the authentication.

        Required value.

      • username (string)

        Username for the authentication.

        Required value.

    • tlsConfig (object)

      TLS Config to use for remote write.

      • insecureSkipVerify (boolean)

        Disable target certificate validation.

        Default: false

    • url (string)

      The URL of the endpoint to send samples to.

      Example: "https://victoriametrics-test.domain.com/api/v1/write"

      Required value.

    • writeRelabelConfigs (array of objects)

      The list of remote write relabel configurations.

      For example, if you need to remove unnecessary metrics or perform data relabeling.

      • action (string)

        Action to perform based on regex matching.

        Default: "replace"

      • modulus (integer)

        Modulus to take of the hash of the source label values.

      • regex (string)

        Regular expression against which the extracted value is matched. Default is ‘(.*)’

        Default: "(.*)"

      • replacement (string)

        Replacement value against which a regex replace is performed if the regular expression matches.

        Regex capture groups are available.

        Default: "$1"

      • separator (string)

        Separator placed between concatenated source label values.

        Default: ";"

      • sourceLabels (array of strings)

        The source labels select values from existing labels.

        Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.

      • targetLabel (string)

        Label to which the resulting value is written in a replace action. It is mandatory for replace actions.

        Regex capture groups are available.