Skip to content

Commit 35c3ab4

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
Add notes for Events V1 API DD monitor aggregation key update (#2344)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent f8794d8 commit 35c3ab4

File tree

7 files changed

+46
-16
lines changed

7 files changed

+46
-16
lines changed

.apigentools-info

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-01-09 21:08:24.162934",
8-
"spec_repo_commit": "435429e0"
7+
"regenerated": "2025-01-09 22:06:09.999288",
8+
"spec_repo_commit": "8d40e082"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-01-09 21:08:24.177386",
13-
"spec_repo_commit": "435429e0"
12+
"regenerated": "2025-01-09 22:06:10.013561",
13+
"spec_repo_commit": "8d40e082"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

+10-3
Original file line numberDiff line numberDiff line change
@@ -36666,10 +36666,17 @@ tags:
3666636666
end times, prevent all alerting related to specified Datadog tags.'
3666736667
name: Downtimes
3666836668
- description: 'The Event Management API allows you to programmatically post events
36669-
to the Events Explorer
36669+
to the Events Explorer and fetch events from the Events Explorer. See the [Event
36670+
Management page](https://docs.datadoghq.com/service_management/events/) for more
36671+
information.
3667036672

36671-
and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/)
36672-
for more information.'
36673+
36674+
**Update to Datadog monitor events `aggregation_key` starting March 1, 2025:**
36675+
The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting
36676+
March 1st, this key will also include Monitor Group, making it unique per *Monitor
36677+
ID and Monitor Group*. If you''re using monitor events `aggregation_key` in dashboard
36678+
queries or the Event API, you must migrate to use `@monitor.id`. Reach out to
36679+
[support](https://www.datadoghq.com/support/) if you have any question.'
3667336680
name: Events
3667436681
- description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly
3667536682

.generator/schemas/v2/openapi.yaml

+10-3
Original file line numberDiff line numberDiff line change
@@ -48310,10 +48310,17 @@ tags:
4831048310
end times, prevent all alerting related to specified Datadog tags.'
4831148311
name: Downtimes
4831248312
- description: 'The Event Management API allows you to programmatically post events
48313-
to the Events Explorer
48313+
to the Events Explorer and fetch events from the Events Explorer. See the [Event
48314+
Management page](https://docs.datadoghq.com/service_management/events/) for more
48315+
information.
4831448316

48315-
and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/)
48316-
for more information.'
48317+
48318+
**Update to Datadog monitor events `aggregation_key` starting March 1, 2025:**
48319+
The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting
48320+
March 1st, this key will also include Monitor Group, making it unique per *Monitor
48321+
ID and Monitor Group*. If you''re using monitor events `aggregation_key` in dashboard
48322+
queries or the Event API, you must migrate to use `@monitor.id`. Reach out to
48323+
[support](https://www.datadoghq.com/support/) if you have any question.'
4831748324
name: Events
4831848325
- description: Manage your Datadog Fastly integration accounts and services directly
4831948326
through the Datadog API. See the [Fastly integration page](https://docs.datadoghq.com/integrations/fastly/)

src/datadog_api_client/v1/api/events_api.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@
2020

2121
class EventsApi:
2222
"""
23-
The Event Management API allows you to programmatically post events to the Events Explorer
24-
and fetch events from the Events Explorer. See the `Event Management page <https://docs.datadoghq.com/service_management/events/>`_ for more information.
23+
The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the `Event Management page <https://docs.datadoghq.com/service_management/events/>`_ for more information.
24+
25+
**Update to Datadog monitor events aggregation_key starting March 1, 2025:** The Datadog monitor events ``aggregation_key`` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you're using monitor events ``aggregation_key`` in dashboard queries or the Event API, you must migrate to use ``@monitor.id``. Reach out to `support <https://www.datadoghq.com/support/>`_ if you have any question.
2526
"""
2627

2728
def __init__(self, api_client=None):

src/datadog_api_client/v2/api/events_api.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@
2424

2525
class EventsApi:
2626
"""
27-
The Event Management API allows you to programmatically post events to the Events Explorer
28-
and fetch events from the Events Explorer. See the `Event Management page <https://docs.datadoghq.com/service_management/events/>`_ for more information.
27+
The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the `Event Management page <https://docs.datadoghq.com/service_management/events/>`_ for more information.
28+
29+
**Update to Datadog monitor events aggregation_key starting March 1, 2025:** The Datadog monitor events ``aggregation_key`` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you're using monitor events ``aggregation_key`` in dashboard queries or the Event API, you must migrate to use ``@monitor.id``. Reach out to `support <https://www.datadoghq.com/support/>`_ if you have any question.
2930
"""
3031

3132
def __init__(self, api_client=None):

tests/v1/features/events.feature

+8-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@ Feature: Events
33
The Event Management API allows you to programmatically post events to the
44
Events Explorer and fetch events from the Events Explorer. See the [Event
55
Management page](https://docs.datadoghq.com/service_management/events/)
6-
for more information.
6+
for more information. **Update to Datadog monitor events
7+
`aggregation_key` starting March 1, 2025:** The Datadog monitor events
8+
`aggregation_key` is unique to each Monitor ID. Starting March 1st, this
9+
key will also include Monitor Group, making it unique per *Monitor ID and
10+
Monitor Group*. If you're using monitor events `aggregation_key` in
11+
dashboard queries or the Event API, you must migrate to use `@monitor.id`.
12+
Reach out to [support](https://www.datadoghq.com/support/) if you have any
13+
question.
714

815
Background:
916
Given a valid "apiKeyAuth" key in the system

tests/v2/features/events.feature

+8-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@ Feature: Events
33
The Event Management API allows you to programmatically post events to the
44
Events Explorer and fetch events from the Events Explorer. See the [Event
55
Management page](https://docs.datadoghq.com/service_management/events/)
6-
for more information.
6+
for more information. **Update to Datadog monitor events
7+
`aggregation_key` starting March 1, 2025:** The Datadog monitor events
8+
`aggregation_key` is unique to each Monitor ID. Starting March 1st, this
9+
key will also include Monitor Group, making it unique per *Monitor ID and
10+
Monitor Group*. If you're using monitor events `aggregation_key` in
11+
dashboard queries or the Event API, you must migrate to use `@monitor.id`.
12+
Reach out to [support](https://www.datadoghq.com/support/) if you have any
13+
question.
714

815
Background:
916
Given a valid "apiKeyAuth" key in the system

0 commit comments

Comments
 (0)