|
| 1 | +__all__ = [ |
| 2 | + "MonitorGroup", |
| 3 | +] |
| 4 | +from typing import Any, Optional |
| 5 | + |
| 6 | +from linode_api4 import ( |
| 7 | + PaginatedList, |
| 8 | +) |
| 9 | +from linode_api4.errors import UnexpectedResponseError |
| 10 | +from linode_api4.groups import Group |
| 11 | +from linode_api4.objects import ( |
| 12 | + MonitorDashboard, |
| 13 | + MonitorMetricsDefinition, |
| 14 | + MonitorService, |
| 15 | + MonitorServiceToken, |
| 16 | +) |
| 17 | + |
| 18 | + |
| 19 | +class MonitorGroup(Group): |
| 20 | + """ |
| 21 | + Encapsulates Monitor-related methods of the :any:`LinodeClient`. |
| 22 | +
|
| 23 | + This group contains all features beneath the `/monitor` group in the API v4. |
| 24 | + """ |
| 25 | + |
| 26 | + def dashboards( |
| 27 | + self, *filters, service_type: Optional[str] = None |
| 28 | + ) -> PaginatedList: |
| 29 | + """ |
| 30 | + Returns a list of dashboards. If `service_type` is provided, it fetches dashboards |
| 31 | + for the specific service type. If None, it fetches all dashboards. |
| 32 | +
|
| 33 | + dashboards = client.monitor.dashboards() |
| 34 | + dashboard = client.load(MonitorDashboard, 1) |
| 35 | + dashboards_by_service = client.monitor.dashboards(service_type="dbaas") |
| 36 | +
|
| 37 | + .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`. |
| 38 | +
|
| 39 | + API Documentation: |
| 40 | + - All Dashboards: https://techdocs.akamai.com/linode-api/reference/get-dashboards-all |
| 41 | + - Dashboards by Service: https://techdocs.akamai.com/linode-api/reference/get-dashboards |
| 42 | +
|
| 43 | + :param service_type: The service type to get dashboards for. |
| 44 | + :type service_type: Optional[str] |
| 45 | + :param filters: Any number of filters to apply to this query. |
| 46 | + See :doc:`Filtering Collections</linode_api4/objects/filtering>` |
| 47 | + for more details on filtering. |
| 48 | +
|
| 49 | + :returns: A list of Dashboards. |
| 50 | + :rtype: PaginatedList of Dashboard |
| 51 | + """ |
| 52 | + endpoint = ( |
| 53 | + f"/monitor/services/{service_type}/dashboards" |
| 54 | + if service_type |
| 55 | + else "/monitor/dashboards" |
| 56 | + ) |
| 57 | + |
| 58 | + return self.client._get_and_filter( |
| 59 | + MonitorDashboard, |
| 60 | + *filters, |
| 61 | + endpoint=endpoint, |
| 62 | + ) |
| 63 | + |
| 64 | + def services( |
| 65 | + self, |
| 66 | + *filters, |
| 67 | + ) -> PaginatedList: |
| 68 | + """ |
| 69 | + Lists services supported by ACLP. |
| 70 | + supported_services = client.monitor.services() |
| 71 | + service_details = client.monitor.load(MonitorService, "dbaas") |
| 72 | +
|
| 73 | + .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`. |
| 74 | +
|
| 75 | + API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services |
| 76 | + API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services-for-service-type |
| 77 | +
|
| 78 | + :param filters: Any number of filters to apply to this query. |
| 79 | + See :doc:`Filtering Collections</linode_api4/objects/filtering>` |
| 80 | + for more details on filtering. |
| 81 | +
|
| 82 | + :returns: Lists monitor services |
| 83 | + :rtype: PaginatedList of the Services |
| 84 | + """ |
| 85 | + endpoint = "/monitor/services" |
| 86 | + |
| 87 | + return self.client._get_and_filter( |
| 88 | + MonitorService, |
| 89 | + *filters, |
| 90 | + endpoint=endpoint, |
| 91 | + ) |
| 92 | + |
| 93 | + def metric_definitions( |
| 94 | + self, service_type: str, *filters |
| 95 | + ) -> list[MonitorMetricsDefinition]: |
| 96 | + """ |
| 97 | + Returns metrics for a specific service type. |
| 98 | +
|
| 99 | + metrics = client.monitor.list_metric_definitions(service_type="dbaas") |
| 100 | + .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`. |
| 101 | +
|
| 102 | + API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-information |
| 103 | +
|
| 104 | + :param service_type: The service type to get metrics for. |
| 105 | + :type service_type: str |
| 106 | + :param filters: Any number of filters to apply to this query. |
| 107 | + See :doc:`Filtering Collections</linode_api4/objects/filtering>` |
| 108 | + for more details on filtering. |
| 109 | +
|
| 110 | + :returns: Returns a List of metrics for a service |
| 111 | + :rtype: PaginatedList of metrics |
| 112 | + """ |
| 113 | + return self.client._get_and_filter( |
| 114 | + MonitorMetricsDefinition, |
| 115 | + *filters, |
| 116 | + endpoint=f"/monitor/services/{service_type}/metric-definitions", |
| 117 | + ) |
| 118 | + |
| 119 | + def create_token( |
| 120 | + self, service_type: str, entity_ids: list[Any] |
| 121 | + ) -> MonitorServiceToken: |
| 122 | + """ |
| 123 | + Returns a JWE Token for a specific service type. |
| 124 | + token = client.monitor.create_token(service_type="dbaas", entity_ids=[1234]) |
| 125 | +
|
| 126 | + .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`. |
| 127 | +
|
| 128 | + API Documentation: https://techdocs.akamai.com/linode-api/reference/post-get-token |
| 129 | +
|
| 130 | + :param service_type: The service type to create token for. |
| 131 | + :type service_type: str |
| 132 | + :param entity_ids: The list of entity IDs for which the token is valid. |
| 133 | + :type entity_ids: any |
| 134 | +
|
| 135 | + :returns: Returns a token for a service |
| 136 | + :rtype: str |
| 137 | + """ |
| 138 | + |
| 139 | + params = {"entity_ids": entity_ids} |
| 140 | + |
| 141 | + result = self.client.post( |
| 142 | + f"/monitor/services/{service_type}/token", data=params |
| 143 | + ) |
| 144 | + |
| 145 | + if "token" not in result: |
| 146 | + raise UnexpectedResponseError( |
| 147 | + "Unexpected response when creating token!", json=result |
| 148 | + ) |
| 149 | + return MonitorServiceToken(token=result["token"]) |
0 commit comments