Add apm_metrics query support to dashboard OpenAPI spec (#1370)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v1/openapi.yaml

@@ -2709,6 +2709,123 @@ 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:
@@ -3138,6 +3255,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:

examples/v1_dashboards_CreateDashboard_2252738813.rs

@@ -0,0 +1,69 @@
+// Create a new dashboard with apm metrics widget
+use datadog_api_client::datadog;
+use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
+use datadog_api_client::datadogV1::model::Dashboard;
+use datadog_api_client::datadogV1::model::DashboardLayoutType;
+use datadog_api_client::datadogV1::model::FormulaAndFunctionApmMetricStatName;
+use datadog_api_client::datadogV1::model::FormulaAndFunctionApmMetricsDataSource;
+use datadog_api_client::datadogV1::model::FormulaAndFunctionApmMetricsQueryDefinition;
+use datadog_api_client::datadogV1::model::FormulaAndFunctionQueryDefinition;
+use datadog_api_client::datadogV1::model::FormulaAndFunctionResponseFormat;
+use datadog_api_client::datadogV1::model::TableWidgetDefinition;
+use datadog_api_client::datadogV1::model::TableWidgetDefinitionType;
+use datadog_api_client::datadogV1::model::TableWidgetRequest;
+use datadog_api_client::datadogV1::model::Widget;
+use datadog_api_client::datadogV1::model::WidgetDefinition;
+use datadog_api_client::datadogV1::model::WidgetLayout;
+use datadog_api_client::datadogV1::model::WidgetTextAlign;
+
+#[tokio::main]
+async fn main() {
+    let body =
+        Dashboard::new(
+            DashboardLayoutType::ORDERED,
+            "Example-Dashboard".to_string(),
+            vec![
+                Widget::new(
+                    WidgetDefinition::TableWidgetDefinition(
+                        Box::new(
+                            TableWidgetDefinition::new(
+                                vec![
+                                    TableWidgetRequest::new()
+                                        .queries(
+                                            vec![
+                                                FormulaAndFunctionQueryDefinition
+                                                ::FormulaAndFunctionApmMetricsQueryDefinition(
+                                                    Box::new(
+                                                        FormulaAndFunctionApmMetricsQueryDefinition::new(
+                                                            FormulaAndFunctionApmMetricsDataSource::APM_METRICS,
+                                                            "query1".to_string(),
+                                                            FormulaAndFunctionApmMetricStatName::HITS,
+                                                        )
+                                                            .group_by(vec!["resource_name".to_string()])
+                                                            .query_filter("env:prod".to_string())
+                                                            .service("web-store".to_string()),
+                                                    ),
+                                                )
+                                            ],
+                                        )
+                                        .response_format(FormulaAndFunctionResponseFormat::SCALAR)
+                                ],
+                                TableWidgetDefinitionType::QUERY_TABLE,
+                            )
+                                .title("".to_string())
+                                .title_align(WidgetTextAlign::LEFT)
+                                .title_size("16".to_string()),
+                        ),
+                    ),
+                ).layout(WidgetLayout::new(4, 4, 0, 0))
+            ],
+        );
+    let configuration = datadog::Configuration::new();
+    let api = DashboardsAPI::with_config(configuration);
+    let resp = api.create_dashboard(body).await;
+    if let Ok(value) = resp {
+        println!("{:#?}", value);
+    } else {
+        println!("{:#?}", resp.unwrap_err());
+    }
+}

src/datadogV1/model/mod.rs

@@ -226,6 +226,14 @@ pub mod model_formula_and_function_apm_resource_stats_data_source;
 pub use self::model_formula_and_function_apm_resource_stats_data_source::FormulaAndFunctionApmResourceStatsDataSource;
 pub mod model_formula_and_function_apm_resource_stat_name;
 pub use self::model_formula_and_function_apm_resource_stat_name::FormulaAndFunctionApmResourceStatName;
+pub mod model_formula_and_function_apm_metrics_query_definition;
+pub use self::model_formula_and_function_apm_metrics_query_definition::FormulaAndFunctionApmMetricsQueryDefinition;
+pub mod model_formula_and_function_apm_metrics_data_source;
+pub use self::model_formula_and_function_apm_metrics_data_source::FormulaAndFunctionApmMetricsDataSource;
+pub mod model_formula_and_function_apm_metrics_span_kind;
+pub use self::model_formula_and_function_apm_metrics_span_kind::FormulaAndFunctionApmMetricsSpanKind;
+pub mod model_formula_and_function_apm_metric_stat_name;
+pub use self::model_formula_and_function_apm_metric_stat_name::FormulaAndFunctionApmMetricStatName;
 pub mod model_formula_and_function_slo_query_definition;
 pub use self::model_formula_and_function_slo_query_definition::FormulaAndFunctionSLOQueryDefinition;
 pub mod model_formula_and_function_slo_data_source;

src/datadogV1/model/model_formula_and_function_apm_metric_stat_name.rs

@@ -0,0 +1,93 @@
+// 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.
+
+use serde::{Deserialize, Deserializer, Serialize, Serializer};
+
+#[non_exhaustive]
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub enum FormulaAndFunctionApmMetricStatName {
+    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,
+    UnparsedObject(crate::datadog::UnparsedObject),
+}
+
+impl ToString for FormulaAndFunctionApmMetricStatName {
+    fn to_string(&self) -> String {
+        match self {
+            Self::ERRORS => String::from("errors"),
+            Self::ERROR_RATE => String::from("error_rate"),
+            Self::ERRORS_PER_SECOND => String::from("errors_per_second"),
+            Self::LATENCY_AVG => String::from("latency_avg"),
+            Self::LATENCY_MAX => String::from("latency_max"),
+            Self::LATENCY_P50 => String::from("latency_p50"),
+            Self::LATENCY_P75 => String::from("latency_p75"),
+            Self::LATENCY_P90 => String::from("latency_p90"),
+            Self::LATENCY_P95 => String::from("latency_p95"),
+            Self::LATENCY_P99 => String::from("latency_p99"),
+            Self::LATENCY_P999 => String::from("latency_p999"),
+            Self::LATENCY_DISTRIBUTION => String::from("latency_distribution"),
+            Self::HITS => String::from("hits"),
+            Self::HITS_PER_SECOND => String::from("hits_per_second"),
+            Self::TOTAL_TIME => String::from("total_time"),
+            Self::APDEX => String::from("apdex"),
+            Self::UnparsedObject(v) => v.value.to_string(),
+        }
+    }
+}
+
+impl Serialize for FormulaAndFunctionApmMetricStatName {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        match self {
+            Self::UnparsedObject(v) => v.serialize(serializer),
+            _ => serializer.serialize_str(self.to_string().as_str()),
+        }
+    }
+}
+
+impl<'de> Deserialize<'de> for FormulaAndFunctionApmMetricStatName {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let s: String = String::deserialize(deserializer)?;
+        Ok(match s.as_str() {
+            "errors" => Self::ERRORS,
+            "error_rate" => Self::ERROR_RATE,
+            "errors_per_second" => Self::ERRORS_PER_SECOND,
+            "latency_avg" => Self::LATENCY_AVG,
+            "latency_max" => Self::LATENCY_MAX,
+            "latency_p50" => Self::LATENCY_P50,
+            "latency_p75" => Self::LATENCY_P75,
+            "latency_p90" => Self::LATENCY_P90,
+            "latency_p95" => Self::LATENCY_P95,
+            "latency_p99" => Self::LATENCY_P99,
+            "latency_p999" => Self::LATENCY_P999,
+            "latency_distribution" => Self::LATENCY_DISTRIBUTION,
+            "hits" => Self::HITS,
+            "hits_per_second" => Self::HITS_PER_SECOND,
+            "total_time" => Self::TOTAL_TIME,
+            "apdex" => Self::APDEX,
+            _ => Self::UnparsedObject(crate::datadog::UnparsedObject {
+                value: serde_json::Value::String(s.into()),
+            }),
+        })
+    }
+}

