vmpodscrape/vmservicescrape/vmnodescrape/vmstaticscrape: support scrape_protocols option

AndrewChubatiuk · AndrewChubatiuk · commit f137aa60e519 · 2024-06-13T09:01:08.000+03:00
diff --git a/api/v1beta1/vmnodescrape_types.go b/api/v1beta1/vmnodescrape_types.go
@@ -38,9 +38,12 @@ type VMNodeScrapeSpec struct {
 	// one of scrape_interval or interval can be used
 	// +optional
 	ScrapeInterval string `json:"scrape_interval,omitempty"`
-	// Timeout after which the scrape is ended
+	// ScrapeTimeout after which the scrape is ended
 	// +optional
 	ScrapeTimeout string `json:"scrapeTimeout,omitempty"`
+	// ScrapeProtocols defines Prometheus scrape protocol.
+	// +optional
+	ScrapeProtocols []string `json:"scrape_protocols,omitempty"`
 	// OAuth2 defines auth configuration
 	// +optional
 	OAuth2 *OAuth2 `json:"oauth2,omitempty"`
diff --git a/api/v1beta1/vmpodscrape_types.go b/api/v1beta1/vmpodscrape_types.go
@@ -97,7 +97,7 @@ type PodMetricsEndpoint struct {
 	// one of scrape_interval or interval can be used
 	// +optional
 	ScrapeInterval string `json:"scrape_interval,omitempty"`
-	// Timeout after which the scrape is ended
+	// ScrapeTimeout after which the scrape is ended
 	// +optional
 	ScrapeTimeout string `json:"scrapeTimeout,omitempty"`
 	// SampleLimit defines per-podEndpoint limit on number of scraped samples that will be accepted.
@@ -107,6 +107,9 @@ type PodMetricsEndpoint struct {
 	// a single target can expose during all the scrapes on the time window of 24h.
 	// +optional
 	SeriesLimit uint64 `json:"seriesLimit,omitempty"`
+	// ScrapeProtocols defines Prometheus scrape protocol.
+	// +optional
+	ScrapeProtocols []string `json:"scrape_protocols,omitempty"`
 	// HonorLabels chooses the metric's labels on collisions with target labels.
 	// +optional
 	HonorLabels bool `json:"honorLabels,omitempty"`
diff --git a/api/v1beta1/vmservicescrape_types.go b/api/v1beta1/vmservicescrape_types.go
@@ -140,7 +140,7 @@ type Endpoint struct {
 	// one of scrape_interval or interval can be used
 	// +optional
 	ScrapeInterval string `json:"scrape_interval,omitempty"`
-	// Timeout after which the scrape is ended
+	// ScrapeTimeout after which the scrape is ended
 	// +optional
 	ScrapeTimeout string `json:"scrapeTimeout,omitempty"`
 	// SampleLimit defines per-endpoint limit on number of scraped samples that will be accepted.
@@ -150,6 +150,9 @@ type Endpoint struct {
 	// a single target can expose during all the scrapes on the time window of 24h.
 	// +optional
 	SeriesLimit uint64 `json:"seriesLimit,omitempty"`
+	// ScrapeProtocols defines Prometheus scrape protocol.
+	// +optional
+	ScrapeProtocols []string `json:"scrape_protocols,omitempty"`
 	// OAuth2 defines auth configuration
 	// +optional
 	OAuth2 *OAuth2 `json:"oauth2,omitempty"`
diff --git a/api/v1beta1/vmstaticscrape_types.go b/api/v1beta1/vmstaticscrape_types.go
@@ -60,9 +60,12 @@ type TargetEndpoint struct {
 	// one of scrape_interval or interval can be used
 	// +optional
 	ScrapeInterval string `json:"scrape_interval,omitempty"`
-	// Timeout after which the scrape is ended
+	// ScrapeTimeout after which the scrape is ended
 	// +optional
 	ScrapeTimeout string `json:"scrapeTimeout,omitempty"`
+	// ScrapeProtocols defines Prometheus scrape protocol.
+	// +optional
+	ScrapeProtocols []string `json:"scrape_protocols,omitempty"`
 	// OAuth2 defines auth configuration
 	// +optional
 	OAuth2 *OAuth2 `json:"oauth2,omitempty"`
diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/api/victoriametrics/v1beta1/vmnodescrape_types.go b/api/victoriametrics/v1beta1/vmnodescrape_types.go
@@ -38,9 +38,12 @@ type VMNodeScrapeSpec struct {
 	// one of scrape_interval or interval can be used
 	// +optional
 	ScrapeInterval string `json:"scrape_interval,omitempty"`
-	// Timeout after which the scrape is ended
+	// ScrapeTimeout after which the scrape is ended
 	// +optional
 	ScrapeTimeout string `json:"scrapeTimeout,omitempty"`
+	// ScrapeProtocols defines Prometheus scrape protocol.
+	// +optional
+	ScrapeProtocols []string `json:"scrape_protocols,omitempty"`
 	// OAuth2 defines auth configuration
 	// +optional
 	OAuth2 *OAuth2 `json:"oauth2,omitempty"`
diff --git a/api/victoriametrics/v1beta1/vmpodscrape_types.go b/api/victoriametrics/v1beta1/vmpodscrape_types.go
@@ -97,9 +97,12 @@ type PodMetricsEndpoint struct {
 	// one of scrape_interval or interval can be used
 	// +optional
 	ScrapeInterval string `json:"scrape_interval,omitempty"`
-	// Timeout after which the scrape is ended
+	// ScrapeTimeout after which the scrape is ended
 	// +optional
 	ScrapeTimeout string `json:"scrapeTimeout,omitempty"`
+	// ScrapeProtocols defines Prometheus scrape protocol.
+	// +optional
+	ScrapeProtocols []string `json:"scrape_protocols,omitempty"`
 	// SampleLimit defines per-podEndpoint limit on number of scraped samples that will be accepted.
 	// +optional
 	SampleLimit uint64 `json:"sampleLimit,omitempty"`
diff --git a/api/victoriametrics/v1beta1/vmservicescrape_types.go b/api/victoriametrics/v1beta1/vmservicescrape_types.go
@@ -140,9 +140,12 @@ type Endpoint struct {
 	// one of scrape_interval or interval can be used
 	// +optional
 	ScrapeInterval string `json:"scrape_interval,omitempty"`
-	// Timeout after which the scrape is ended
+	// ScrapeTimeout after which the scrape is ended
 	// +optional
 	ScrapeTimeout string `json:"scrapeTimeout,omitempty"`
+	// ScrapeProtocols defines Prometheus scrape protocol.
+	// +optional
+	ScrapeProtocols []string `json:"scrape_protocols,omitempty"`
 	// SampleLimit defines per-endpoint limit on number of scraped samples that will be accepted.
 	// +optional
 	SampleLimit uint64 `json:"sampleLimit,omitempty"`
diff --git a/api/victoriametrics/v1beta1/vmstaticscrape_types.go b/api/victoriametrics/v1beta1/vmstaticscrape_types.go
@@ -60,9 +60,12 @@ type TargetEndpoint struct {
 	// one of scrape_interval or interval can be used
 	// +optional
 	ScrapeInterval string `json:"scrape_interval,omitempty"`
-	// Timeout after which the scrape is ended
+	// ScrapeTimeout after which the scrape is ended
 	// +optional
 	ScrapeTimeout string `json:"scrapeTimeout,omitempty"`
+	// ScrapeProtocols defines Prometheus scrape protocol.
+	// +optional
+	ScrapeProtocols []string `json:"scrape_protocols,omitempty"`
 	// OAuth2 defines auth configuration
 	// +optional
 	OAuth2 *OAuth2 `json:"oauth2,omitempty"`
diff --git a/config/crd/bases/operator.victoriametrics.com_vmnodescrapes.yaml b/config/crd/bases/operator.victoriametrics.com_vmnodescrapes.yaml
@@ -453,8 +453,13 @@ spec:
                   ScrapeInterval is the same as Interval and has priority over it.
                   one of scrape_interval or interval can be used
                 type: string
+              scrape_protocols:
+                description: ScrapeProtocols defines Prometheus scrape protocol.
+                items:
+                  type: string
+                type: array
               scrapeTimeout:
-                description: Timeout after which the scrape is ended
+                description: ScrapeTimeout after which the scrape is ended
                 type: string
               selector:
                 description: Selector to select kubernetes Nodes.
diff --git a/config/crd/bases/operator.victoriametrics.com_vmpodscrapes.yaml b/config/crd/bases/operator.victoriametrics.com_vmpodscrapes.yaml
@@ -506,8 +506,13 @@ spec:
                         ScrapeInterval is the same as Interval and has priority over it.
                         one of scrape_interval or interval can be used
                       type: string
+                    scrape_protocols:
+                      description: ScrapeProtocols defines Prometheus scrape protocol.
+                      items:
+                        type: string
+                      type: array
                     scrapeTimeout:
-                      description: Timeout after which the scrape is ended
+                      description: ScrapeTimeout after which the scrape is ended
                       type: string
                     seriesLimit:
                       description: |-
diff --git a/config/crd/bases/operator.victoriametrics.com_vmservicescrapes.yaml b/config/crd/bases/operator.victoriametrics.com_vmservicescrapes.yaml
@@ -495,8 +495,13 @@ spec:
                         ScrapeInterval is the same as Interval and has priority over it.
                         one of scrape_interval or interval can be used
                       type: string
+                    scrape_protocols:
+                      description: ScrapeProtocols defines Prometheus scrape protocol.
+                      items:
+                        type: string
+                      type: array
                     scrapeTimeout:
-                      description: Timeout after which the scrape is ended
+                      description: ScrapeTimeout after which the scrape is ended
                       type: string
                     seriesLimit:
                       description: |-
diff --git a/config/crd/bases/operator.victoriametrics.com_vmstaticscrapes.yaml b/config/crd/bases/operator.victoriametrics.com_vmstaticscrapes.yaml
@@ -476,8 +476,13 @@ spec:
                         ScrapeInterval is the same as Interval and has priority over it.
                         one of scrape_interval or interval can be used
                       type: string
+                    scrape_protocols:
+                      description: ScrapeProtocols defines Prometheus scrape protocol.
+                      items:
+                        type: string
+                      type: array
                     scrapeTimeout:
-                      description: Timeout after which the scrape is ended
+                      description: ScrapeTimeout after which the scrape is ended
                       type: string
                     seriesLimit:
                       description: |-
diff --git a/controllers/factory/vmagent/nodescrape.go b/controllers/factory/vmagent/nodescrape.go
@@ -48,7 +48,9 @@ func generateNodeScrapeConfig(
 	if scrapeInterval != "" {
 		cfg = append(cfg, yaml.MapItem{Key: "scrape_interval", Value: scrapeInterval})
 	}
-
+	if len(nodeSpec.ScrapeProtocols) != 0 {
+		cfg = append(cfg, yaml.MapItem{Key: "scrape_protocols", Value: nodeSpec.ScrapeProtocols})
+	}
 	if nodeSpec.ScrapeTimeout != "" {
 		cfg = append(cfg, yaml.MapItem{Key: "scrape_timeout", Value: nodeSpec.ScrapeTimeout})
 	}
diff --git a/controllers/factory/vmagent/nodescrape_test.go b/controllers/factory/vmagent/nodescrape_test.go
@@ -96,6 +96,7 @@ relabel_configs:
 						FollowRedirects: pointer.Bool(true),
 						ScrapeTimeout:   "10s",
 						ScrapeInterval:  "5s",
+						ScrapeProtocols: []string{"PrometheusProto"},
 						Params:          map[string][]string{"module": {"client"}},
 						JobLabel:        "env",
 						HonorTimestamps: pointer.Bool(true),
@@ -134,6 +135,8 @@ honor_timestamps: true
 kubernetes_sd_configs:
 - role: node
 scrape_interval: 5s
+scrape_protocols:
+- PrometheusProto
 scrape_timeout: 10s
 metrics_path: /metrics
 proxy_url: https://some-url
diff --git a/controllers/factory/vmagent/podscrape.go b/controllers/factory/vmagent/podscrape.go
@@ -54,6 +54,9 @@ func generatePodScrapeConfig(
 	if scrapeInterval != "" {
 		cfg = append(cfg, yaml.MapItem{Key: "scrape_interval", Value: scrapeInterval})
 	}
+	if len(ep.ScrapeProtocols) != 0 {
+		cfg = append(cfg, yaml.MapItem{Key: "scrape_protocols", Value: ep.ScrapeProtocols})
+	}
 	if ep.ScrapeTimeout != "" {
 		cfg = append(cfg, yaml.MapItem{Key: "scrape_timeout", Value: ep.ScrapeTimeout})
 	}
diff --git a/controllers/factory/vmagent/podscrape_test.go b/controllers/factory/vmagent/podscrape_test.go
@@ -158,6 +158,10 @@ relabel_configs:
 					},
 				},
 				ep: victoriametricsv1beta1.PodMetricsEndpoint{
+					ScrapeProtocols: []string{
+						"PrometheusText",
+						"PrometheusProto",
+					},
 					Path: "/metric",
 					Port: "web",
 				},
@@ -170,6 +174,9 @@ kubernetes_sd_configs:
   selectors:
   - role: pod
     label: label-1=value-1,label-2=value-2,label-3=value-3
+scrape_protocols:
+- PrometheusText
+- PrometheusProto
 metrics_path: /metric
 relabel_configs:
 - action: drop
diff --git a/controllers/factory/vmagent/servicescrape.go b/controllers/factory/vmagent/servicescrape.go
@@ -59,6 +59,9 @@ func generateServiceScrapeConfig(
 	if scrapeInterval != "" {
 		cfg = append(cfg, yaml.MapItem{Key: "scrape_interval", Value: scrapeInterval})
 	}
+	if len(ep.ScrapeProtocols) != 0 {
+		cfg = append(cfg, yaml.MapItem{Key: "scrape_protocols", Value: ep.ScrapeProtocols})
+	}
 	if ep.ScrapeTimeout != "" {
 		cfg = append(cfg, yaml.MapItem{Key: "scrape_timeout", Value: ep.ScrapeTimeout})
 	}
diff --git a/controllers/factory/vmagent/servicescrape_test.go b/controllers/factory/vmagent/servicescrape_test.go
@@ -185,6 +185,10 @@ relabel_configs:
 					},
 					BearerTokenFile: "/var/run/tolen",
 					ScrapeInterval:  "60m",
+					ScrapeProtocols: []string{
+						"PrometheusText",
+						"OpenMetricsText",
+					},
 				},
 				i:                        0,
 				apiserverConfig:          nil,
@@ -202,6 +206,9 @@ kubernetes_sd_configs:
     names:
     - default
 scrape_interval: 40m
+scrape_protocols:
+- PrometheusText
+- OpenMetricsText
 tls_config:
   insecure_skip_verify: false
   ca_file: /etc/vmagent-tls/certs/default_tls-secret_ca
diff --git a/controllers/factory/vmagent/staticscrape.go b/controllers/factory/vmagent/staticscrape.go
@@ -50,6 +50,10 @@ func generateStaticScrapeConfig(
 		cfg = append(cfg, yaml.MapItem{Key: "scrape_interval", Value: scrapeInterval})
 	}
 
+	if len(ep.ScrapeProtocols) != 0 {
+		cfg = append(cfg, yaml.MapItem{Key: "scrape_protocols", Value: ep.ScrapeProtocols})
+	}
+
 	if ep.ScrapeTimeout != "" {
 		cfg = append(cfg, yaml.MapItem{Key: "scrape_timeout", Value: ep.ScrapeTimeout})
 	}
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -16,6 +16,8 @@ aliases:
 
 ## Next release
 
+- [vmservicescrape](./api.md#vmservicescrape), [vmpodscrape](./api.md#vmpodscrape), [vmnodescrape](./api.md#vmnodescrape) - added `scrape_protocols` parameter for scrape protocols configuration
+
 <a name="v0.45.0"></a>
 
 ## [v0.45.0](https://github.com/VictoriaMetrics/operator/releases/tag/v0.45.0) - 10 Jun 2024
