Skip to content

Commit eb4688a

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
RUM - simplify cross-product sampling descriptions on rum-retention-filters API docs (#3613)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 3a516a4 commit eb4688a

File tree

7 files changed

+28
-42
lines changed

7 files changed

+28
-42
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -54741,43 +54741,33 @@ components:
5474154741
x-enum-varnames:
5474254742
- RULESET
5474354743
RumCrossProductSampling:
54744-
description: 'Configuration for additional APM trace data retention for sessions
54745-
that match this retention filter.
54746-
54747-
When a session matches the filter and is retained (based on `sample_rate`),
54748-
you can configure
54749-
54750-
the percentage of retained sessions with ingested traces whose traces are
54751-
indexed.'
54744+
description: The configuration for cross-product retention filters.
5475254745
properties:
5475354746
trace_enabled:
54754-
description: Indicates whether trace cross-product sampling is enabled.
54755-
If `false`, no traces are indexed regardless of `trace_sample_rate`.
54747+
description: Whether the cross-product retention filter for APM traces is
54748+
enabled.
5475654749
example: true
5475754750
type: boolean
5475854751
trace_sample_rate:
54759-
description: 'The percentage (0-100) of retained sessions with ingested
54760-
traces whose traces are indexed.
54761-
54762-
For example, 25.0 means 25% of retained sessions with ingested traces
54763-
have their traces indexed.'
54752+
description: The sample rate for the APM cross-product retention filter,
54753+
between 0 and 100.
5476454754
example: 25.0
5476554755
format: double
5476654756
maximum: 100
5476754757
minimum: 0
5476854758
type: number
5476954759
type: object
5477054760
RumCrossProductSamplingCreate:
54771-
description: Configuration for cross-product sampling when creating a retention
54772-
filter.
54761+
description: The configuration for cross-product retention filters.
5477354762
properties:
5477454763
trace_enabled:
54775-
description: Indicates whether trace cross-product sampling is enabled.
54764+
description: Whether the cross-product retention filter for APM traces is
54765+
enabled.
5477654766
example: true
5477754767
type: boolean
5477854768
trace_sample_rate:
54779-
description: The percentage (0-100) of retained sessions with ingested traces
54780-
whose traces are indexed.
54769+
description: The sample rate for the APM cross-product retention filter,
54770+
between 0 and 100.
5478154771
example: 25.0
5478254772
format: double
5478354773
maximum: 100
@@ -54787,16 +54777,17 @@ components:
5478754777
- trace_sample_rate
5478854778
type: object
5478954779
RumCrossProductSamplingUpdate:
54790-
description: Configuration for cross-product sampling when updating a retention
54791-
filter. All fields are optional for partial updates.
54780+
description: The configuration for cross-product retention filters. All fields
54781+
are optional for partial updates.
5479254782
properties:
5479354783
trace_enabled:
54794-
description: Indicates whether trace cross-product sampling is enabled.
54784+
description: Whether the cross-product retention filter for APM traces is
54785+
enabled.
5479554786
example: true
5479654787
type: boolean
5479754788
trace_sample_rate:
54798-
description: The percentage (0-100) of retained sessions with ingested traces
54799-
whose traces are indexed.
54789+
description: The sample rate for the APM cross-product retention filter,
54790+
between 0 and 100.
5480054791
example: 25.0
5480154792
format: double
5480254793
maximum: 100

services/rum_retention_filters/src/v2/models/RumCrossProductSampling.ts

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
import { AttributeTypeMap } from "@datadog/datadog-api-client";
22

33
/**
4-
* Configuration for additional APM trace data retention for sessions that match this retention filter.
5-
* When a session matches the filter and is retained (based on `sample_rate`), you can configure
6-
* the percentage of retained sessions with ingested traces whose traces are indexed.
4+
* The configuration for cross-product retention filters.
75
*/
86
export class RumCrossProductSampling {
97
/**
10-
* Indicates whether trace cross-product sampling is enabled. If `false`, no traces are indexed regardless of `trace_sample_rate`.
8+
* Whether the cross-product retention filter for APM traces is enabled.
119
*/
1210
"traceEnabled"?: boolean;
1311
/**
14-
* The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
15-
* For example, 25.0 means 25% of retained sessions with ingested traces have their traces indexed.
12+
* The sample rate for the APM cross-product retention filter, between 0 and 100.
1613
*/
1714
"traceSampleRate"?: number;
1815
/**

services/rum_retention_filters/src/v2/models/RumCrossProductSamplingCreate.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
import { AttributeTypeMap } from "@datadog/datadog-api-client";
22

33
/**
4-
* Configuration for cross-product sampling when creating a retention filter.
4+
* The configuration for cross-product retention filters.
55
*/
66
export class RumCrossProductSamplingCreate {
77
/**
8-
* Indicates whether trace cross-product sampling is enabled.
8+
* Whether the cross-product retention filter for APM traces is enabled.
99
*/
1010
"traceEnabled"?: boolean;
1111
/**
12-
* The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
12+
* The sample rate for the APM cross-product retention filter, between 0 and 100.
1313
*/
1414
"traceSampleRate": number;
1515
/**

services/rum_retention_filters/src/v2/models/RumCrossProductSamplingUpdate.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
import { AttributeTypeMap } from "@datadog/datadog-api-client";
22

33
/**
4-
* Configuration for cross-product sampling when updating a retention filter. All fields are optional for partial updates.
4+
* The configuration for cross-product retention filters. All fields are optional for partial updates.
55
*/
66
export class RumCrossProductSamplingUpdate {
77
/**
8-
* Indicates whether trace cross-product sampling is enabled.
8+
* Whether the cross-product retention filter for APM traces is enabled.
99
*/
1010
"traceEnabled"?: boolean;
1111
/**
12-
* The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
12+
* The sample rate for the APM cross-product retention filter, between 0 and 100.
1313
*/
1414
"traceSampleRate"?: number;
1515
/**

services/rum_retention_filters/src/v2/models/RumRetentionFilterAttributes.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ import { RumRetentionFilterEventType } from "./RumRetentionFilterEventType";
88
*/
99
export class RumRetentionFilterAttributes {
1010
/**
11-
* Configuration for additional APM trace data retention for sessions that match this retention filter.
12-
* When a session matches the filter and is retained (based on `sample_rate`), you can configure
13-
* the percentage of retained sessions with ingested traces whose traces are indexed.
11+
* The configuration for cross-product retention filters.
1412
*/
1513
"crossProductSampling"?: RumCrossProductSampling;
1614
/**

services/rum_retention_filters/src/v2/models/RumRetentionFilterCreateAttributes.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { RumRetentionFilterEventType } from "./RumRetentionFilterEventType";
88
*/
99
export class RumRetentionFilterCreateAttributes {
1010
/**
11-
* Configuration for cross-product sampling when creating a retention filter.
11+
* The configuration for cross-product retention filters.
1212
*/
1313
"crossProductSampling"?: RumCrossProductSamplingCreate;
1414
/**

services/rum_retention_filters/src/v2/models/RumRetentionFilterUpdateAttributes.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { RumRetentionFilterEventType } from "./RumRetentionFilterEventType";
88
*/
99
export class RumRetentionFilterUpdateAttributes {
1010
/**
11-
* Configuration for cross-product sampling when updating a retention filter. All fields are optional for partial updates.
11+
* The configuration for cross-product retention filters. All fields are optional for partial updates.
1212
*/
1313
"crossProductSampling"?: RumCrossProductSamplingUpdate;
1414
/**

0 commit comments

Comments
 (0)