82 lines
3.3 KiB
Python
82 lines
3.3 KiB
Python
# Copyright 2014: Mirantis Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
import opentsdbclient
|
|
|
|
|
|
class BaseOpenTSDBClient(object):
|
|
def __init__(self, opentsdb_hosts, **kwargs):
|
|
self.hosts = opentsdb_hosts
|
|
|
|
def get_statistics(self):
|
|
"""Get info about what metrics are registered and with what stats."""
|
|
raise NotImplementedError
|
|
|
|
def put_meter(self, meters, **kwargs):
|
|
"""Post new meter(s) to the database.
|
|
|
|
Meter dictionary *should* contain the following four required fields:
|
|
- metric: the name of the metric you are storing
|
|
- timestamp: a Unix epoch style timestamp in seconds or milliseconds.
|
|
The timestamp must not contain non-numeric characters.
|
|
- value: the value to record for this data point. It may be quoted or
|
|
not quoted and must conform to the OpenTSDB value rules.
|
|
- tags: a map of tag name/tag value pairs. At least one pair must be
|
|
supplied.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
def define_retention(self, tsuid, retention_days):
|
|
"""Set retention days for the defined by ID timeseries.
|
|
|
|
##########################################################
|
|
NOTE: currently not working directly through the REST API.
|
|
that should be done directly on the HBase level.
|
|
##########################################################
|
|
|
|
:param tsuid: hexadecimal representation of the timeseries UID
|
|
:param retention_days: number of days of data points to retain for the
|
|
given timeseries. When set to 0, the default,
|
|
data is retained indefinitely.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
def get_aggregators(self):
|
|
"""Used to get the list of default aggregation functions."""
|
|
raise NotImplementedError
|
|
|
|
def get_version(self):
|
|
"""Used to check OpenTSDB version.
|
|
|
|
That might be needed in case of unknown bugs - this code is written
|
|
only for the 2.x REST API version, so some of the failures might refer
|
|
to the wrong OpenTSDB version installed.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
@staticmethod
|
|
def _check_meters(meters):
|
|
"""Check that meters to be put are having nice format."""
|
|
if type(meters) == dict:
|
|
meters = [meters]
|
|
for meter_dict in meters:
|
|
if (set(meter_dict.keys())
|
|
!= set(['metric', 'timestamp', 'value', 'tags'])):
|
|
raise opentsdbclient.InvalidOpenTSDBFormat(
|
|
actual=meter_dict,
|
|
expected="{'metric': <meter_name>, 'timestamp': <ts>, "
|
|
"'value': <value>, 'tags': <at least one pair>}")
|
|
return meters
|