src/datadogV1/model/model_formula_and_function_apm_metrics_data_source.rs

@@ -0,0 +1,48 @@
+// 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.
+
+use serde::{Deserialize, Deserializer, Serialize, Serializer};
+
+#[non_exhaustive]
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub enum FormulaAndFunctionApmMetricsDataSource {
+    APM_METRICS,
+    UnparsedObject(crate::datadog::UnparsedObject),
+}
+
+impl ToString for FormulaAndFunctionApmMetricsDataSource {
+    fn to_string(&self) -> String {
+        match self {
+            Self::APM_METRICS => String::from("apm_metrics"),
+            Self::UnparsedObject(v) => v.value.to_string(),
+        }
+    }
+}
+
+impl Serialize for FormulaAndFunctionApmMetricsDataSource {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        match self {
+            Self::UnparsedObject(v) => v.serialize(serializer),
+            _ => serializer.serialize_str(self.to_string().as_str()),
+        }
+    }
+}
+
+impl<'de> Deserialize<'de> for FormulaAndFunctionApmMetricsDataSource {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let s: String = String::deserialize(deserializer)?;
+        Ok(match s.as_str() {
+            "apm_metrics" => Self::APM_METRICS,
+            _ => Self::UnparsedObject(crate::datadog::UnparsedObject {
+                value: serde_json::Value::String(s.into()),
+            }),
+        })
+    }
+}