Skip to content

Commit 71db329

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

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

src/datadog_api_client/v2/model/rum_cross_product_sampling.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,12 @@ def __init__(
4040
**kwargs,
4141
):
4242
"""
43-
Configuration for additional APM trace data retention for sessions that match this retention filter.
44-
When a session matches the filter and is retained (based on ``sample_rate`` ), you can configure
45-
the percentage of retained sessions with ingested traces whose traces are indexed.
43+
The configuration for cross-product retention filters.
4644
47-
:param trace_enabled: Indicates whether trace cross-product sampling is enabled. If ``false`` , no traces are indexed regardless of ``trace_sample_rate``.
45+
:param trace_enabled: Whether the cross-product retention filter for APM traces is enabled.
4846
:type trace_enabled: bool, optional
4947
50-
:param trace_sample_rate: The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
51-
For example, 25.0 means 25% of retained sessions with ingested traces have their traces indexed.
48+
:param trace_sample_rate: The sample rate for the APM cross-product retention filter, between 0 and 100.
5249
:type trace_sample_rate: float, optional
5350
"""
5451
if trace_enabled is not unset:

src/datadog_api_client/v2/model/rum_cross_product_sampling_create.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ def openapi_types(_):
3535

3636
def __init__(self_, trace_sample_rate: float, trace_enabled: Union[bool, UnsetType] = unset, **kwargs):
3737
"""
38-
Configuration for cross-product sampling when creating a retention filter.
38+
The configuration for cross-product retention filters.
3939
40-
:param trace_enabled: Indicates whether trace cross-product sampling is enabled.
40+
:param trace_enabled: Whether the cross-product retention filter for APM traces is enabled.
4141
:type trace_enabled: bool, optional
4242
43-
:param trace_sample_rate: The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
43+
:param trace_sample_rate: The sample rate for the APM cross-product retention filter, between 0 and 100.
4444
:type trace_sample_rate: float
4545
"""
4646
if trace_enabled is not unset:

src/datadog_api_client/v2/model/rum_cross_product_sampling_update.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ def __init__(
4040
**kwargs,
4141
):
4242
"""
43-
Configuration for cross-product sampling when updating a retention filter. All fields are optional for partial updates.
43+
The configuration for cross-product retention filters. All fields are optional for partial updates.
4444
45-
:param trace_enabled: Indicates whether trace cross-product sampling is enabled.
45+
:param trace_enabled: Whether the cross-product retention filter for APM traces is enabled.
4646
:type trace_enabled: bool, optional
4747
48-
:param trace_sample_rate: The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
48+
:param trace_sample_rate: The sample rate for the APM cross-product retention filter, between 0 and 100.
4949
:type trace_sample_rate: float, optional
5050
"""
5151
if trace_enabled is not unset:

src/datadog_api_client/v2/model/rum_retention_filter_attributes.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,7 @@ def __init__(
6262
"""
6363
The object describing attributes of a RUM retention filter.
6464
65-
:param cross_product_sampling: Configuration for additional APM trace data retention for sessions that match this retention filter.
66-
When a session matches the filter and is retained (based on ``sample_rate`` ), you can configure
67-
the percentage of retained sessions with ingested traces whose traces are indexed.
65+
:param cross_product_sampling: The configuration for cross-product retention filters.
6866
:type cross_product_sampling: RumCrossProductSampling, optional
6967
7068
:param enabled: Whether the retention filter is enabled.

src/datadog_api_client/v2/model/rum_retention_filter_create_attributes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def __init__(
6262
"""
6363
The object describing attributes of a RUM retention filter to create.
6464
65-
:param cross_product_sampling: Configuration for cross-product sampling when creating a retention filter.
65+
:param cross_product_sampling: The configuration for cross-product retention filters.
6666
:type cross_product_sampling: RumCrossProductSamplingCreate, optional
6767
6868
:param enabled: Whether the retention filter is enabled.

src/datadog_api_client/v2/model/rum_retention_filter_update_attributes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def __init__(
6262
"""
6363
The object describing attributes of a RUM retention filter to update.
6464
65-
:param cross_product_sampling: Configuration for cross-product sampling when updating a retention filter. All fields are optional for partial updates.
65+
:param cross_product_sampling: The configuration for cross-product retention filters. All fields are optional for partial updates.
6666
:type cross_product_sampling: RumCrossProductSamplingUpdate, optional
6767
6868
:param enabled: Whether the retention filter is enabled.

0 commit comments

Comments
 (0)