Add apm_metrics query support to dashboard OpenAPI spec

.generator/schemas/v1/openapi.yaml

@@ -2855,6 +2855,127 @@ components:
       - service
       - name
       type: object
+    FormulaAndFunctionApmMetricStatName:
+      description: APM metric stat name.
+      enum:
+      - errors
+      - error_rate
+      - errors_per_second
+      - latency_avg
+      - latency_max
+      - latency_p50
+      - latency_p75
+      - latency_p90
+      - latency_p95
+      - latency_p99
+      - latency_p999
+      - latency_distribution
+      - hits
+      - hits_per_second
+      - total_time
+      - apdex
+      example: hits
+      type: string
+      x-enum-varnames:
+      - ERRORS
+      - ERROR_RATE
+      - ERRORS_PER_SECOND
+      - LATENCY_AVG
+      - LATENCY_MAX
+      - LATENCY_P50
+      - LATENCY_P75
+      - LATENCY_P90
+      - LATENCY_P95
+      - LATENCY_P99
+      - LATENCY_P999
+      - LATENCY_DISTRIBUTION
+      - HITS
+      - HITS_PER_SECOND
+      - TOTAL_TIME
+      - APDEX
+    FormulaAndFunctionApmMetricsDataSource:
+      description: Data source for APM metrics queries.
+      enum:
+      - apm_metrics
+      example: apm_metrics
+      type: string
+      x-enum-varnames:
+      - APM_METRICS
+    FormulaAndFunctionApmMetricsQueryDefinition:
+      description: A formula and functions APM metrics query.
+      properties:
+        data_source:
+          $ref: '#/components/schemas/FormulaAndFunctionApmMetricsDataSource'
+        group_by:
+          description: Optional fields to group the query results by.
+          items:
+            description: A field to group results by.
+            example: resource_name
+            type: string
+          type: array
+        name:
+          description: Name of this query to use in formulas.
+          example: query_errors
+          type: string
+        operation_mode:
+          description: Optional operation mode to aggregate across operation names.
+          example: primary
+          type: string
+        operation_name:
+          description: Name of operation on service. If not provided, the primary
+            operation name is used.
+          example: web.request
+          type: string
+        peer_tags:
+          description: Tags to query for a specific downstream entity (peer.service,
+            peer.db_instance, peer.s3, peer.s3.bucket, etc.).
+          items:
+            example: peer.service:my-service
+            type: string
+          type: array
+        query_filter:
+          description: Additional filters for the query using metrics query syntax
+            (e.g., env, primary_tag).
+          example: env:prod
+          type: string
+        resource_hash:
+          description: The hash of a specific resource to filter by.
+          example: abc123
+          type: string
+        resource_name:
+          description: The full name of a specific resource to filter by.
+          example: GET /api/v1/users
+          type: string
+        service:
+          description: APM service name.
+          example: web-store
+          type: string
+        span_kind:
+          $ref: '#/components/schemas/FormulaAndFunctionApmMetricsSpanKind'
+        stat:
+          $ref: '#/components/schemas/FormulaAndFunctionApmMetricStatName'
+      required:
+      - data_source
+      - name
+      - stat
+      type: object
+    FormulaAndFunctionApmMetricsSpanKind:
+      description: Describes the relationship between the span, its parents, and its
+        children in a trace.
+      enum:
+      - consumer
+      - server
+      - client
+      - producer
+      - internal
+      example: server
+      type: string
+      x-enum-varnames:
+      - CONSUMER
+      - SERVER
+      - CLIENT
+      - PRODUCER
+      - INTERNAL
     FormulaAndFunctionApmResourceStatName:
       description: APM resource stat name.
       enum:
@@ -3296,6 +3417,7 @@ components:
       - $ref: '#/components/schemas/FormulaAndFunctionProcessQueryDefinition'
       - $ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatsQueryDefinition'
       - $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition'
+      - $ref: '#/components/schemas/FormulaAndFunctionApmMetricsQueryDefinition'
       - $ref: '#/components/schemas/FormulaAndFunctionSLOQueryDefinition'
       - $ref: '#/components/schemas/FormulaAndFunctionCloudCostQueryDefinition'
     FormulaAndFunctionResponseFormat:

.generator/schemas/v2/openapi.yaml

@@ -102212,6 +102212,13 @@ paths:
     get:
       description: Get the list of all critical assets.
       operationId: ListSecurityMonitoringCriticalAssets
+      parameters:
+      - description: Query string.
+        in: query
+        name: query
+        required: false
+        schema:
+          type: string
       responses:
         '200':
           content:

examples/v1/dashboards/CreateDashboard_2252738813.java

