Skip to content

Commit b8ef2df

Browse files
ceorourkegeorge-sentry
authored andcommitted
fix(docs): Replace generic_metrics dataset with events_analytics_platform (#112480)
The generic metrics dataset is effectively deprecated (save for some am1 plans) so we don't want to encourage usage of it. Replace the mentions of it in the API docs with EAP.
1 parent 3c244b7 commit b8ef2df

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

src/sentry/incidents/endpoints/organization_alert_rule_index.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,12 +1036,12 @@ def post(self, request: Request, organization: Organization) -> HttpResponseBase
10361036
```
10371037
10381038
### [Transaction Duration](/product/alerts/alert-types/#transaction-duration)
1039-
- `dataset`: If a custom percentile is used, `dataset` is `transactions`. Otherwise, `dataset` is `generic_metrics`.
1039+
- `dataset`: If a custom percentile is used, `dataset` is `transactions`. Otherwise, `dataset` is `events_analytics_platform`.
10401040
- `aggregate`: Valid values are `avg(transaction.duration)`, `p50(transaction.duration)`, `p75(transaction.duration)`, `p95(transaction.duration)`, `p99(transaction.duration)`, `p100(transaction.duration)`, and `percentile(transaction.duration,x)`, where `x` is your custom percentile.
10411041
```json
10421042
{
10431043
"queryType": 1,
1044-
"dataset": "generic_metrics",
1044+
"dataset": "events_analytics_platform",
10451045
"aggregate": "avg(transaction.duration)"
10461046
}
10471047
```
@@ -1066,29 +1066,29 @@ def post(self, request: Request, organization: Organization) -> HttpResponseBase
10661066
```
10671067
10681068
### [Largest Contentful Paint](/product/alerts/alert-types/#largest-contentful-display)
1069-
- `dataset`: If a custom percentile is used, `dataset` is `transactions`. Otherwise, `dataset` is `generic_metrics`.
1069+
- `dataset`: If a custom percentile is used, `dataset` is `transactions`. Otherwise, `dataset` is `events_analytics_platform`.
10701070
- `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile.
10711071
```json
10721072
{
10731073
"queryType": 1,
1074-
"dataset": "generic_metrics",
1074+
"dataset": "events_analytics_platform",
10751075
"aggregate": "p50(measurements.lcp)"
10761076
}
10771077
```
10781078
10791079
### [First Input Delay](/product/alerts/alert-types/#first-input-delay)
1080-
- `dataset`: If a custom percentile is used, `dataset` is `transactions`. Otherwise, `dataset` is `generic_metrics`.
1080+
- `dataset`: If a custom percentile is used, `dataset` is `transactions`. Otherwise, `dataset` is `events_analytics_platform`.
10811081
- `aggregate`: Valid values are `avg(measurements.fid)`, `p50(measurements.fid)`, `p75(measurements.fid)`, `p95(measurements.fid)`, `p99(measurements.fid)`, `p100(measurements.fid)`, and `percentile(measurements.fid,x)`, where `x` is your custom percentile.
10821082
```json
10831083
{
10841084
"queryType": 1,
1085-
"dataset": "generic_metrics",
1085+
"dataset": "events_analytics_platform",
10861086
"aggregate": "p100(measurements.fid)"
10871087
}
10881088
```
10891089
10901090
### [Cumulative Layout Shift](/product/alerts/alert-types/#cumulative-layout-shift)
1091-
- `dataset`: If a custom percentile is used, `dataset` is `transactions`. Otherwise, `dataset` is `generic_metrics`.
1091+
- `dataset`: If a custom percentile is used, `dataset` is `transactions`. Otherwise, `dataset` is `events_analytics_platform`.
10921092
- `aggregate`: Valid values are `avg(measurements.cls)`, `p50(measurements.cls)`, `p75(measurements.cls)`, `p95(measurements.cls)`, `p99(measurements.cls)`, `p100(measurements.cls)`, and `percentile(measurements.cls,x)`, where `x` is your custom percentile.
10931093
```json
10941094
{
@@ -1099,7 +1099,7 @@ def post(self, request: Request, organization: Organization) -> HttpResponseBase
10991099
```
11001100
11011101
### [Custom Metric](/product/alerts/alert-types/#custom-metric)
1102-
- `dataset`: If a custom percentile is used, `dataset` is `transactions`. Otherwise, `dataset` is `generic_metrics`.
1102+
- `dataset`: If a custom percentile is used, `dataset` is `transactions`. Otherwise, `dataset` is `events_analytics_platform`.
11031103
- `aggregate`: Valid values are:
11041104
- `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
11051105
- `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
@@ -1114,7 +1114,7 @@ def post(self, request: Request, organization: Organization) -> HttpResponseBase
11141114
```json
11151115
{
11161116
"queryType": 1,
1117-
"dataset": "generic_metrics",
1117+
"dataset": "events_analytics_platform",
11181118
"aggregate": "p75(measurements.ttfb)"
11191119
}
11201120
```

src/sentry/workflow_engine/endpoints/validators/api_docs_help_text.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -711,7 +711,7 @@
711711
```
712712
713713
**Largest Contentful Paint Metric Monitor**
714-
- `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `generic_metrics`.
714+
- `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.
715715
- `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile.
716716
717717
```json
@@ -730,7 +730,7 @@
730730
```
731731
732732
**Custom Metric Monitor**
733-
- `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `generic_metrics`.
733+
- `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.
734734
- `aggregate`: Valid values are:
735735
`avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
736736
`p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
@@ -747,7 +747,7 @@
747747
[
748748
{
749749
"aggregate": "p75(measurements.ttfb)"
750-
"dataset": "generic_metrics",
750+
"dataset": "events_analytics_platform",
751751
"queryType": 1,
752752
},
753753
],

0 commit comments

Comments
 (0)