381e9ab197
This patch set updates all telemetry objects to use consistent resource.prop for timestamps and booleans. In particular, the following changes were made: - Clarify documentation for timestamp and boolean attributes - Use 'is_' prefix and boolean type for boolean attributes - Use '_at' suffix and timestamp type for timestamp attributes Change-Id: I76e98a0f929b8688685a7e9de2d362d8a0a1b555 Partial-Bug: #1544584
73 lines
2.9 KiB
Python
73 lines
2.9 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from openstack import format
|
|
from openstack import resource
|
|
from openstack.telemetry import telemetry_service
|
|
|
|
|
|
class Sample(resource.Resource):
|
|
""".. caution:: This API is a work in progress and is subject to change."""
|
|
id_attribute = 'sample_id'
|
|
base_path = '/meters/%(counter_name)s'
|
|
service = telemetry_service.TelemetryService()
|
|
|
|
# Supported Operations
|
|
allow_create = True
|
|
allow_list = True
|
|
|
|
# Properties
|
|
#: The meter name this sample is for
|
|
counter_name = resource.prop('meter', alias='counter_name')
|
|
#: When the sample has been generated.
|
|
#: *Type: datetime object parsed from ISO 8601 formatted string*
|
|
generated_at = resource.prop('timestamp', type=format.ISO8601)
|
|
#: Arbitrary metadata associated with the sample
|
|
metadata = resource.prop('metadata', alias='resource_metadata')
|
|
#: The ID of the project this sample was taken for
|
|
project_id = resource.prop('project_id')
|
|
#: When the sample has been recorded.
|
|
#: *Type: datetime object parsed from ISO 8601 formatted string*
|
|
recorded_at = resource.prop('recorded_at', type=format.ISO8601)
|
|
#: The ID of the resource this sample was taken for
|
|
resource_id = resource.prop('resource_id')
|
|
#: The name of the source that identifies where the sample comes from
|
|
source = resource.prop('source')
|
|
#: The meter type
|
|
type = resource.prop('type', alias='counter_type')
|
|
#: The unit of measure
|
|
unit = resource.prop('unit', alias='counter_unit')
|
|
#: The ID of the user this sample was taken for
|
|
user_id = resource.prop('user_id')
|
|
#: The metered value
|
|
volume = resource.prop('volume', alias='counter_volume')
|
|
|
|
@classmethod
|
|
def list(cls, session, limit=None, marker=None, path_args=None,
|
|
paginated=False, **params):
|
|
url = cls._get_url(path_args)
|
|
resp = session.get(url, endpoint_filter=cls.service, params=params)
|
|
for item in resp.json():
|
|
yield cls.existing(**item)
|
|
|
|
def create(self, session):
|
|
url = self._get_url(self)
|
|
# telemetry expects a list of samples
|
|
attrs = self._attrs.copy()
|
|
attrs.pop('meter', None)
|
|
resp = session.post(url, endpoint_filter=self.service,
|
|
json=[attrs])
|
|
resp = resp.json()
|
|
self.update_attrs(**resp.pop())
|
|
self._reset_dirty()
|
|
return self
|