Add tag filter options for /api/v{1,2}/metrics (#340)

* cassettes

* Regenerate client from commit 20f68cb of spec repo

Co-authored-by: Jiri Kuncar <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.4.1.dev6",
-            "regenerated": "2021-03-24 08:45:09.299583",
-            "spec_repo_commit": "075d167"
+            "regenerated": "2021-03-25 11:07:51.194255",
+            "spec_repo_commit": "20f68cb"
         },
         "v2": {
             "apigentools_version": "1.4.1.dev6",
-            "regenerated": "2021-03-24 08:45:48.710930",
-            "spec_repo_commit": "075d167"
+            "regenerated": "2021-03-25 11:08:34.265135",
+            "spec_repo_commit": "20f68cb"
         }
     }
 }

docs/v1/MetricsApi.md

@@ -124,6 +124,7 @@ with ApiClient(configuration) as api_client:
     api_instance = metrics_api.MetricsApi(api_client)
     _from = 1  # int | Seconds since the Unix epoch.
     host = "host_example"  # str | Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. (optional)
+    tag_filter = "env IN (staging,test) AND service:web"  # str | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. (optional)
 
     # example passing only required values which don't have defaults set
     try:
@@ -137,7 +138,7 @@ with ApiClient(configuration) as api_client:
     # and optional values
     try:
         # Get active metrics list
-        api_response = api_instance.list_active_metrics(_from, host=host)
+        api_response = api_instance.list_active_metrics(_from, host=host, tag_filter=tag_filter)
         pprint(api_response)
     except ApiException as e:
         print("Exception when calling MetricsApi->list_active_metrics: %s\n" % e)
@@ -150,6 +151,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **_from** | **int**| Seconds since the Unix epoch. |
  **host** | **str**| Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. | [optional]
+ **tag_filter** | **str**| Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. | [optional]
 
 ### Return type
 

docs/v2/MetricsApi.md

@@ -299,12 +299,14 @@ with ApiClient(configuration) as api_client:
     filter_tags_configured = "app"  # str | Filter tag configurations by configured tags. (optional)
     filter_metric_type = MetricTagConfigurationMetricTypes("count")  # MetricTagConfigurationMetricTypes | Filter tag configurations by metric type. (optional)
     filter_include_percentiles = True  # bool | Filter distributions with additional percentile aggregations enabled or disabled. (optional)
+    filter_tags = "env IN (staging,test) AND service:web"  # str | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. (optional)
+    window_seconds = 3600  # int | The number of seconds of look back (from now) to apply to a filter[tag] query. Defaults value is 3600 (1 hour), maximum value is 172,800 (2 days). (optional)
 
     # example passing only required values which don't have defaults set
     # and optional values
     try:
         # List tag configurations
-        api_response = api_instance.list_tag_configurations(filter_configured=filter_configured, filter_tags_configured=filter_tags_configured, filter_metric_type=filter_metric_type, filter_include_percentiles=filter_include_percentiles)
+        api_response = api_instance.list_tag_configurations(filter_configured=filter_configured, filter_tags_configured=filter_tags_configured, filter_metric_type=filter_metric_type, filter_include_percentiles=filter_include_percentiles, filter_tags=filter_tags, window_seconds=window_seconds)
         pprint(api_response)
     except ApiException as e:
         print("Exception when calling MetricsApi->list_tag_configurations: %s\n" % e)
@@ -319,6 +321,8 @@ Name | Type | Description  | Notes
  **filter_tags_configured** | **str**| Filter tag configurations by configured tags. | [optional]
  **filter_metric_type** | **MetricTagConfigurationMetricTypes**| Filter tag configurations by metric type. | [optional]
  **filter_include_percentiles** | **bool**| Filter distributions with additional percentile aggregations enabled or disabled. | [optional]
+ **filter_tags** | **str**| Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. | [optional]
+ **window_seconds** | **int**| The number of seconds of look back (from now) to apply to a filter[tag] query. Defaults value is 3600 (1 hour), maximum value is 172,800 (2 days). | [optional]
 
 ### Return type
 

src/datadog_api_client/v1/api/metrics_api.py

@@ -141,6 +141,7 @@ def __list_active_metrics(self, _from, **kwargs):
 
             Keyword Args:
                 host (str): Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag.. [optional]
+                tag_filter (str): Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters.. [optional]
                 _return_http_data_only (bool): response data without head status
                     code and headers. Default is True.
                 _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -189,6 +190,7 @@ def __list_active_metrics(self, _from, **kwargs):
                 "all": [
                     "_from",
                     "host",
+                    "tag_filter",
                 ],
                 "required": [
                     "_from",
@@ -203,14 +205,17 @@ def __list_active_metrics(self, _from, **kwargs):
                 "openapi_types": {
                     "_from": (int,),
                     "host": (str,),
+                    "tag_filter": (str,),
                 },
                 "attribute_map": {
                     "_from": "from",
                     "host": "host",
+                    "tag_filter": "tag_filter",
                 },
                 "location_map": {
                     "_from": "query",
                     "host": "query",
+                    "tag_filter": "query",
                 },
                 "collection_format_map": {},
             },

src/datadog_api_client/v1/openapi.yaml

@@ -14505,6 +14505,16 @@ paths:
         required: false
         schema:
           type: string
