VMStaticScrape
operator.victoriametrics.com / v1beta1
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMStaticScrape
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
VMStaticScrapeSpec defines the desired state of VMStaticScrape.
jobName
string
JobName name of job.
sampleLimit
integer
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
scrapeClass
string
ScrapeClass defined scrape class to apply
seriesLimit
integer
SeriesLimit defines per-scrape limit on number of unique time series
a single target can expose during all the scrapes on the time window of 24h.
targetEndpoints []object required
A list of target endpoints to scrape metrics from.
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
credentialsFile
string
File with value for authorization
type
string
Type of authorization, default to bearer
basicAuth object
BasicAuth allow an endpoint to authenticate over basic authentication
password object
Password defines reference for secret with password value
The secret needs to be in the same namespace as scrape object
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
password_file
string
PasswordFile defines path to password file at disk
must be pre-mounted
username object
Username defines reference for secret with username value
The secret needs to be in the same namespace as scrape object
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
bearerTokenFile
string
File to read bearer token for scraping targets.
bearerTokenSecret object
Secret to mount to read bearer token for scraping targets. The secret
needs to be in the same namespace as the scrape object and accessible by
the victoria-metrics operator.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
follow_redirects
boolean
FollowRedirects controls redirects for scraping.
honorLabels
boolean
HonorLabels chooses the metric's labels on collisions with target labels.
honorTimestamps
boolean
HonorTimestamps controls whether vmagent or vmsingle respects the timestamps present in scraped data.
interval
string
Interval at which metrics should be scraped
labels
object
Labels static labels for targets.
max_scrape_size
string
MaxScrapeSize defines a maximum size of scraped data for a job
metricRelabelConfigs []object
MetricRelabelConfigs to apply to samples after scrapping.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
format:
int64
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
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.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
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.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
client_secret_file
string
ClientSecretFile defines path for client secret file.
endpoint_params
object
Parameters to append to the token URL
proxy_url
string
The proxy URL for token_url connection
( available from v0.55.0).
Is only supported by Scrape objects family
scopes
[]string
OAuth2 scopes used for the token request
tls_config
object
TLSConfig for token_url connection
( available from v0.55.0).
Is only supported by Scrape objects family
token_url
string required
The URL to fetch the token from
minLength:
1
params
object
Optional HTTP URL parameters
path
string
HTTP path to scrape for metrics.
proxyURL
string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
relabelConfigs []object
RelabelConfigs to apply to samples during service discovery.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
format:
int64
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
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.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
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.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
sampleLimit
integer
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
scheme
string
HTTP scheme to use for scraping.
enum:
http, https, HTTPS, HTTP
scrapeTimeout
string
Timeout after which the scrape is ended
scrape_interval
string
ScrapeInterval is the same as Interval and has priority over it.
one of scrape_interval or interval can be used
seriesLimit
integer
SeriesLimit defines per-scrape limit on number of unique time series
a single target can expose during all the scrapes on the time window of 24h.
targets
[]string required
Targets static targets addresses in form of ["192.122.55.55:9100","some-name:9100"].
minItems:
1tlsConfig object
TLSConfig configuration to use when scraping the endpoint
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
caFile
string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
certFile
string
Path to the client cert file in the container for the targets.
insecureSkipVerify
boolean
Disable target certificate validation.
keyFile
string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
serverName
string
Used to verify the hostname for the targets.
vm_scrape_params object
VMScrapeParams defines VictoriaMetrics specific scrape parameters
disable_compression
boolean
DisableCompression
disable_keep_alive
boolean
disable_keepalive allows disabling HTTP keep-alive when scraping targets.
By default, HTTP keep-alive is enabled, so TCP connections to scrape targets
could be reused.
See https://docs.victoriametrics.com/victoriametrics/vmagent/#scrape_config-enhancements
headers
[]string
Headers allows sending custom headers to scrape targets
must be in of semicolon separated header with it's value
eg:
headerName: headerValue
vmagent and vmsingle support since 1.79.0 version
no_stale_markers
boolean
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping
See feature description https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
credentialsFile
string
File with value for authorization
type
string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value
The secret needs to be in the same namespace as scrape object
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
password_file
string
PasswordFile defines path to password file at disk
must be pre-mounted
username object
Username defines reference for secret with username value
The secret needs to be in the same namespace as scrape object
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret
needs to be in the same namespace as the scrape object and accessible by
the victoria-metrics operator.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
bearer_token_file
string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
client_secret_file
string
ClientSecretFile defines path for client secret file.
endpoint_params
object
Parameters to append to the token URL
proxy_url
string
The proxy URL for token_url connection
( available from v0.55.0).
Is only supported by Scrape objects family
scopes
[]string
OAuth2 scopes used for the token request
tls_config
object
TLSConfig for token_url connection
( available from v0.55.0).
Is only supported by Scrape objects family
token_url
string required
The URL to fetch the token from
minLength:
1
tls_config
object
TLSConfig configuration to use when scraping the endpoint
scrape_align_interval
string
scrape_offset
string
stream_parse
boolean
status object
ScrapeObjectStatus defines the observed state of ScrapeObjects
conditions []object
Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
format:
date-time
lastUpdateTime
string required
LastUpdateTime is the last time of given type update.
This value is used for status TTL update and removal
format:
date-time
message
string
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
Type of condition in CamelCase or in name.namespace.resource.victoriametrics.com/CamelCase.
maxLength:
316
observedGeneration
integer
ObservedGeneration defines current generation picked by operator for the
reconcile
format:
int64
reason
string
Reason defines human readable error reason
updateStatus
string
UpdateStatus defines a status for update rollout
No matches. Try .spec.jobName for an exact path