Skip to content

Commit b597057

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add Network Path fields to usage summary API (#3569)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 5ce053c commit b597057

13 files changed

+336
-0
lines changed

.generator/schemas/v1/openapi.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22294,6 +22294,11 @@ components:
2229422294
wireless devices over all hours in the current date for all organizations.
2229522295
format: int64
2229622296
type: integer
22297+
network_path_sum:
22298+
description: Shows the sum of all Network Path scheduled tests over all
22299+
hours in the current date for all organizations.
22300+
format: int64
22301+
type: integer
2229722302
npm_host_top99p:
2229822303
description: Shows the 99th percentile of all distinct Cloud Network Monitoring
2229922304
hosts (formerly known as Network hosts) over all hours in the current
@@ -23462,6 +23467,11 @@ components:
2346223467
wireless devices over all hours in the current date for the given org.
2346323468
format: int64
2346423469
type: integer
23470+
network_path_sum:
23471+
description: Shows the sum of all Network Path scheduled tests over all
23472+
hours in the current date for the given org.
23473+
format: int64
23474+
type: integer
2346523475
npm_host_top99p:
2346623476
description: Shows the 99th percentile of all distinct Cloud Network Monitoring
2346723477
hosts (formerly known as Network hosts) over all hours in the current
@@ -24650,6 +24660,11 @@ components:
2465024660
wireless devices over all hours in the current month for all organizations.
2465124661
format: int64
2465224662
type: integer
24663+
network_path_agg_sum:
24664+
description: Shows the sum of all Network Path scheduled tests over all
24665+
hours in the current month for all organizations.
24666+
format: int64
24667+
type: integer
2465324668
npm_host_top99p_sum:
2465424669
description: Shows the 99th percentile of all distinct Cloud Network Monitoring
2465524670
hosts (formerly known as Network hosts) over all hours in the current

.generator/schemas/v2/openapi.yaml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54739,6 +54739,69 @@ components:
5473954739
type: string
5474054740
x-enum-varnames:
5474154741
- RULESET
54742+
RumCrossProductSampling:
54743+
description: 'Configuration for additional APM trace data retention for sessions
54744+
that match this retention filter.
54745+
54746+
When a session matches the filter and is retained (based on `sample_rate`),
54747+
you can configure
54748+
54749+
the percentage of retained sessions with ingested traces whose traces are
54750+
indexed.'
54751+
properties:
54752+
trace_enabled:
54753+
description: Indicates whether trace cross-product sampling is enabled.
54754+
If `false`, no traces are indexed regardless of `trace_sample_rate`.
54755+
example: true
54756+
type: boolean
54757+
trace_sample_rate:
54758+
description: 'The percentage (0-100) of retained sessions with ingested
54759+
traces whose traces are indexed.
54760+
54761+
For example, 25.0 means 25% of retained sessions with ingested traces
54762+
have their traces indexed.'
54763+
example: 25.0
54764+
format: double
54765+
maximum: 100
54766+
minimum: 0
54767+
type: number
54768+
type: object
54769+
RumCrossProductSamplingCreate:
54770+
description: Configuration for cross-product sampling when creating a retention
54771+
filter.
54772+
properties:
54773+
trace_enabled:
54774+
description: Indicates whether trace cross-product sampling is enabled.
54775+
example: true
54776+
type: boolean
54777+
trace_sample_rate:
54778+
description: The percentage (0-100) of retained sessions with ingested traces
54779+
whose traces are indexed.
54780+
example: 25.0
54781+
format: double
54782+
maximum: 100
54783+
minimum: 0
54784+
type: number
54785+
required:
54786+
- trace_sample_rate
54787+
type: object
54788+
RumCrossProductSamplingUpdate:
54789+
description: Configuration for cross-product sampling when updating a retention
54790+
filter. All fields are optional for partial updates.
54791+
properties:
54792+
trace_enabled:
54793+
description: Indicates whether trace cross-product sampling is enabled.
54794+
example: true
54795+
type: boolean
54796+
trace_sample_rate:
54797+
description: The percentage (0-100) of retained sessions with ingested traces
54798+
whose traces are indexed.
54799+
example: 25.0
54800+
format: double
54801+
maximum: 100
54802+
minimum: 0
54803+
type: number
54804+
type: object
5474254805
RumMetricCompute:
5474354806
description: The compute rule to compute the rum-based metric.
5474454807
properties:
@@ -55026,6 +55089,8 @@ components:
5502655089
RumRetentionFilterAttributes:
5502755090
description: The object describing attributes of a RUM retention filter.
5502855091
properties:
55092+
cross_product_sampling:
55093+
$ref: '#/components/schemas/RumCrossProductSampling'
5502955094
enabled:
5503055095
$ref: '#/components/schemas/RumRetentionFilterEnabled'
5503155096
event_type:
@@ -55040,6 +55105,8 @@ components:
5504055105
RumRetentionFilterCreateAttributes:
5504155106
description: The object describing attributes of a RUM retention filter to create.
5504255107
properties:
55108+
cross_product_sampling:
55109+
$ref: '#/components/schemas/RumCrossProductSamplingCreate'
5504355110
enabled:
5504455111
$ref: '#/components/schemas/RumRetentionFilterEnabled'
5504555112
event_type:
@@ -55141,6 +55208,8 @@ components:
5514155208
RumRetentionFilterUpdateAttributes:
5514255209
description: The object describing attributes of a RUM retention filter to update.
5514355210
properties:
55211+
cross_product_sampling:
55212+
$ref: '#/components/schemas/RumCrossProductSamplingUpdate'
5514455213
enabled:
5514555214
$ref: '#/components/schemas/RumRetentionFilterEnabled'
5514655215
event_type:

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,10 @@ export class UsageSummaryDate {
511511
* Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current date for all organizations.
512512
*/
513513
"networkDeviceWirelessTop99p"?: number;
514+
/**
515+
* Shows the sum of all Network Path scheduled tests over all hours in the current date for all organizations.
516+
*/
517+
"networkPathSum"?: number;
514518
/**
515519
* Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current date for all organizations.
516520
*/
@@ -1513,6 +1517,11 @@ export class UsageSummaryDate {
15131517
type: "number",
15141518
format: "int64",
15151519
},
1520+
networkPathSum: {
1521+
baseName: "network_path_sum",
1522+
type: "number",
1523+
format: "int64",
1524+
},
15161525
npmHostTop99p: {
15171526
baseName: "npm_host_top99p",
15181527
type: "number",

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -530,6 +530,10 @@ export class UsageSummaryDateOrg {
530530
* Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current date for the given org.
531531
*/
532532
"networkDeviceWirelessTop99p"?: number;
533+
/**
534+
* Shows the sum of all Network Path scheduled tests over all hours in the current date for the given org.
535+
*/
536+
"networkPathSum"?: number;
533537
/**
534538
* Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current date for the given org.
535539
*/
@@ -1557,6 +1561,11 @@ export class UsageSummaryDateOrg {
15571561
type: "number",
15581562
format: "int64",
15591563
},
1564+
networkPathSum: {
1565+
baseName: "network_path_sum",
1566+
type: "number",
1567+
format: "int64",
1568+
},
15601569
npmHostTop99p: {
15611570
baseName: "npm_host_top99p",
15621571
type: "number",

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -540,6 +540,10 @@ export class UsageSummaryResponse {
540540
* Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current month for all organizations.
541541
*/
542542
"networkDeviceWirelessTop99pSum"?: number;
543+
/**
544+
* Shows the sum of all Network Path scheduled tests over all hours in the current month for all organizations.
545+
*/
546+
"networkPathAggSum"?: number;
543547
/**
544548
* Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current month for all organizations.
545549
*/
@@ -1593,6 +1597,11 @@ export class UsageSummaryResponse {
15931597
type: "number",
15941598
format: "int64",
15951599
},
1600+
networkPathAggSum: {
1601+
baseName: "network_path_agg_sum",
1602+
type: "number",
1603+
format: "int64",
1604+
},
15961605
npmHostTop99pSum: {
15971606
baseName: "npm_host_top99p_sum",
15981607
type: "number",

packages/datadog-api-client-v2/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4605,6 +4605,9 @@ export { RUMApplicationUpdateType } from "./models/RUMApplicationUpdateType";
46054605
export { RUMBucketResponse } from "./models/RUMBucketResponse";
46064606
export { RUMCompute } from "./models/RUMCompute";
46074607
export { RUMComputeType } from "./models/RUMComputeType";
4608+
export { RumCrossProductSampling } from "./models/RumCrossProductSampling";
4609+
export { RumCrossProductSamplingCreate } from "./models/RumCrossProductSamplingCreate";
4610+
export { RumCrossProductSamplingUpdate } from "./models/RumCrossProductSamplingUpdate";
46084611
export { RUMEvent } from "./models/RUMEvent";
46094612
export { RUMEventAttributes } from "./models/RUMEventAttributes";
46104613
export { RUMEventProcessingScale } from "./models/RUMEventProcessingScale";

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2599,6 +2599,9 @@ import { RulesetRespDataAttributesRulesItemsQuery } from "./RulesetRespDataAttri
25992599
import { RulesetRespDataAttributesRulesItemsQueryAddition } from "./RulesetRespDataAttributesRulesItemsQueryAddition";
26002600
import { RulesetRespDataAttributesRulesItemsReferenceTable } from "./RulesetRespDataAttributesRulesItemsReferenceTable";
26012601
import { RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems } from "./RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems";
2602+
import { RumCrossProductSampling } from "./RumCrossProductSampling";
2603+
import { RumCrossProductSamplingCreate } from "./RumCrossProductSamplingCreate";
2604+
import { RumCrossProductSamplingUpdate } from "./RumCrossProductSamplingUpdate";
26022605
import { RumMetricCompute } from "./RumMetricCompute";
26032606
import { RumMetricCreateAttributes } from "./RumMetricCreateAttributes";
26042607
import { RumMetricCreateData } from "./RumMetricCreateData";
@@ -8566,6 +8569,9 @@ const typeMap: { [index: string]: any } = {
85668569
RulesetRespDataAttributesRulesItemsReferenceTable,
85678570
RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems:
85688571
RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems,
8572+
RumCrossProductSampling: RumCrossProductSampling,
8573+
RumCrossProductSamplingCreate: RumCrossProductSamplingCreate,
8574+
RumCrossProductSamplingUpdate: RumCrossProductSamplingUpdate,
85698575
RumMetricCompute: RumMetricCompute,
85708576
RumMetricCreateAttributes: RumMetricCreateAttributes,
85718577
RumMetricCreateData: RumMetricCreateData,
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
7+
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
8+
9+
/**
10+
* Configuration for additional APM trace data retention for sessions that match this retention filter.
11+
* When a session matches the filter and is retained (based on `sample_rate`), you can configure
12+
* the percentage of retained sessions with ingested traces whose traces are indexed.
13+
*/
14+
export class RumCrossProductSampling {
15+
/**
16+
* Indicates whether trace cross-product sampling is enabled. If `false`, no traces are indexed regardless of `trace_sample_rate`.
17+
*/
18+
"traceEnabled"?: boolean;
19+
/**
20+
* The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
21+
* For example, 25.0 means 25% of retained sessions with ingested traces have their traces indexed.
22+
*/
23+
"traceSampleRate"?: number;
24+
25+
/**
26+
* A container for additional, undeclared properties.
27+
* This is a holder for any undeclared properties as specified with
28+
* the 'additionalProperties' keyword in the OAS document.
29+
*/
30+
"additionalProperties"?: { [key: string]: any };
31+
32+
/**
33+
* @ignore
34+
*/
35+
"_unparsed"?: boolean;
36+
37+
/**
38+
* @ignore
39+
*/
40+
static readonly attributeTypeMap: AttributeTypeMap = {
41+
traceEnabled: {
42+
baseName: "trace_enabled",
43+
type: "boolean",
44+
},
45+
traceSampleRate: {
46+
baseName: "trace_sample_rate",
47+
type: "number",
48+
format: "double",
49+
},
50+
additionalProperties: {
51+
baseName: "additionalProperties",
52+
type: "{ [key: string]: any; }",
53+
},
54+
};
55+
56+
/**
57+
* @ignore
58+
*/
59+
static getAttributeTypeMap(): AttributeTypeMap {
60+
return RumCrossProductSampling.attributeTypeMap;
61+
}
62+
63+
public constructor() {}
64+
}
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
7+
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
8+
9+
/**
10+
* Configuration for cross-product sampling when creating a retention filter.
11+
*/
12+
export class RumCrossProductSamplingCreate {
13+
/**
14+
* Indicates whether trace cross-product sampling is enabled.
15+
*/
16+
"traceEnabled"?: boolean;
17+
/**
18+
* The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
19+
*/
20+
"traceSampleRate": number;
21+
22+
/**
23+
* A container for additional, undeclared properties.
24+
* This is a holder for any undeclared properties as specified with
25+
* the 'additionalProperties' keyword in the OAS document.
26+
*/
27+
"additionalProperties"?: { [key: string]: any };
28+
29+
/**
30+
* @ignore
31+
*/
32+
"_unparsed"?: boolean;
33+
34+
/**
35+
* @ignore
36+
*/
37+
static readonly attributeTypeMap: AttributeTypeMap = {
38+
traceEnabled: {
39+
baseName: "trace_enabled",
40+
type: "boolean",
41+
},
42+
traceSampleRate: {
43+
baseName: "trace_sample_rate",
44+
type: "number",
45+
required: true,
46+
format: "double",
47+
},
48+
additionalProperties: {
49+
baseName: "additionalProperties",
50+
type: "{ [key: string]: any; }",
51+
},
52+
};
53+
54+
/**
55+
* @ignore
56+
*/
57+
static getAttributeTypeMap(): AttributeTypeMap {
58+
return RumCrossProductSamplingCreate.attributeTypeMap;
59+
}
60+
61+
public constructor() {}
62+
}

0 commit comments

Comments
 (0)