@@ -0,0 +1,75 @@
+// Create a new dashboard with apm metrics widget
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v1.api.DashboardsApi;
+import com.datadog.api.client.v1.model.Dashboard;
+import com.datadog.api.client.v1.model.DashboardLayoutType;
+import com.datadog.api.client.v1.model.FormulaAndFunctionApmMetricStatName;
+import com.datadog.api.client.v1.model.FormulaAndFunctionApmMetricsDataSource;
+import com.datadog.api.client.v1.model.FormulaAndFunctionApmMetricsQueryDefinition;
+import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
+import com.datadog.api.client.v1.model.FormulaAndFunctionResponseFormat;
+import com.datadog.api.client.v1.model.TableWidgetDefinition;
+import com.datadog.api.client.v1.model.TableWidgetDefinitionType;
+import com.datadog.api.client.v1.model.TableWidgetRequest;
+import com.datadog.api.client.v1.model.Widget;
+import com.datadog.api.client.v1.model.WidgetDefinition;
+import com.datadog.api.client.v1.model.WidgetLayout;
+import com.datadog.api.client.v1.model.WidgetTextAlign;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    DashboardsApi apiInstance = new DashboardsApi(defaultClient);
+
+    Dashboard body =
+        new Dashboard()
+            .title("Example-Dashboard")
+            .widgets(
+                Collections.singletonList(
+                    new Widget()
+                        .definition(
+                            new WidgetDefinition(
+                                new TableWidgetDefinition()
+                                    .title("")
+                                    .titleSize("16")
+                                    .titleAlign(WidgetTextAlign.LEFT)
+                                    .type(TableWidgetDefinitionType.QUERY_TABLE)
+                                    .requests(
+                                        Collections.singletonList(
+                                            new TableWidgetRequest()
+                                                .responseFormat(
+                                                    FormulaAndFunctionResponseFormat.SCALAR)
+                                                .queries(
+                                                    Collections.singletonList(
+                                                        new FormulaAndFunctionQueryDefinition(
+                                                            new FormulaAndFunctionApmMetricsQueryDefinition()
+                                                                .stat(
+                                                                    FormulaAndFunctionApmMetricStatName
+                                                                        .HITS)
+                                                                .name("query1")
+                                                                .service("web-store")
+                                                                .dataSource(
+                                                                    FormulaAndFunctionApmMetricsDataSource
+                                                                        .APM_METRICS)
+                                                                .queryFilter("env:prod")
+                                                                .groupBy(
+                                                                    Collections.singletonList(
+                                                                        "resource_name")))))))))
+                        .layout(new WidgetLayout().x(0L).y(0L).width(4L).height(4L))))
+            .layoutType(DashboardLayoutType.ORDERED);
+
+    try {
+      Dashboard result = apiInstance.createDashboard(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling DashboardsApi#createDashboard");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

src/main/java/com/datadog/api/client/v1/model/FormulaAndFunctionApmMetricStatName.java

@@ -0,0 +1,106 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2019-Present Datadog, Inc.
+ */
+
+package com.datadog.api.client.v1.model;
+
+import com.datadog.api.client.ModelEnum;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.fasterxml.jackson.databind.ser.std.StdSerializer;
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
+/** APM metric stat name. */
+@JsonSerialize(
+    using = FormulaAndFunctionApmMetricStatName.FormulaAndFunctionApmMetricStatNameSerializer.class)
+public class FormulaAndFunctionApmMetricStatName extends ModelEnum<String> {
+
+  private static final Set<String> allowedValues =
+      new HashSet<String>(
+          Arrays.asList(
+              "errors",
+              "error_rate",
+              "errors_per_second",
+              "latency_avg",
+              "latency_max",
+              "latency_p50",
+              "latency_p75",
+              "latency_p90",
+              "latency_p95",
+              "latency_p99",
+              "latency_p999",
+              "latency_distribution",
+              "hits",
+              "hits_per_second",
+              "total_time",
+              "apdex"));
+
+  public static final FormulaAndFunctionApmMetricStatName ERRORS =
+      new FormulaAndFunctionApmMetricStatName("errors");
+  public static final FormulaAndFunctionApmMetricStatName ERROR_RATE =
+      new FormulaAndFunctionApmMetricStatName("error_rate");
+  public static final FormulaAndFunctionApmMetricStatName ERRORS_PER_SECOND =
+      new FormulaAndFunctionApmMetricStatName("errors_per_second");
+  public static final FormulaAndFunctionApmMetricStatName LATENCY_AVG =
+      new FormulaAndFunctionApmMetricStatName("latency_avg");
+  public static final FormulaAndFunctionApmMetricStatName LATENCY_MAX =
+      new FormulaAndFunctionApmMetricStatName("latency_max");
+  public static final FormulaAndFunctionApmMetricStatName LATENCY_P50 =
+      new FormulaAndFunctionApmMetricStatName("latency_p50");
+  public static final FormulaAndFunctionApmMetricStatName LATENCY_P75 =
+      new FormulaAndFunctionApmMetricStatName("latency_p75");
+  public static final FormulaAndFunctionApmMetricStatName LATENCY_P90 =
+      new FormulaAndFunctionApmMetricStatName("latency_p90");
+  public static final FormulaAndFunctionApmMetricStatName LATENCY_P95 =
+      new FormulaAndFunctionApmMetricStatName("latency_p95");
+  public static final FormulaAndFunctionApmMetricStatName LATENCY_P99 =
+      new FormulaAndFunctionApmMetricStatName("latency_p99");
+  public static final FormulaAndFunctionApmMetricStatName LATENCY_P999 =
+      new FormulaAndFunctionApmMetricStatName("latency_p999");
+  public static final FormulaAndFunctionApmMetricStatName LATENCY_DISTRIBUTION =
+      new FormulaAndFunctionApmMetricStatName("latency_distribution");
+  public static final FormulaAndFunctionApmMetricStatName HITS =
+      new FormulaAndFunctionApmMetricStatName("hits");
+  public static final FormulaAndFunctionApmMetricStatName HITS_PER_SECOND =
+      new FormulaAndFunctionApmMetricStatName("hits_per_second");
+  public static final FormulaAndFunctionApmMetricStatName TOTAL_TIME =
+      new FormulaAndFunctionApmMetricStatName("total_time");
+  public static final FormulaAndFunctionApmMetricStatName APDEX =
+      new FormulaAndFunctionApmMetricStatName("apdex");
+
+  FormulaAndFunctionApmMetricStatName(String value) {
+    super(value, allowedValues);
+  }
+
+  public static class FormulaAndFunctionApmMetricStatNameSerializer
+      extends StdSerializer<FormulaAndFunctionApmMetricStatName> {
+    public FormulaAndFunctionApmMetricStatNameSerializer(
+        Class<FormulaAndFunctionApmMetricStatName> t) {
+      super(t);
+    }
+
+    public FormulaAndFunctionApmMetricStatNameSerializer() {
+      this(null);
+    }
+
+    @Override
+    public void serialize(
+        FormulaAndFunctionApmMetricStatName value, JsonGenerator jgen, SerializerProvider provider)
+        throws IOException, JsonProcessingException {
+      jgen.writeObject(value.value);
+    }
+  }
+
+  @JsonCreator
+  public static FormulaAndFunctionApmMetricStatName fromValue(String value) {
+    return new FormulaAndFunctionApmMetricStatName(value);
+  }
+}

src/main/java/com/datadog/api/client/v1/model/FormulaAndFunctionApmMetricsDataSource.java

@@ -0,0 +1,63 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2019-Present Datadog, Inc.
+ */
+
+package com.datadog.api.client.v1.model;
+
+import com.datadog.api.client.ModelEnum;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.fasterxml.jackson.databind.ser.std.StdSerializer;
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
+/** Data source for APM metrics queries. */
+@JsonSerialize(
+    using =
+        FormulaAndFunctionApmMetricsDataSource.FormulaAndFunctionApmMetricsDataSourceSerializer
+            .class)
+public class FormulaAndFunctionApmMetricsDataSource extends ModelEnum<String> {
+
+  private static final Set<String> allowedValues =
+      new HashSet<String>(Arrays.asList("apm_metrics"));
+
+  public static final FormulaAndFunctionApmMetricsDataSource APM_METRICS =
+      new FormulaAndFunctionApmMetricsDataSource("apm_metrics");
+
+  FormulaAndFunctionApmMetricsDataSource(String value) {
+    super(value, allowedValues);
+  }
+
+  public static class FormulaAndFunctionApmMetricsDataSourceSerializer
+      extends StdSerializer<FormulaAndFunctionApmMetricsDataSource> {
+    public FormulaAndFunctionApmMetricsDataSourceSerializer(
+        Class<FormulaAndFunctionApmMetricsDataSource> t) {
+      super(t);
+    }
+
+    public FormulaAndFunctionApmMetricsDataSourceSerializer() {
+      this(null);
+    }
+
+    @Override
+    public void serialize(
+        FormulaAndFunctionApmMetricsDataSource value,
+        JsonGenerator jgen,
+        SerializerProvider provider)
+        throws IOException, JsonProcessingException {
+      jgen.writeObject(value.value);
+    }
+  }
+
+  @JsonCreator
+  public static FormulaAndFunctionApmMetricsDataSource fromValue(String value) {
+    return new FormulaAndFunctionApmMetricsDataSource(value);
+  }
+}