add compression methods to metric payloads (#775)

* add zstdCallback

* Regenerate client from commit 0050c4a2 of spec repo

Co-authored-by: Sherzod Karimov <[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.6.4",
-            "regenerated": "2022-08-29 15:23:51.611403",
-            "spec_repo_commit": "592474c8"
+            "regenerated": "2022-08-29 17:43:12.262504",
+            "spec_repo_commit": "0050c4a2"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-08-29 15:23:51.629022",
-            "spec_repo_commit": "592474c8"
+            "regenerated": "2022-08-29 17:43:12.275100",
+            "spec_repo_commit": "0050c4a2"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -5515,12 +5515,16 @@ components:
       x-enum-varnames:
       - USER_AGENT_PARSER
     MetricContentEncoding:
+      default: deflate
       description: HTTP header used to compress the media-type.
       enum:
       - deflate
+      - gzip
+      example: deflate
       type: string
       x-enum-varnames:
       - DEFLATE
+      - GZIP
     MetricMetadata:
       description: Object with all metric related metadata.
       properties:

.generator/schemas/v2/openapi.yaml

@@ -4319,9 +4319,14 @@ components:
       description: HTTP header used to compress the media-type.
       enum:
       - deflate
+      - zstd1
+      - gzip
+      example: deflate
       type: string
       x-enum-varnames:
       - DEFLATE
+      - ZSTD1
+      - GZIP
     MetricCustomAggregation:
       description: A time and space aggregation combination for use in query.
       example:

examples/v2/metrics/SubmitMetrics_1762007427.ts

@@ -0,0 +1,35 @@
+/**
+ * Submit metrics with compression returns "Payload accepted" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.MetricsApi(configuration);
+
+const params: v2.MetricsApiSubmitMetricsRequest = {
+  body: {
+    series: [
+      {
+        metric: "system.load.1",
+        type: 0,
+        points: [
+          {
+            timestamp: Math.round(new Date().getTime() / 1000),
+            value: 0.7,
+          },
+        ],
+      },
+    ],
+  },
+  contentEncoding: "zstd1",
+};
+
+apiInstance
+  .submitMetrics(params)
+  .then((data: v2.IntakePayloadAccepted) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/step_definitions/request_steps.ts

@@ -9,6 +9,7 @@ import * as datadogApiClient from "../../index";
 import fs from "fs";
 import path from "path";
 
+import { compressSync } from "zstd.ts";
 import log from "loglevel";
 const logger = log.getLogger("testing")
 logger.setLevel(process.env.DEBUG ? logger.levels.DEBUG : logger.levels.INFO);
@@ -73,6 +74,7 @@ When("the request is sent", async function (this: World) {
   const configurationOpts = {
     authMethods: this.authMethods,
     httpConfig: { compress: false },
+    zstdCompressorCallback: (body: string) => compressSync({input: Buffer.from(body, "utf8")}),
   };
   if (process.env.DD_TEST_SITE) {
     const serverConf = datadogApiClient.client.servers[2].getConfiguration();

features/support/vcr.ts

@@ -132,6 +132,13 @@ Before(function (
   });
 });
 
+// Disable PollyJS request interception when tests are in integration mode
+Before(async function (this: World) {
+  if (this.polly?.mode == MODES.PASSTHROUGH) {
+    this.polly.configure({adapters: []})
+  }
+});
+
 // The order of After functions is important. They are in reverse order
 // hence this.cleanup() must be defined after this.polly.stop().
 

features/v2/metrics.feature

@@ -216,6 +216,14 @@ Feature: Metrics
     When the request is sent
     Then the response status is 408 Request timeout
 
+  @integration-only @skip-terraform-config @skip-validation @team:DataDog/metrics-intake @team:DataDog/metrics-query
+  Scenario: Submit metrics with compression returns "Payload accepted" response
+    Given new "SubmitMetrics" request
+    And body with value {"series": [{"metric": "system.load.1", "type": 0, "points": [{"timestamp": {{ timestamp('now') }}, "value": 0.7}]}]}
+    And request contains "Content-Encoding" parameter with value "zstd1"
+    When the request is sent
+    Then the response status is 202 Payload accepted
+
   @generated @skip @team:DataDog/points-aggregation
   Scenario: Tag Configuration Cardinality Estimator returns "API error response." response
     Given a valid "appKeyAuth" key in the system

packages/datadog-api-client-v1/models/MetricContentEncoding.ts

@@ -4,5 +4,6 @@
  * Copyright 2020-Present Datadog, Inc.
  */
 
-export type MetricContentEncoding = typeof DEFLATE;
+export type MetricContentEncoding = typeof DEFLATE | typeof GZIP;
 export const DEFLATE = "deflate";
+export const GZIP = "gzip";

packages/datadog-api-client-v1/models/ObjectSerializer.ts

@@ -708,7 +708,7 @@ const enumsMap: { [key: string]: any[] } = {
   LogsTraceRemapperType: ["trace-id-remapper"],
   LogsURLParserType: ["url-parser"],
   LogsUserAgentParserType: ["user-agent-parser"],
-  MetricContentEncoding: ["deflate"],
+  MetricContentEncoding: ["deflate", "gzip"],
   MonitorDeviceID: [
     "laptop_large",
     "tablet",

packages/datadog-api-client-v2/models/MetricContentEncoding.ts

@@ -4,5 +4,7 @@
  * Copyright 2020-Present Datadog, Inc.
  */
 
-export type MetricContentEncoding = typeof DEFLATE;
+export type MetricContentEncoding = typeof DEFLATE | typeof ZSTD1 | typeof GZIP;
 export const DEFLATE = "deflate";
+export const ZSTD1 = "zstd1";
+export const GZIP = "gzip";