-
Notifications
You must be signed in to change notification settings - Fork 87
Adding create channel api changes to python SDK #709
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mawasthy-lgtm
wants to merge
9
commits into
linode:dev
Choose a base branch
from
mawasthy-lgtm:feat/add-create-alert-channel
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
f4ab4af
adding create channel api changes
mawasthy-lgtm d33a714
adding delete and update channel changes
mawasthy-lgtm 54d4efc
fixing test case to not hardcode usernames
mawasthy-lgtm 21ef5c1
updating review comment fixes
mawasthy-lgtm b7d0367
adding sdk support for get channel endpoints
mawasthy-lgtm d2de2ef
Resolve merge conflicts with upstream dev
mawasthy-lgtm 98ba868
resolving review comments
mawasthy-lgtm c22db1a
updating clone alert integration test
mawasthy-lgtm 006bf41
updating code as per review comments
mawasthy-lgtm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,8 +18,10 @@ | |
| MonitorService, | ||
| MonitorServiceToken, | ||
| ) | ||
| from linode_api4.objects.filtering import and_ | ||
| from linode_api4.objects.monitor import ( | ||
| AkamaiObjectStorageLogsDestinationDetails, | ||
| ChannelDetails, | ||
| CustomHTTPSLogsDestinationDetails, | ||
| LogsStreamDetails, | ||
| ) | ||
|
|
@@ -423,6 +425,110 @@ def alert_definition_entities( | |
| endpoint=endpoint, | ||
| ) | ||
|
|
||
| def channel_create( | ||
| self, | ||
| label: str, | ||
| channel_type: str, | ||
| details: ChannelDetails, | ||
| ) -> AlertChannel: | ||
| """ | ||
| Creates a new alert channel for the authenticated account. | ||
|
|
||
| An alert channel defines a notification destination (for example: an | ||
| email list) that can be associated with one or more alert definitions. | ||
| Currently only ``email`` is supported as a ``channel_type``. | ||
|
|
||
| API Documentation: https://techdocs.akamai.com/linode-api/reference/post-notification-channel | ||
|
|
||
| :param label: Human-readable name for the new alert channel. | ||
| :type label: str | ||
| :param channel_type: The type of notification channel (e.g. ``"email"``). | ||
| :type channel_type: str | ||
| :param details: Notification-type-specific configuration. | ||
| :type details: ChannelDetails | ||
|
|
||
| :returns: The newly created :class:`AlertChannel`. | ||
| :rtype: AlertChannel | ||
|
|
||
| .. note:: | ||
| If you need to obtain a single :class:`AlertChannel`, use :meth:`LinodeClient.load`. | ||
| Example: ``client.load(AlertChannel, channel_id)``. | ||
| For updating an alert channel, use the ``save()`` method on the :class:`AlertChannel` object. | ||
| For deleting an alert channel, use the ``delete()`` method directly on the :class:`AlertChannel` object. | ||
| """ | ||
| params = { | ||
| "label": label, | ||
| "channel_type": channel_type, | ||
| "details": details.dict, | ||
| } | ||
|
|
||
| result = self.client.post("/monitor/alert-channels", data=params) | ||
|
|
||
| if "id" not in result: | ||
| raise UnexpectedResponseError( | ||
| "Unexpected response when creating alert channel!", | ||
| json=result, | ||
| ) | ||
|
|
||
| return AlertChannel(self.client, result["id"], result) | ||
|
|
||
| def alert_channel_alerts(self, channel_id: int, *filters) -> PaginatedList: | ||
| """ | ||
| Retrieve all alerts associated with a specific alert channel. | ||
|
|
||
| Returns a paginated collection of alert definitions associated with the | ||
| specified alert channel. This allows you to see which alert definitions | ||
| are configured to notify this specific channel. | ||
|
|
||
| API Documentation: https://techdocs.akamai.com/linode-api/reference/get-notification-channel-alerts | ||
|
|
||
| :param channel_id: The ID of the alert channel to retrieve alerts for. | ||
| :type channel_id: int | ||
| :param filters: Optional filter expressions to apply to the collection. | ||
| See :doc:`Filtering Collections</linode_api4/objects/filtering>` for details. | ||
|
|
||
| :returns: A paginated list of alert definitions associated with this channel. | ||
| :rtype: PaginatedList[AlertDefinition] | ||
| """ | ||
| endpoint = f"/monitor/alert-channels/{channel_id}/alerts" | ||
|
|
||
| # Build filter dict if filters provided | ||
| parsed_filters = None | ||
| if filters: | ||
| parsed_filters = ( | ||
| and_(*filters).dct if len(filters) > 1 else filters[0].dct | ||
| ) | ||
|
|
||
| response_json = self.client.get(endpoint, filters=parsed_filters) | ||
|
|
||
| if "data" not in response_json: | ||
| raise UnexpectedResponseError( | ||
| "Unexpected response when retrieving alert channel alerts!", | ||
| json=response_json, | ||
| ) | ||
|
|
||
| # Create AlertDefinition objects with proper parent_id (service_type) | ||
| result = [ | ||
| AlertDefinition.make_instance( | ||
| obj["id"], | ||
| self.client, | ||
| parent_id=obj["service_type"], | ||
| json=obj, | ||
| ) | ||
| for obj in response_json.get("data", []) | ||
| if "id" in obj and "service_type" in obj | ||
| ] | ||
|
|
||
| return PaginatedList( | ||
| self.client, | ||
| endpoint[1:], | ||
| page=result, | ||
| max_pages=response_json.get("pages", 1), | ||
| total_items=response_json.get("results", len(result)), | ||
| parent_id=None, | ||
| filters=parsed_filters, | ||
| ) | ||
|
Comment on lines
+522
to
+530
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Doesn't seem to be the right way of creating a |
||
|
|
||
| def destinations(self, *filters) -> PaginatedList: | ||
| """ | ||
| List available logs destinations. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "id": 123, | ||
| "label": "alert notification channel", | ||
| "type": "user", | ||
| "channel_type": "email", | ||
| "details": { | ||
| "email": { | ||
| "usernames": [ | ||
| "admin-user1", | ||
| "admin-user2" | ||
| ], | ||
| "recipient_type": "user" | ||
| } | ||
| }, | ||
| "alerts": { | ||
| "url": "/monitor/alert-channels/123/alerts", | ||
| "type": "alerts-definitions", | ||
| "alert_count": 2 | ||
| }, | ||
| "created": "2024-01-01T00:00:00", | ||
| "updated": "2024-01-01T00:00:00", | ||
| "created_by": "tester", | ||
| "updated_by": "tester" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| { | ||
| "data": [ | ||
| { | ||
| "id": 12345, | ||
| "label": "DBAAS Alert 1", | ||
| "service_type": "dbaas", | ||
| "type": "alerts-definitions", | ||
| "url": "/monitor/services/dbaas/alerts-definitions/12345" | ||
| }, | ||
| { | ||
| "id": 12346, | ||
| "label": "DBAAS Alert 2", | ||
| "service_type": "dbaas", | ||
| "type": "alerts-definitions", | ||
| "url": "/monitor/services/dbaas/alerts-definitions/12346" | ||
| } | ||
| ], | ||
| "page": 1, | ||
| "pages": 1, | ||
| "results": 2 | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,7 +41,7 @@ | |
| "metric": "cpu_usage", | ||
| "operator": "gt", | ||
| "threshold": 90, | ||
| "unit": "percent" | ||
| "unit": "%" | ||
| } | ||
| ] | ||
| }, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,7 +39,7 @@ | |
| "metric": "cpu_usage", | ||
| "operator": "gt", | ||
| "threshold": 90, | ||
| "unit": "percent" | ||
| "unit": "%" | ||
| } | ||
| ] | ||
| }, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.