docs: add timeout attribute in the prometheus docs

Signed-off-by: AhmedGrati <[email protected]>
argoproj · Jul 23, 2023 · 44f66e2 · 44f66e2
1 parent 55765a7
commit 44f66e2
Show file tree

Hide file tree

Showing 9 changed files with 541 additions and 508 deletions.
diff --git a/docs/analysis/prometheus.md b/docs/analysis/prometheus.md
@@ -20,6 +20,7 @@ spec:
     provider:
       prometheus:
         address: http://prometheus.example.com:9090
+        timeout: 40
         query: |
           sum(irate(
             istio_requests_total{reporter="source",destination_service=~"{{args.service-name}}",response_code!~"5.*"}[5m]

diff --git a/docs/features/kustomize/rollout_cr_schema.json b/docs/features/kustomize/rollout_cr_schema.json
@@ -4282,6 +4282,7 @@
                                                         "type": "string"
                                                     },
                                                     "timeout": {
+                                                        "format": "int64",
                                                         "type": "integer"
                                                     }
                                                 },
@@ -8675,6 +8676,7 @@
                                                         "type": "string"
                                                     },
                                                     "timeout": {
+                                                        "format": "int64",
                                                         "type": "integer"
                                                     }
                                                 },
@@ -13068,6 +13070,7 @@
                                                         "type": "string"
                                                     },
                                                     "timeout": {
+                                                        "format": "int64",
                                                         "type": "integer"
                                                     }
                                                 },

diff --git a/manifests/crds/analysis-run-crd.yaml b/manifests/crds/analysis-run-crd.yaml
@@ -2780,6 +2780,7 @@ spec:
                             query:
                               type: string
                             timeout:
+                              format: int64
                               type: integer
                           type: object
                         skywalking:

diff --git a/manifests/crds/analysis-template-crd.yaml b/manifests/crds/analysis-template-crd.yaml
@@ -2776,6 +2776,7 @@ spec:
                             query:
                               type: string
                             timeout:
+                              format: int64
                               type: integer
                           type: object
                         skywalking:

diff --git a/manifests/crds/cluster-analysis-template-crd.yaml b/manifests/crds/cluster-analysis-template-crd.yaml
@@ -2776,6 +2776,7 @@ spec:
                             query:
                               type: string
                             timeout:
+                              format: int64
                               type: integer
                           type: object
                         skywalking:

diff --git a/manifests/install.yaml b/manifests/install.yaml
@@ -2781,6 +2781,7 @@ spec:
                             query:
                               type: string
                             timeout:
+                              format: int64
                               type: integer
                           type: object
                         skywalking:
@@ -5742,6 +5743,7 @@ spec:
                             query:
                               type: string
                             timeout:
+                              format: int64
                               type: integer
                           type: object
                         skywalking:
@@ -8589,6 +8591,7 @@ spec:
                             query:
                               type: string
                             timeout:
+                              format: int64
                               type: integer
                           type: object
                         skywalking:

diff --git a/metricproviders/prometheus/prometheus_test.go b/metricproviders/prometheus/prometheus_test.go
@@ -493,3 +493,23 @@ func TestNewPrometheusAddressNotConfigured(t *testing.T) {
 	assert.NotNil(t, err)
 	log.Infof("api:%v", api)
 }
+
+func TestNewPrometheusNegativeTimeout(t *testing.T) {
+	e := log.Entry{}
+	mock := mockAPI{
+		value: newScalar(10),
+	}
+	timeout := int64(-20)
+	metric := v1alpha1.Metric{
+		Name: "foo",
+		Provider: v1alpha1.MetricProvider{
+			Prometheus: &v1alpha1.PrometheusMetric{
+				Query:   "test",
+				Timeout: &timeout,
+			},
+		},
+	}
+	p, err := NewPrometheusProvider(mock, e, metric)
+	assert.NotNil(t, err)
+	assert.Nil(t, p)
+}
diff --git a/pkg/apis/rollouts/v1alpha1/generated.pb.go b/pkg/apis/rollouts/v1alpha1/generated.pb.go
diff --git a/pkg/apis/rollouts/v1alpha1/openapi_generated.go b/pkg/apis/rollouts/v1alpha1/openapi_generated.go