-
Notifications
You must be signed in to change notification settings - Fork 77
Support Monitor Client and Fetch Entity Metrics #569
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
yec-akamai
wants to merge
7
commits into
linode:dev
Choose a base branch
from
yec-akamai:monitor-client
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
7 commits
Select commit
Hold shift + click to select a range
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 |
---|---|---|
@@ -1,7 +1,7 @@ | ||
# isort: skip_file | ||
from linode_api4.objects import * | ||
from linode_api4.errors import ApiError, UnexpectedResponseError | ||
from linode_api4.linode_client import LinodeClient | ||
from linode_api4.linode_client import LinodeClient, MonitorClient | ||
from linode_api4.login_client import LinodeLoginClient, OAuthScopes | ||
from linode_api4.paginated_list import PaginatedList | ||
from linode_api4.polling import EventPoller |
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
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,50 @@ | ||
__all__ = [ | ||
"MetricsGroup", | ||
] | ||
|
||
from typing import Optional | ||
|
||
from linode_api4.groups import Group | ||
from linode_api4.objects.monitor_api import EntityMetrics | ||
|
||
|
||
class MetricsGroup(Group): | ||
""" | ||
Encapsulates Monitor-related methods of the :any:`MonitorClient`. | ||
|
||
This group contains all features related to metrics in the API monitor-api. | ||
""" | ||
|
||
def fetch_metrics( | ||
self, | ||
service_type: str, | ||
entity_ids: list, | ||
**kwargs, | ||
) -> Optional[EntityMetrics]: | ||
""" | ||
Returns metrics information for the individual entities within a specific service type. | ||
|
||
API documentation: https://techdocs.akamai.com/linode-api/reference/post-read-metric | ||
|
||
:param service_type: The service being monitored. | ||
Currently, only the Managed Databases (dbaas) service type is supported. | ||
:type service_type: str | ||
|
||
:param entity_ids: The id for each individual entity from a service_type. | ||
:type entity_ids: list | ||
|
||
:param kwargs: Any other arguments accepted by the api. Please refer to the API documentation for full info. | ||
|
||
:returns: Service metrics requested. | ||
:rtype: EntityMetrics or None | ||
""" | ||
|
||
params = {"entity_ids": entity_ids} | ||
|
||
params.update(kwargs) | ||
|
||
result = self.client.post( | ||
f"/monitor/services/{service_type}/metrics", data=params | ||
) | ||
|
||
return EntityMetrics.from_json(result) |
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.