mirrors/prometheus-operator
mirrors/prometheus-operator
1
0
Fork 0
mirror of https://github.com/prometheus-operator/prometheus-operator.git synced 2025-04-14 08:16:31 +00:00
Code Activity

Merge pull request #7257 from heliapb/fix_probe_doc

Browse source
This commit is contained in:
Hélia Barroso 2025-01-06 12:50:31 +00:00 • committed by GitHub
parent 3904e3ac9c
commit 96ca1f8c8d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
25 changed files with 69 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
Documentation/api.md generated
View file

@ -1331,7 +1331,8 @@ Duration
</td>
<td>
<p>Timeout for scraping metrics from the Prometheus exporter.
If not specified, the Prometheus global scrape timeout is used.</p>
If not specified, the Prometheus global scrape timeout is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.</p>
</td>
</tr>
<tr>
@ -2013,7 +2014,8 @@ Duration
</em>
</td>
<td>
<p>Number of seconds to wait until a scrape request times out.</p>
<p>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.</p>
</td>
</tr>
<tr>
@ -7156,7 +7158,8 @@ Duration
</em>
</td>
<td>
<p>Number of seconds to wait until a scrape request times out.</p>
<p>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.</p>
</td>
</tr>
<tr>
@ -9068,7 +9071,8 @@ Duration
<td>
<p>Timeout after which Prometheus considers the scrape to be failed.</p>
<p>If empty, Prometheus uses the global scrape timeout unless it is less
than the target&rsquo;s scrape interval value in which the latter is used.</p>
than the target&rsquo;s scrape interval value in which the latter is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.</p>
</td>
</tr>
<tr>
@ -10426,7 +10430,8 @@ Duration
<td>
<p>Timeout after which Prometheus considers the scrape to be failed.</p>
<p>If empty, Prometheus uses the global scrape timeout unless it is less
than the target&rsquo;s scrape interval value in which the latter is used.</p>
than the target&rsquo;s scrape interval value in which the latter is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.</p>
</td>
</tr>
<tr>
@ -11033,7 +11038,8 @@ Duration
</td>
<td>
<p>Timeout for scraping metrics from the Prometheus exporter.
If not specified, the Prometheus global scrape timeout is used.</p>
If not specified, the Prometheus global scrape timeout is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.</p>
</td>
</tr>
<tr>
@ -12001,7 +12007,8 @@ Duration
</em>
</td>
<td>
<p>Number of seconds to wait until a scrape request times out.</p>
<p>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.</p>
</td>
</tr>
<tr>
@ -18780,7 +18787,8 @@ Duration
</em>
</td>
<td>
<p>Number of seconds to wait until a scrape request times out.</p>
<p>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.</p>
</td>
</tr>
<tr>
@ -20349,7 +20357,8 @@ Duration
</td>
<td>
<em>(Optional)</em>
<p>ScrapeTimeout is the number of seconds to wait until a scrape request times out.</p>
<p>ScrapeTimeout is 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.</p>
</td>
</tr>
<tr>
@ -26739,7 +26748,8 @@ Duration
</em>
</td>
<td>
<p>Number of seconds to wait until a scrape request times out.</p>
<p>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.</p>
</td>
</tr>
<tr>
@ -29485,7 +29495,8 @@ Duration
</td>
<td>
<em>(Optional)</em>
<p>ScrapeTimeout is the number of seconds to wait until a scrape request times out.</p>
<p>ScrapeTimeout is 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.</p>
</td>
</tr>
<tr>

18
bundle.yaml generated
View file

@ -19675,6 +19675,7 @@ spec:
If empty, Prometheus uses the global scrape timeout unless it is less
than the target's scrape interval value in which the latter is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetPort:
@ -20707,6 +20708,7 @@ spec:
description: |-
Timeout for scraping metrics from the Prometheus exporter.
If not specified, the Prometheus global scrape timeout is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetLimit:
@ -28048,8 +28050,9 @@ spec:
type: array
x-kubernetes-list-type: set
scrapeTimeout:
description: Number of seconds to wait until a scrape request times
out.
description: |-
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.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
secrets:
@ -40534,8 +40537,9 @@ spec:
type: array
x-kubernetes-list-type: set
scrapeTimeout:
description: Number of seconds to wait until a scrape request times
out.
description: |-
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.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
secrets:
@ -56403,8 +56407,9 @@ spec:
type: array
x-kubernetes-list-type: set
scrapeTimeout:
description: ScrapeTimeout is the number of seconds to wait until
a scrape request times out.
description: |-
ScrapeTimeout is 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.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
staticConfigs:
@ -57432,6 +57437,7 @@ spec:
If empty, Prometheus uses the global scrape timeout unless it is less
than the target's scrape interval value in which the latter is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetPort:

