diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 0c5157064ef..a62c48acea1 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -2190,13 +2190,18 @@ components: type: integer TraceIDPathParameter: description: |- - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) - or a decimal string of up to 39 digits. + The trace ID. Accepts either a hexadecimal string of up to 32 characters (128-bit trace ID) + or a decimal string of up to 39 digits. Hexadecimal IDs are case-insensitive, and shorter + values are left-padded with zeros. + Use the `trace_id` attribute of a span returned by the Search spans or Get a list of spans endpoints. + Values in any other format, such as UUIDs, return `400 Bad Request`. A well-formed ID with + no matching trace returns `404 Not Found`. example: "0000000000000000abc1230000000000" in: path name: trace_id required: true schema: + pattern: "^([0-9a-fA-F]{1,32}|[0-9]{1,39})$" type: string UnitCostID: description: The UUID of the unit cost. @@ -123792,8 +123797,11 @@ components: type: string x-enum-varnames: ["DONE", "TIMEOUT"] SpansAggregateSort: - description: A sort rule. - example: {"aggregation": "count", "order": "asc"} + description: |- + A sort rule. With `type: alphabetical` (the default), buckets are sorted by facet value + and only `order` is allowed. With `type: measure`, buckets are sorted by a computed value: + set `aggregation`, and set `metric` unless the aggregation is `count`. + example: {"aggregation": "pc90", "metric": "@duration", "order": "desc", "type": "measure"} properties: aggregation: $ref: "#/components/schemas/SpansAggregationFunction" @@ -123903,7 +123911,10 @@ components: type: string type: object SpansCompute: - description: A compute rule to compute metrics or timeseries. + description: |- + A compute rule to compute metrics or timeseries. + All computes in a request must have the same `type`, and `timeseries` computes must use the same `interval`. + To get both totals and timeseries, send separate requests. properties: aggregation: $ref: "#/components/schemas/SpansAggregationFunction" @@ -123957,7 +123968,12 @@ components: $ref: "#/components/schemas/SpansGroupByHistogram" limit: default: 10 - description: The maximum buckets to return for this group by. + description: |- + The maximum buckets to return for this group by. + A request can generate at most 10,000 groups. Nested `group_by` entries multiply, so the + product of their limits must stay within that bound. For example, two entries with a limit of 100 each + produce up to 10,000 groups. With a `timeseries` compute, the number of groups multiplied by + the number of time buckets must not exceed 400,000. format: int64 type: integer missing: @@ -212855,6 +212871,8 @@ paths: Retrieve a pruned, hierarchical view of an APM trace by its trace ID. The trace is summarized as a tree of spans rooted at the trace root and reduced in size to keep rendering large traces in the UI practical. + A `400 Bad Request` response means the trace ID is malformed. A `404 Not Found` response means + no trace with this ID is available, such as when the trace is outside the retention period. This endpoint is rate limited to `60` requests per minute per organization. operationId: GetPrunedTraceByID parameters: @@ -212967,6 +212985,12 @@ paths: schema: $ref: "#/components/schemas/PrunedTraceResponse" description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request "403": content: application/json: @@ -237716,6 +237740,11 @@ paths: description: |- The API endpoint to aggregate spans into buckets and compute metrics and timeseries. This endpoint is rate limited to `300` requests per hour. + + A request can generate at most 10,000 groups across all `group_by` entries, or 400,000 groups + including time buckets when a `timeseries` compute is used. Set `limit` on each `group_by` entry + to stay within these bounds. Requests over long time ranges or with many groups are more resource-intensive + and can fail. To reduce load, narrow the time range or lower the `limit` on each `group_by` entry. operationId: AggregateSpans requestBody: content: @@ -237735,14 +237764,13 @@ paths: query: service:web* AND @http.status_code:[200 TO 299] to: now group_by: - - facet: host - histogram: - interval: 10 - max: 100 - min: 50 + - facet: service + limit: 20 sort: - aggregation: count - order: asc + aggregation: pc90 + metric: "@duration" + order: desc + type: measure options: timezone: GMT type: aggregate_request @@ -247816,6 +247844,8 @@ paths: description: |- Retrieve a full APM trace by its trace ID, including every span in the trace. Traces are returned from live storage when available and fall back to longer-term storage. + A `400 Bad Request` response means the trace ID is malformed. A `404 Not Found` response means + no trace with this ID is available, such as when the trace is outside the retention period. This endpoint is rate limited to `60` requests per minute per organization. operationId: GetTraceByID parameters: @@ -247866,6 +247896,12 @@ paths: schema: $ref: "#/components/schemas/TraceResponse" description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request "403": content: application/json: diff --git a/src/main/java/com/datadog/api/client/v2/api/ApmTraceApi.java b/src/main/java/com/datadog/api/client/v2/api/ApmTraceApi.java index 82e12e56001..8bb202ffe91 100644 --- a/src/main/java/com/datadog/api/client/v2/api/ApmTraceApi.java +++ b/src/main/java/com/datadog/api/client/v2/api/ApmTraceApi.java @@ -146,8 +146,12 @@ public GetPrunedTraceByIDOptionalParameters onlyServiceEntrySpans( * *

See {@link #getPrunedTraceByIDWithHttpInfo}. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @return PrunedTraceResponse * @throws ApiException if fails to make API call */ @@ -161,8 +165,12 @@ public PrunedTraceResponse getPrunedTraceByID(String traceId) throws ApiExceptio * *

See {@link #getPrunedTraceByIDWithHttpInfoAsync}. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @return CompletableFuture<PrunedTraceResponse> */ public CompletableFuture getPrunedTraceByIDAsync(String traceId) { @@ -178,8 +186,12 @@ public CompletableFuture getPrunedTraceByIDAsync(String tra * *

See {@link #getPrunedTraceByIDWithHttpInfo}. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @param parameters Optional parameters for the request. * @return PrunedTraceResponse * @throws ApiException if fails to make API call @@ -194,8 +206,12 @@ public PrunedTraceResponse getPrunedTraceByID( * *

See {@link #getPrunedTraceByIDWithHttpInfoAsync}. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<PrunedTraceResponse> */ @@ -211,11 +227,17 @@ public CompletableFuture getPrunedTraceByIDAsync( /** * Retrieve a pruned, hierarchical view of an APM trace by its trace ID. The trace is summarized * as a tree of spans rooted at the trace root and reduced in size to keep rendering large traces - * in the UI practical. This endpoint is rate limited to 60 requests per minute per - * organization. + * in the UI practical. A 400 Bad Request response means the trace ID is malformed. A + * 404 Not Found response means no trace with this ID is available, such as when the + * trace is outside the retention period. This endpoint is rate limited to 60 + * requests per minute per organization. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @param parameters Optional parameters for the request. * @return ApiResponse<PrunedTraceResponse> * @throws ApiException if fails to make API call @@ -224,6 +246,7 @@ public CompletableFuture getPrunedTraceByIDAsync( * Response details * Status Code Description Response Headers * 200 OK - + * 400 Bad Request - * 403 Forbidden - * 404 Not Found - * 429 Too many requests - @@ -295,8 +318,12 @@ public ApiResponse getPrunedTraceByIDWithHttpInfo( * *

See {@link #getPrunedTraceByIDWithHttpInfo}. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<ApiResponse<PrunedTraceResponse>> */ @@ -396,8 +423,12 @@ public GetTraceByIDOptionalParameters includeFields(List includeFields) * *

See {@link #getTraceByIDWithHttpInfo}. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @return TraceResponse * @throws ApiException if fails to make API call */ @@ -410,8 +441,12 @@ public TraceResponse getTraceByID(String traceId) throws ApiException { * *

See {@link #getTraceByIDWithHttpInfoAsync}. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @return CompletableFuture<TraceResponse> */ public CompletableFuture getTraceByIDAsync(String traceId) { @@ -427,8 +462,12 @@ public CompletableFuture getTraceByIDAsync(String traceId) { * *

See {@link #getTraceByIDWithHttpInfo}. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @param parameters Optional parameters for the request. * @return TraceResponse * @throws ApiException if fails to make API call @@ -443,8 +482,12 @@ public TraceResponse getTraceByID(String traceId, GetTraceByIDOptionalParameters * *

See {@link #getTraceByIDWithHttpInfoAsync}. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<TraceResponse> */ @@ -459,11 +502,18 @@ public CompletableFuture getTraceByIDAsync( /** * Retrieve a full APM trace by its trace ID, including every span in the trace. Traces are - * returned from live storage when available and fall back to longer-term storage. This endpoint - * is rate limited to 60 requests per minute per organization. + * returned from live storage when available and fall back to longer-term storage. A + * 400 Bad Request response means the trace ID is malformed. A 404 Not Found + * response means no trace with this ID is available, such as when the trace is outside the + * retention period. This endpoint is rate limited to 60 requests per minute per + * organization. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @param parameters Optional parameters for the request. * @return ApiResponse<TraceResponse> * @throws ApiException if fails to make API call @@ -472,6 +522,7 @@ public CompletableFuture getTraceByIDAsync( * Response details * Status Code Description Response Headers * 200 OK - + * 400 Bad Request - * 403 Forbidden - * 404 Not Found - * 413 Payload Too Large - @@ -531,8 +582,12 @@ public ApiResponse getTraceByIDWithHttpInfo( * *

See {@link #getTraceByIDWithHttpInfo}. * - * @param traceId The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace - * ID) or a decimal string of up to 39 digits. (required) + * @param traceId The trace ID. Accepts either a hexadecimal string of up to 32 characters + * (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are + * case-insensitive, and shorter values are left-padded with zeros. Use the trace_id + * attribute of a span returned by the Search spans or Get a list of spans endpoints. + * Values in any other format, such as UUIDs, return 400 Bad Request. A + * well-formed ID with no matching trace returns 404 Not Found. (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<ApiResponse<TraceResponse>> */ diff --git a/src/main/java/com/datadog/api/client/v2/api/SpansApi.java b/src/main/java/com/datadog/api/client/v2/api/SpansApi.java index acd5fcce65c..b21bd6a88f4 100644 --- a/src/main/java/com/datadog/api/client/v2/api/SpansApi.java +++ b/src/main/java/com/datadog/api/client/v2/api/SpansApi.java @@ -87,6 +87,13 @@ public CompletableFuture aggregateSpansAsync(SpansAggreg * The API endpoint to aggregate spans into buckets and compute metrics and timeseries. This * endpoint is rate limited to 300 requests per hour. * + *

A request can generate at most 10,000 groups across all group_by entries, or + * 400,000 groups including time buckets when a timeseries compute is used. Set + * limit on each group_by entry to stay within these bounds. Requests + * over long time ranges or with many groups are more resource-intensive and can fail. To reduce + * load, narrow the time range or lower the limit on each group_by + * entry. + * * @param body (required) * @return ApiResponse<SpansAggregateResponse> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/datadog/api/client/v2/model/SpansAggregateSort.java b/src/main/java/com/datadog/api/client/v2/model/SpansAggregateSort.java index 11a3eb786a5..c90b411f062 100644 --- a/src/main/java/com/datadog/api/client/v2/model/SpansAggregateSort.java +++ b/src/main/java/com/datadog/api/client/v2/model/SpansAggregateSort.java @@ -16,7 +16,12 @@ import java.util.Map; import java.util.Objects; -/** A sort rule. */ +/** + * A sort rule. With type: alphabetical (the default), buckets are sorted by facet + * value and only order is allowed. With type: measure, buckets are sorted + * by a computed value: set aggregation, and set metric unless the + * aggregation is count. + */ @JsonPropertyOrder({ SpansAggregateSort.JSON_PROPERTY_AGGREGATION, SpansAggregateSort.JSON_PROPERTY_METRIC, diff --git a/src/main/java/com/datadog/api/client/v2/model/SpansCompute.java b/src/main/java/com/datadog/api/client/v2/model/SpansCompute.java index 861a897b0ea..f6dfb2a3e12 100644 --- a/src/main/java/com/datadog/api/client/v2/model/SpansCompute.java +++ b/src/main/java/com/datadog/api/client/v2/model/SpansCompute.java @@ -17,7 +17,11 @@ import java.util.Map; import java.util.Objects; -/** A compute rule to compute metrics or timeseries. */ +/** + * A compute rule to compute metrics or timeseries. All computes in a request must have the same + * type, and timeseries computes must use the same interval. + * To get both totals and timeseries, send separate requests. + */ @JsonPropertyOrder({ SpansCompute.JSON_PROPERTY_AGGREGATION, SpansCompute.JSON_PROPERTY_INTERVAL, diff --git a/src/main/java/com/datadog/api/client/v2/model/SpansGroupBy.java b/src/main/java/com/datadog/api/client/v2/model/SpansGroupBy.java index 284312eef64..dfa3189345d 100644 --- a/src/main/java/com/datadog/api/client/v2/model/SpansGroupBy.java +++ b/src/main/java/com/datadog/api/client/v2/model/SpansGroupBy.java @@ -107,7 +107,11 @@ public SpansGroupBy limit(Long limit) { } /** - * The maximum buckets to return for this group by. + * The maximum buckets to return for this group by. A request can generate at most 10,000 groups. + * Nested group_by entries multiply, so the product of their limits must stay within + * that bound. For example, two entries with a limit of 100 each produce up to 10,000 groups. With + * a timeseries compute, the number of groups multiplied by the number of time + * buckets must not exceed 400,000. * * @return limit */ @@ -154,7 +158,10 @@ public SpansGroupBy sort(SpansAggregateSort sort) { } /** - * A sort rule. + * A sort rule. With type: alphabetical (the default), buckets are sorted by facet + * value and only order is allowed. With type: measure, buckets are + * sorted by a computed value: set aggregation, and set metric unless + * the aggregation is count. * * @return sort */ diff --git a/src/test/resources/com/datadog/api/client/v2/api/apm_trace.feature b/src/test/resources/com/datadog/api/client/v2/api/apm_trace.feature index 367d6473226..52f4cd392e9 100644 --- a/src/test/resources/com/datadog/api/client/v2/api/apm_trace.feature +++ b/src/test/resources/com/datadog/api/client/v2/api/apm_trace.feature @@ -7,6 +7,14 @@ Feature: APM Trace And a valid "appKeyAuth" key in the system And an instance of "APMTrace" API + @generated @skip @team:ddoghq/apm-reliability + Scenario: Get a pruned trace by ID returns "Bad Request" response + Given operation "GetPrunedTraceByID" enabled + And new "GetPrunedTraceByID" request + And request contains "trace_id" parameter from "REPLACE.ME" + When the request is sent + Then the response status is 400 Bad Request + @generated @skip @team:ddoghq/apm-reliability Scenario: Get a pruned trace by ID returns "Not Found" response Given operation "GetPrunedTraceByID" enabled @@ -23,6 +31,14 @@ Feature: APM Trace When the request is sent Then the response status is 200 OK + @generated @skip @team:ddoghq/apm-reliability + Scenario: Get a trace by ID returns "Bad Request" response + Given operation "GetTraceByID" enabled + And new "GetTraceByID" request + And request contains "trace_id" parameter from "REPLACE.ME" + When the request is sent + Then the response status is 400 Bad Request + @generated @skip @team:ddoghq/apm-reliability Scenario: Get a trace by ID returns "Not Found" response Given operation "GetTraceByID" enabled