Fix config example (#10338)

DataDog · Oct 5, 2021 · f8e88fe · f8e88fe
1 parent 65f3a48
commit f8e88fe
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 4 deletions.
diff --git a/gitlab/assets/configuration/spec.yaml b/gitlab/assets/configuration/spec.yaml
@@ -5,7 +5,6 @@ files:
   - template: instances
     options:
     - name: gitlab_url
-      required: true
       description: |
         The master URL to probe for service health status
         If you are using gitlab CE and not EE, use this URL with

diff --git a/gitlab/datadog_checks/gitlab/config_models/defaults.py b/gitlab/datadog_checks/gitlab/config_models/defaults.py
@@ -80,6 +80,10 @@ def instance_extra_headers(field, value):
     return get_default_field_value(field, value)
 
 
+def instance_gitlab_url(field, value):
+    return get_default_field_value(field, value)
+
+
 def instance_headers(field, value):
     return get_default_field_value(field, value)
 

diff --git a/gitlab/datadog_checks/gitlab/config_models/instance.py b/gitlab/datadog_checks/gitlab/config_models/instance.py
@@ -71,7 +71,7 @@ class Config:
     empty_default_hostname: Optional[bool]
     exclude_labels: Optional[Sequence[str]]
     extra_headers: Optional[Mapping[str, Any]]
-    gitlab_url: str
+    gitlab_url: Optional[str]
     headers: Optional[Mapping[str, Any]]
     health_service_check: Optional[bool]
     ignore_metrics: Optional[Sequence[str]]

diff --git a/gitlab/datadog_checks/gitlab/data/conf.yaml.example b/gitlab/datadog_checks/gitlab/data/conf.yaml.example
@@ -2,12 +2,13 @@
 #
 instances:
 
-    ## @param gitlab_url - string - required
+  -
+    ## @param gitlab_url - string - optional
     ## The master URL to probe for service health status
     ## If you are using gitlab CE and not EE, use this URL with
     ## the authorization token: http://localhost/?token=<TOKEN>
     #
-  - gitlab_url: <GITLAB_URL>
+    # gitlab_url: <GITLAB_URL>
 
     ## @param api_token - string - optional
     ## The Gitlab API token for this instance