75abdb4148
We are phasing out use of ironic-lib, and as such are removing the metrics module from it. However, due to it's requirement of having a statsd instance on the same subnet as the agent and there being no support for prometheus exporting of metrics from IPA, these metrics are no longer valuable (in the agent). We are vendoring the module for the deprecation in order to facilitate its removal from ironic-lib. Change-Id: Ie50e078bc3f78d65cfa53680dc4116d1119ce155
103 lines
4.0 KiB
Python
103 lines
4.0 KiB
Python
# Copyright 2016 Rackspace Hosting
|
|
# 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.
|
|
|
|
from oslo_config import cfg
|
|
|
|
from ironic_python_agent.metrics_lib import metrics
|
|
from ironic_python_agent.metrics_lib import metrics_collector
|
|
from ironic_python_agent.metrics_lib import metrics_exception as exception
|
|
from ironic_python_agent.metrics_lib import metrics_statsd
|
|
|
|
metrics_opts = [
|
|
cfg.StrOpt('backend',
|
|
default='noop',
|
|
choices=[
|
|
('noop', 'Do nothing in relation to metrics.'),
|
|
('statsd', 'Transmits metrics data to a statsd backend.'),
|
|
('collector', 'Collects metrics data and saves it in '
|
|
'memory for use by the running application.'),
|
|
],
|
|
help='Backend to use for the metrics system.'),
|
|
cfg.BoolOpt('prepend_host',
|
|
default=False,
|
|
help='Prepend the hostname to all metric names. '
|
|
'The format of metric names is '
|
|
'[global_prefix.][host_name.]prefix.metric_name.'),
|
|
cfg.BoolOpt('prepend_host_reverse',
|
|
default=True,
|
|
help='Split the prepended host value by "." and reverse it '
|
|
'(to better match the reverse hierarchical form of '
|
|
'domain names).'),
|
|
cfg.StrOpt('global_prefix',
|
|
help='Prefix all metric names with this value. '
|
|
'By default, there is no global prefix. '
|
|
'The format of metric names is '
|
|
'[global_prefix.][host_name.]prefix.metric_name.')
|
|
]
|
|
|
|
|
|
CONF = cfg.CONF
|
|
|
|
|
|
def get_metrics_logger(prefix='', backend=None, host=None, delimiter='.'):
|
|
"""Return a metric logger with the specified prefix.
|
|
|
|
The format of the prefix is:
|
|
[global_prefix<delim>][host_name<delim>]prefix
|
|
where <delim> is the delimiter (default is '.')
|
|
|
|
:param prefix: Prefix for this metric logger.
|
|
Value should be a string or None.
|
|
:param backend: Backend to use for the metrics system.
|
|
Possible values are 'noop' and 'statsd'.
|
|
:param host: Name of this node.
|
|
:param delimiter: Delimiter to use for the metrics name.
|
|
:return: The new MetricLogger.
|
|
"""
|
|
if not isinstance(prefix, str):
|
|
msg = ("This metric prefix (%s) is of unsupported type. "
|
|
"Value should be a string or None"
|
|
% str(prefix))
|
|
raise exception.InvalidMetricConfig(msg)
|
|
|
|
if CONF.metrics.prepend_host and host:
|
|
if CONF.metrics.prepend_host_reverse:
|
|
host = '.'.join(reversed(host.split('.')))
|
|
|
|
if prefix:
|
|
prefix = delimiter.join([host, prefix])
|
|
else:
|
|
prefix = host
|
|
|
|
if CONF.metrics.global_prefix:
|
|
if prefix:
|
|
prefix = delimiter.join([CONF.metrics.global_prefix, prefix])
|
|
else:
|
|
prefix = CONF.metrics.global_prefix
|
|
|
|
backend = backend or CONF.metrics.backend
|
|
if backend == 'statsd':
|
|
return metrics_statsd.StatsdMetricLogger(prefix, delimiter=delimiter)
|
|
elif backend == 'noop':
|
|
return metrics.NoopMetricLogger(prefix, delimiter=delimiter)
|
|
elif backend == 'collector':
|
|
return metrics_collector.DictCollectionMetricLogger(
|
|
prefix, delimiter=delimiter)
|
|
else:
|
|
msg = ("The backend is set to an unsupported type: "
|
|
"%s. Value should be 'noop' or 'statsd'."
|
|
% backend)
|
|
raise exception.InvalidMetricConfig(msg)
|