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

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:

api/datadogV1/model_formula_and_function_apm_metric_stat_name.go

@@ -0,0 +1,94 @@
+// 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 datadogV1
+
+import (
+	"fmt"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+)
+
+// FormulaAndFunctionApmMetricStatName APM metric stat name.
+type FormulaAndFunctionApmMetricStatName string
+
+// List of FormulaAndFunctionApmMetricStatName.
+const (
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_ERRORS               FormulaAndFunctionApmMetricStatName = "errors"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_ERROR_RATE           FormulaAndFunctionApmMetricStatName = "error_rate"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_ERRORS_PER_SECOND    FormulaAndFunctionApmMetricStatName = "errors_per_second"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_AVG          FormulaAndFunctionApmMetricStatName = "latency_avg"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_MAX          FormulaAndFunctionApmMetricStatName = "latency_max"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P50          FormulaAndFunctionApmMetricStatName = "latency_p50"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P75          FormulaAndFunctionApmMetricStatName = "latency_p75"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P90          FormulaAndFunctionApmMetricStatName = "latency_p90"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P95          FormulaAndFunctionApmMetricStatName = "latency_p95"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P99          FormulaAndFunctionApmMetricStatName = "latency_p99"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P999         FormulaAndFunctionApmMetricStatName = "latency_p999"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_DISTRIBUTION FormulaAndFunctionApmMetricStatName = "latency_distribution"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_HITS                 FormulaAndFunctionApmMetricStatName = "hits"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_HITS_PER_SECOND      FormulaAndFunctionApmMetricStatName = "hits_per_second"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_TOTAL_TIME           FormulaAndFunctionApmMetricStatName = "total_time"
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_APDEX                FormulaAndFunctionApmMetricStatName = "apdex"
+)
+
+var allowedFormulaAndFunctionApmMetricStatNameEnumValues = []FormulaAndFunctionApmMetricStatName{
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_ERRORS,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_ERROR_RATE,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_ERRORS_PER_SECOND,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_AVG,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_MAX,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P50,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P75,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P90,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P95,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P99,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_P999,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_LATENCY_DISTRIBUTION,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_HITS,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_HITS_PER_SECOND,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_TOTAL_TIME,
+	FORMULAANDFUNCTIONAPMMETRICSTATNAME_APDEX,
+}
+
+// GetAllowedValues reeturns the list of possible values.
+func (v *FormulaAndFunctionApmMetricStatName) GetAllowedValues() []FormulaAndFunctionApmMetricStatName {
+	return allowedFormulaAndFunctionApmMetricStatNameEnumValues
+}
+
+// UnmarshalJSON deserializes the given payload.
+func (v *FormulaAndFunctionApmMetricStatName) UnmarshalJSON(src []byte) error {
+	var value string
+	err := datadog.Unmarshal(src, &value)
+	if err != nil {
+		return err
+	}
+	*v = FormulaAndFunctionApmMetricStatName(value)
+	return nil
+}
+
+// NewFormulaAndFunctionApmMetricStatNameFromValue returns a pointer to a valid FormulaAndFunctionApmMetricStatName
+// for the value passed as argument, or an error if the value passed is not allowed by the enum.
+func NewFormulaAndFunctionApmMetricStatNameFromValue(v string) (*FormulaAndFunctionApmMetricStatName, error) {
+	ev := FormulaAndFunctionApmMetricStatName(v)
+	if ev.IsValid() {
+		return &ev, nil
+	}
+	return nil, fmt.Errorf("invalid value '%v' for FormulaAndFunctionApmMetricStatName: valid values are %v", v, allowedFormulaAndFunctionApmMetricStatNameEnumValues)
+}
+
+// IsValid return true if the value is valid for the enum, false otherwise.
+func (v FormulaAndFunctionApmMetricStatName) IsValid() bool {
+	for _, existing := range allowedFormulaAndFunctionApmMetricStatNameEnumValues {
+		if existing == v {
+			return true
+		}
+	}
+	return false
+}
+
+// Ptr returns reference to FormulaAndFunctionApmMetricStatName value.
+func (v FormulaAndFunctionApmMetricStatName) Ptr() *FormulaAndFunctionApmMetricStatName {
+	return &v
+}

api/datadogV1/model_formula_and_function_apm_metrics_data_source.go

@@ -0,0 +1,64 @@
+// 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 datadogV1
+
+import (
+	"fmt"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+)
+
+// FormulaAndFunctionApmMetricsDataSource Data source for APM metrics queries.
+type FormulaAndFunctionApmMetricsDataSource string
+
+// List of FormulaAndFunctionApmMetricsDataSource.
+const (
+	FORMULAANDFUNCTIONAPMMETRICSDATASOURCE_APM_METRICS FormulaAndFunctionApmMetricsDataSource = "apm_metrics"
+)
+
+var allowedFormulaAndFunctionApmMetricsDataSourceEnumValues = []FormulaAndFunctionApmMetricsDataSource{
+	FORMULAANDFUNCTIONAPMMETRICSDATASOURCE_APM_METRICS,
+}
+
+// GetAllowedValues reeturns the list of possible values.
+func (v *FormulaAndFunctionApmMetricsDataSource) GetAllowedValues() []FormulaAndFunctionApmMetricsDataSource {
+	return allowedFormulaAndFunctionApmMetricsDataSourceEnumValues
+}
+
+// UnmarshalJSON deserializes the given payload.
+func (v *FormulaAndFunctionApmMetricsDataSource) UnmarshalJSON(src []byte) error {
+	var value string
+	err := datadog.Unmarshal(src, &value)
+	if err != nil {
+		return err
+	}
+	*v = FormulaAndFunctionApmMetricsDataSource(value)
+	return nil
+}
+
+// NewFormulaAndFunctionApmMetricsDataSourceFromValue returns a pointer to a valid FormulaAndFunctionApmMetricsDataSource
+// for the value passed as argument, or an error if the value passed is not allowed by the enum.
+func NewFormulaAndFunctionApmMetricsDataSourceFromValue(v string) (*FormulaAndFunctionApmMetricsDataSource, error) {
+	ev := FormulaAndFunctionApmMetricsDataSource(v)
+	if ev.IsValid() {
+		return &ev, nil
+	}
+	return nil, fmt.Errorf("invalid value '%v' for FormulaAndFunctionApmMetricsDataSource: valid values are %v", v, allowedFormulaAndFunctionApmMetricsDataSourceEnumValues)
+}
+
+// IsValid return true if the value is valid for the enum, false otherwise.
+func (v FormulaAndFunctionApmMetricsDataSource) IsValid() bool {
+	for _, existing := range allowedFormulaAndFunctionApmMetricsDataSourceEnumValues {
+		if existing == v {
+			return true
+		}
+	}
+	return false
+}
+
+// Ptr returns reference to FormulaAndFunctionApmMetricsDataSource value.
+func (v FormulaAndFunctionApmMetricsDataSource) Ptr() *FormulaAndFunctionApmMetricsDataSource {
+	return &v
+}