1
example/prometheus-operator-crd-full/monitoring.coreos.com_podmonitors.yaml generated
View file

@ -898,6 +898,7 @@ spec:
If empty, Prometheus uses the global scrape timeout unless it is less
than the target's scrape interval value in which the latter is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetPort:

1
example/prometheus-operator-crd-full/monitoring.coreos.com_probes.yaml generated
View file

@ -723,6 +723,7 @@ spec:
description: |-
Timeout for scraping metrics from the Prometheus exporter.
If not specified, the Prometheus global scrape timeout is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetLimit:

5
example/prometheus-operator-crd-full/monitoring.coreos.com_prometheusagents.yaml generated
View file

@ -6890,8 +6890,9 @@ spec:
type: array
x-kubernetes-list-type: set
scrapeTimeout:
description: Number of seconds to wait until a scrape request times
out.
description: |-
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.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
secrets:

5
example/prometheus-operator-crd-full/monitoring.coreos.com_prometheuses.yaml generated
View file

@ -8599,8 +8599,9 @@ spec:
type: array
x-kubernetes-list-type: set
scrapeTimeout:
description: Number of seconds to wait until a scrape request times
out.
description: |-
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.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
secrets:

5
example/prometheus-operator-crd-full/monitoring.coreos.com_scrapeconfigs.yaml generated
View file

@ -11301,8 +11301,9 @@ spec:
type: array
x-kubernetes-list-type: set
scrapeTimeout:
description: ScrapeTimeout is the number of seconds to wait until
a scrape request times out.
description: |-
ScrapeTimeout is 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.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
staticConfigs:

1
example/prometheus-operator-crd-full/monitoring.coreos.com_servicemonitors.yaml generated
View file

@ -815,6 +815,7 @@ spec:
If empty, Prometheus uses the global scrape timeout unless it is less
than the target's scrape interval value in which the latter is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetPort:

1
example/prometheus-operator-crd/monitoring.coreos.com_podmonitors.yaml generated
View file

@ -899,6 +899,7 @@ spec:
If empty, Prometheus uses the global scrape timeout unless it is less
than the target's scrape interval value in which the latter is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetPort:

1
example/prometheus-operator-crd/monitoring.coreos.com_probes.yaml generated
View file

@ -724,6 +724,7 @@ spec:
description: |-
Timeout for scraping metrics from the Prometheus exporter.
If not specified, the Prometheus global scrape timeout is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetLimit:

5
example/prometheus-operator-crd/monitoring.coreos.com_prometheusagents.yaml generated
View file

@ -6891,8 +6891,9 @@ spec:
type: array
x-kubernetes-list-type: set
scrapeTimeout:
description: Number of seconds to wait until a scrape request times
out.
description: |-
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.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
secrets:

5
example/prometheus-operator-crd/monitoring.coreos.com_prometheuses.yaml generated
View file

@ -8600,8 +8600,9 @@ spec:
type: array
x-kubernetes-list-type: set
scrapeTimeout:
description: Number of seconds to wait until a scrape request times
out.
description: |-
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.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
secrets:

5
example/prometheus-operator-crd/monitoring.coreos.com_scrapeconfigs.yaml generated
View file

@ -11302,8 +11302,9 @@ spec:
type: array
x-kubernetes-list-type: set
scrapeTimeout:
description: ScrapeTimeout is the number of seconds to wait until
a scrape request times out.
description: |-
ScrapeTimeout is 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.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
staticConfigs:

1
example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml generated
View file

@ -816,6 +816,7 @@ spec:
If empty, Prometheus uses the global scrape timeout unless it is less
than the target's scrape interval value in which the latter is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetPort:

2
jsonnet/prometheus-operator/podmonitors-crd.json
View file

@ -753,7 +753,7 @@
"type": "string"
},
"scrapeTimeout": {
"description": "Timeout after which Prometheus considers the scrape to be failed.\n\nIf empty, Prometheus uses the global scrape timeout unless it is less\nthan the target's scrape interval value in which the latter is used.",
"description": "Timeout after which Prometheus considers the scrape to be failed.\n\nIf empty, Prometheus uses the global scrape timeout unless it is less\nthan the target's scrape interval value in which the latter is used.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.",
"pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$",
"type": "string"
},

