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

    • spec.basicAuth
      object

      BasicAuth for the URL.

      • spec.basicAuth.password
        string

        Required value

        Password for the authentication.

      • spec.basicAuth.username
        string

        Required value

        Username for the authentication.

    • spec.bearerToken
      string

      Bearer token.

    • spec.customAuthToken
      string

      Custom token sent as a value of the X-Auth-Token header.

    • spec.headers
      object

      HTTP headers to include in the request.

      • spec.headers.X-Scope-OrgID
        string

        Required value

        The X-Scope-OrgID header specifying the tenant ID.

    • spec.tlsConfig
      object

      TLS Config to use for remote write.

      • spec.tlsConfig.ca
        string

        The CA certificate used when verifying the API server certificate.

        Default: ""

      • spec.tlsConfig.insecureSkipVerify
        boolean

        Disable target certificate validation.

        Default: false

    • spec.url
      string

      Required value

      The URL of the endpoint to send samples to.

      Example:

      url: https://victoriametrics-test.domain.com/api/v1/write
      
    • spec.writeRelabelConfigs
      array of objects

      The list of remote write relabel configurations.

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

      • spec.writeRelabelConfigs.action
        string

        Action to perform based on regex matching.

        Default: "replace"

      • spec.writeRelabelConfigs.modulus
        integer

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

      • spec.writeRelabelConfigs.regex
        string

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

        Default: "(.*)"

      • spec.writeRelabelConfigs.replacement
        string

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

        Regex capture groups are available.

        Default: "$1"

      • spec.writeRelabelConfigs.separator
        string

        Separator placed between concatenated source label values.

        Default: ";"

      • spec.writeRelabelConfigs.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.

      • spec.writeRelabelConfigs.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.

Deprecated resource. Support for the resource might be removed in a later release.

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

    • spec.basicAuth
      object

      BasicAuth for the URL.

      • spec.basicAuth.password
        string

        Required value

        Password for the authentication.

      • spec.basicAuth.username
        string

        Required value

        Username for the authentication.

    • spec.bearerToken
      string

      Bearer token.

    • spec.customAuthToken
      string

      Custom token sent as a value of the X-Auth-Token header.

    • spec.headers
      object

      HTTP headers to include in the request.

      • spec.headers.X-Scope-OrgID
        string

        Required value

        The X-Scope-OrgID header specifying the tenant ID.

    • spec.tlsConfig
      object

      TLS Config to use for remote write.

      • spec.tlsConfig.ca
        string

        The CA certificate used when verifying the API server certificate.

        Default: ""

      • spec.tlsConfig.insecureSkipVerify
        boolean

        Disable target certificate validation.

        Default: false

    • spec.url
      string

      Required value

      The URL of the endpoint to send samples to.

      Example:

      url: https://victoriametrics-test.domain.com/api/v1/write
      
    • spec.writeRelabelConfigs
      array of objects

      The list of remote write relabel configurations.

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

      • spec.writeRelabelConfigs.action
        string

        Action to perform based on regex matching.

        Default: "replace"

      • spec.writeRelabelConfigs.modulus
        integer

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

      • spec.writeRelabelConfigs.regex
        string

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

        Default: "(.*)"

      • spec.writeRelabelConfigs.replacement
        string

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

        Regex capture groups are available.

        Default: "$1"

      • spec.writeRelabelConfigs.separator
        string

        Separator placed between concatenated source label values.

        Default: ";"

      • spec.writeRelabelConfigs.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.

      • spec.writeRelabelConfigs.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.