+      - description: 'Filter metrics that have been submitted with the given tags.
+          Supports boolean and wildcard expressions.
+
+          Cannot be combined with other filters.'
+        example: env IN (staging,test) AND service:web
+        in: query
+        name: tag_filter
+        required: false
+        schema:
+          type: string
       responses:
         '200':
           content:

src/datadog_api_client/v2/api/metrics_api.py

@@ -332,6 +332,8 @@ def __list_tag_configurations(self, **kwargs):
                 filter_tags_configured (str): Filter tag configurations by configured tags.. [optional]
                 filter_metric_type (MetricTagConfigurationMetricTypes): Filter tag configurations by metric type.. [optional]
                 filter_include_percentiles (bool): Filter distributions with additional percentile aggregations enabled or disabled.. [optional]
+                filter_tags (str): Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters.. [optional]
+                window_seconds (int): The number of seconds of look back (from now) to apply to a filter[tag] query. Defaults value is 3600 (1 hour), maximum value is 172,800 (2 days).. [optional]
                 _return_http_data_only (bool): response data without head status
                     code and headers. Default is True.
                 _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -381,6 +383,8 @@ def __list_tag_configurations(self, **kwargs):
                     "filter_tags_configured",
                     "filter_metric_type",
                     "filter_include_percentiles",
+                    "filter_tags",
+                    "window_seconds",
                 ],
                 "required": [],
                 "nullable": [],
@@ -395,18 +399,24 @@ def __list_tag_configurations(self, **kwargs):
                     "filter_tags_configured": (str,),
                     "filter_metric_type": (MetricTagConfigurationMetricTypes,),
                     "filter_include_percentiles": (bool,),
+                    "filter_tags": (str,),
+                    "window_seconds": (int,),
                 },
                 "attribute_map": {
                     "filter_configured": "filter[configured]",
                     "filter_tags_configured": "filter[tags_configured]",
                     "filter_metric_type": "filter[metric_type]",
                     "filter_include_percentiles": "filter[include_percentiles]",
+                    "filter_tags": "filter[tags]",
+                    "window_seconds": "window[seconds]",
                 },
                 "location_map": {
                     "filter_configured": "query",
                     "filter_tags_configured": "query",
                     "filter_metric_type": "query",
                     "filter_include_percentiles": "query",
+                    "filter_tags": "query",
+                    "window_seconds": "query",
                 },
                 "collection_format_map": {},
             },

src/datadog_api_client/v2/openapi.yaml

@@ -6328,6 +6328,27 @@ paths:
         required: false
         schema:
           type: boolean
+      - description: 'Filter metrics that have been submitted with the given tags.
+          Supports boolean and wildcard expressions.
+
+          Cannot be combined with other filters.'
+        example: env IN (staging,test) AND service:web
+        in: query
+        name: filter[tags]
+        required: false
+        schema:
+          type: string
+      - description: 'The number of seconds of look back (from now) to apply to a
+          filter[tag] query.
+
+          Defaults value is 3600 (1 hour), maximum value is 172,800 (2 days).'
+        example: 3600
+        in: query
+        name: window[seconds]
+        required: false
+        schema:
+          format: int64
+          type: integer
       responses:
         '200':
           content:

tests/v2/cassettes/test_scenarios/test_list_tag_configurations_with_a_tag_filter_returns_success_response.frozen

@@ -0,0 +1 @@
+2021-03-24T16:45:31.438729+00:00

tests/v2/cassettes/test_scenarios/test_list_tag_configurations_with_a_tag_filter_returns_success_response.yaml

@@ -0,0 +1,54 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Dd-Operation-Id:
+      - ListTagConfigurations
+      User-Agent:
+      - datadog-api-client-python/0.1.dev273 (python 3.9.2; os Linux; arch x86_64)
+    method: GET
+    uri: https://api.datadoghq.com/api/v2/metrics?filter%5Btags%5D=datadogapiclientpythontestlisttagconfigurationswithatagfilterreturnssuccessresponse1616604331438729
+  response:
+    body:
+      string: '{"data":[]}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '11'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 24 Mar 2021 16:45:31 GMT
+      cache-control:
+      - no-cache
+      content-security-policy:
+      - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report
+      pragma:
+      - no-cache
+      strict-transport-security:
+      - max-age=15724800;
+      x-content-type-options:
+      - nosniff
+      x-dd-debug:
+      - twvpGlmuom5y6A0pjGtXzTf554cmwJgTcCZ71fK4H/RDi+v5ehBK0zQiRcTJQG5C
+      x-dd-version:
+      - '35.4165979'
+      x-frame-options:
+      - SAMEORIGIN
+      x-ratelimit-limit:
+      - '50'
+      x-ratelimit-period:
+      - '60'
+      x-ratelimit-remaining:
+      - '49'
+      x-ratelimit-reset:
+      - '29'
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v2/features/metrics.feature

@@ -154,6 +154,13 @@ Feature: Metrics
     When the request is sent
     Then the response status is 429 Too Many Requests
 
+  Scenario: List tag configurations with a tag filter returns "Success" response
+    Given operation "ListTagConfigurations" enabled
+    And new "ListTagConfigurations" request
+    And request contains "filter[tags]" parameter with value "{{ unique_alnum }}"
+    When the request is sent
+    Then the response status is 200 Success
+
   @generated @skip
   Scenario: List tags by metric name returns "Bad Request" response
     Given operation "ListTagsByMetricName" enabled