2
jsonnet/prometheus-operator/probes-crd.json
View file

@ -654,7 +654,7 @@
"x-kubernetes-list-type": "set"
},
"scrapeTimeout": {
"description": "Timeout for scraping metrics from the Prometheus exporter.\nIf not specified, the Prometheus global scrape timeout is used.",
"description": "Timeout for scraping metrics from the Prometheus exporter.\nIf not specified, the Prometheus global scrape timeout is used.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.",
"pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$",
"type": "string"
},

2
jsonnet/prometheus-operator/prometheusagents-crd.json
View file

@ -5886,7 +5886,7 @@
"x-kubernetes-list-type": "set"
},
"scrapeTimeout": {
"description": "Number of seconds to wait until a scrape request times out.",
"description": "Number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.",
"pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$",
"type": "string"
},

2
jsonnet/prometheus-operator/prometheuses-crd.json
View file

@ -7394,7 +7394,7 @@
"x-kubernetes-list-type": "set"
},
"scrapeTimeout": {
"description": "Number of seconds to wait until a scrape request times out.",
"description": "Number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.",
"pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$",
"type": "string"
},

2
jsonnet/prometheus-operator/scrapeconfigs-crd.json
View file

@ -10714,7 +10714,7 @@
"x-kubernetes-list-type": "set"
},
"scrapeTimeout": {
"description": "ScrapeTimeout is the number of seconds to wait until a scrape request times out.",
"description": "ScrapeTimeout is the number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.",
"pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$",
"type": "string"
},

2
jsonnet/prometheus-operator/servicemonitors-crd.json
View file

@ -680,7 +680,7 @@
"type": "string"
},
"scrapeTimeout": {
"description": "Timeout after which Prometheus considers the scrape to be failed.\n\nIf empty, Prometheus uses the global scrape timeout unless it is less\nthan the target's scrape interval value in which the latter is used.",
"description": "Timeout after which Prometheus considers the scrape to be failed.\n\nIf empty, Prometheus uses the global scrape timeout unless it is less\nthan the target's scrape interval value in which the latter is used.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.",
"pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$",
"type": "string"
},

1
pkg/apis/monitoring/v1/podmonitor_types.go
View file

@ -239,6 +239,7 @@ type PodMetricsEndpoint struct {
//
// If empty, Prometheus uses the global scrape timeout unless it is less
// than the target's scrape interval value in which the latter is used.
// The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
ScrapeTimeout Duration `json:"scrapeTimeout,omitempty"`
// TLS configuration to use when scraping the target.

1
pkg/apis/monitoring/v1/probe_types.go
View file

@ -68,6 +68,7 @@ type ProbeSpec struct {
Interval Duration `json:"interval,omitempty"`
// Timeout for scraping metrics from the Prometheus exporter.
// If not specified, the Prometheus global scrape timeout is used.
// The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
ScrapeTimeout Duration `json:"scrapeTimeout,omitempty"`
// TLS configuration to use when scraping the endpoint.
TLSConfig *SafeTLSConfig `json:"tlsConfig,omitempty"`

1
pkg/apis/monitoring/v1/prometheus_types.go
View file

@ -296,6 +296,7 @@ type CommonPrometheusFields struct {
// +kubebuilder:default:="30s"
ScrapeInterval Duration `json:"scrapeInterval,omitempty"`
// 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.
ScrapeTimeout Duration `json:"scrapeTimeout,omitempty"`
// The protocols to negotiate during a scrape. It tells clients the

1
pkg/apis/monitoring/v1/types.go
View file

@ -545,6 +545,7 @@ type Endpoint struct {
//
// If empty, Prometheus uses the global scrape timeout unless it is less
// than the target's scrape interval value in which the latter is used.
// The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
ScrapeTimeout Duration `json:"scrapeTimeout,omitempty"`
// TLS configuration to use when scraping the target.

1
pkg/apis/monitoring/v1alpha1/scrapeconfig_types.go
View file

@ -238,6 +238,7 @@ type ScrapeConfigSpec struct {
// +optional
ScrapeInterval *v1.Duration `json:"scrapeInterval,omitempty"`
// ScrapeTimeout is 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.
// +optional
ScrapeTimeout *v1.Duration `json:"scrapeTimeout,omitempty"`
// The protocols to negotiate during a scrape. It tells clients the