import datetime
import json
-import logging as log
+import logging
+
import time
from core.message_bus.producer import KafkaProducer
-from kafka import KafkaConsumer
-
-from plugins.OpenStack.common import Common
from plugins.OpenStack.response import OpenStack_Response
+from plugins.OpenStack.settings import Config
__author__ = "Helena McGough"
+log = logging.getLogger(__name__)
+
METRIC_MAPPINGS = {
- "AVERAGE_MEMORY_UTILIZATION": "memory.percent",
- "DISK_READ_OPS": "disk.disk_ops",
- "DISK_WRITE_OPS": "disk.disk_ops",
- "DISK_READ_BYTES": "disk.disk_octets",
- "DISK_WRITE_BYTES": "disk.disk_octets",
- "PACKETS_DROPPED": "interface.if_dropped",
- "PACKETS_RECEIVED": "interface.if_packets",
- "PACKETS_SENT": "interface.if_packets",
- "CPU_UTILIZATION": "cpu.percent",
+ "average_memory_utilization": "memory.percent",
+ "disk_read_ops": "disk.disk_ops",
+ "disk_write_ops": "disk.disk_ops",
+ "disk_read_bytes": "disk.disk_octets",
+ "disk_write_bytes": "disk.disk_octets",
+ "packets_dropped": "interface.if_dropped",
+ "packets_received": "interface.if_packets",
+ "packets_sent": "interface.if_packets",
+ "cpu_utilization": "cpu.percent",
}
PERIOD_MS = {
def __init__(self):
"""Initialize the metric actions."""
- self._common = Common()
+ # Configure an instance of the OpenStack metric plugin
+ config = Config.instance()
+ config.read_environ("gnocchi")
- # TODO(mcgoughh): Initialize a generic consumer object to consume
- # message from the SO. This is hardcoded for now
- server = {'server': 'localhost:9092', 'topic': 'metric_request'}
- self._consumer = KafkaConsumer(server['topic'],
- group_id='osm_mon',
- bootstrap_servers=server['server'])
+ # Initialise authentication for API requests
+ self.auth_token = None
+ self.endpoint = None
+ self._common = None
# Use the Response class to generate valid json response messages
self._response = OpenStack_Response()
# Initializer a producer to send responses back to SO
self._producer = KafkaProducer("metric_response")
- def metric_calls(self):
+ def metric_calls(self, message, common, auth_token):
"""Consume info from the message bus to manage metric requests."""
- # Consumer check for metric messages
- for message in self._consumer:
- # Check if this plugin should carry out this request
- values = json.loads(message.value)
- vim_type = values['vim_type'].lower()
-
- if vim_type == "openstack":
- # Generate auth_token and endpoint
- auth_token, endpoint = self.authenticate(values)
-
- if message.key == "create_metric_request":
- # Configure metric
- metric_details = values['metric_create']
- metric_id, resource_id, status = self.configure_metric(
- endpoint, auth_token, metric_details)
-
- # Generate and send a create metric response
- try:
- resp_message = self._response.generate_response(
- 'create_metric_response', status=status,
- cor_id=values['correlation_id'],
- metric_id=metric_id, r_id=resource_id)
- self._producer.create_metrics_resp(
- 'create_metric_response', resp_message,
- 'metric_response')
- except Exception as exc:
- log.warn("Failed to create response: %s", exc)
-
- elif message.key == "read_metric_data_request":
- # Read all metric data related to a specified metric
- timestamps, metric_data = self.read_metric_data(
- endpoint, auth_token, values)
-
- # Generate and send a response message
- try:
- resp_message = self._response.generate_response(
- 'read_metric_data_response',
- m_id=values['metric_uuid'],
- m_name=values['metric_name'],
- r_id=values['resource_uuid'],
- cor_id=values['correlation_id'],
- times=timestamps, metrics=metric_data)
- self._producer.read_metric_data_response(
- 'read_metric_data_response', resp_message,
- 'metric_response')
- except Exception as exc:
- log.warn("Failed to send read metric response:%s", exc)
-
- elif message.key == "delete_metric_request":
- # delete the specified metric in the request
- metric_id = values['metric_uuid']
- status = self.delete_metric(
- endpoint, auth_token, metric_id)
-
- # Generate and send a response message
- try:
- resp_message = self._response.generate_response(
- 'delete_metric_response', m_id=metric_id,
- m_name=values['metric_name'],
- status=status, r_id=values['resource_uuid'],
- cor_id=values['correlation_id'])
- self._producer.delete_metric_response(
- 'delete_metric_response', resp_message,
- 'metric_response')
- except Exception as exc:
- log.warn("Failed to send delete response:%s", exc)
-
- elif message.key == "update_metric_request":
- # Gnocchi doesn't support configuration updates
- # Log and send a response back to this effect
- log.warn("Gnocchi doesn't support metric configuration\
- updates.")
- req_details = values['metric_create']
- metric_name = req_details['metric_name']
- resource_id = req_details['resource_uuid']
- metric_id = self.get_metric_id(
- endpoint, auth_token, metric_name, resource_id)
-
- # Generate and send a response message
- try:
- resp_message = self._response.generate_response(
- 'update_metric_response', status=False,
- cor_id=values['correlation_id'],
- r_id=resource_id, m_id=metric_id)
- self._producer.update_metric_response(
- 'update_metric_response', resp_message,
- 'metric_response')
- except Exception as exc:
- log.warn("Failed to send an update response:%s", exc)
-
- elif message.key == "list_metric_request":
- list_details = values['metrics_list_request']
-
- metric_list = self.list_metrics(
- endpoint, auth_token, list_details)
-
- # Generate and send a response message
- try:
- resp_message = self._response.generate_response(
- 'list_metric_response', m_list=metric_list,
- cor_id=list_details['correlation_id'])
- self._producer.list_metric_response(
- 'list_metric_response', resp_message,
- 'metric_response')
- except Exception as exc:
- log.warn("Failed to send a list response:%s", exc)
-
- else:
- log.warn("Unknown key, no action will be performed.")
+ values = json.loads(message.value)
+ self._common = common
+ log.info("OpenStack metric action required.")
+
+ # Generate and auth_token and endpoint for request
+ if auth_token is not None:
+ if self.auth_token != auth_token:
+ log.info("Auth_token for metrics set by access_credentials.")
+ self.auth_token = auth_token
else:
- log.debug("Message is not for this OpenStack.")
+ log.info("Auth_token has not been updated.")
+ else:
+ log.info("Using environment variables to set Gnocchi auth_token.")
+ self.auth_token = self._common._authenticate()
+
+ if self.endpoint is None:
+ log.info("Generating a new endpoint for Gnocchi.")
+ self.endpoint = self._common.get_endpoint("metric")
+
+ if message.key == "create_metric_request":
+ # Configure metric
+ metric_details = values['metric_create']
+ metric_id, resource_id, status = self.configure_metric(
+ self.endpoint, self.auth_token, metric_details)
+
+ # Generate and send a create metric response
+ try:
+ resp_message = self._response.generate_response(
+ 'create_metric_response', status=status,
+ cor_id=values['correlation_id'],
+ metric_id=metric_id, r_id=resource_id)
+ log.info("Response messages: %s", resp_message)
+ self._producer.create_metrics_resp(
+ 'create_metric_response', resp_message,
+ 'metric_response')
+ except Exception as exc:
+ log.warn("Failed to create response: %s", exc)
+
+ elif message.key == "read_metric_data_request":
+ # Read all metric data related to a specified metric
+ timestamps, metric_data = self.read_metric_data(
+ self.endpoint, self.auth_token, values)
+
+ # Generate and send a response message
+ try:
+ resp_message = self._response.generate_response(
+ 'read_metric_data_response',
+ m_id=values['metric_uuid'],
+ m_name=values['metric_name'],
+ r_id=values['resource_uuid'],
+ cor_id=values['correlation_id'],
+ times=timestamps, metrics=metric_data)
+ log.info("Response message: %s", resp_message)
+ self._producer.read_metric_data_response(
+ 'read_metric_data_response', resp_message,
+ 'metric_response')
+ except Exception as exc:
+ log.warn("Failed to send read metric response:%s", exc)
+
+ elif message.key == "delete_metric_request":
+ # delete the specified metric in the request
+ metric_id = values['metric_uuid']
+ status = self.delete_metric(
+ self.endpoint, self.auth_token, metric_id)
+
+ # Generate and send a response message
+ try:
+ resp_message = self._response.generate_response(
+ 'delete_metric_response', m_id=metric_id,
+ m_name=values['metric_name'],
+ status=status, r_id=values['resource_uuid'],
+ cor_id=values['correlation_id'])
+ log.info("Response message: %s", resp_message)
+ self._producer.delete_metric_response(
+ 'delete_metric_response', resp_message,
+ 'metric_response')
+ except Exception as exc:
+ log.warn("Failed to send delete response:%s", exc)
+
+ elif message.key == "update_metric_request":
+ # Gnocchi doesn't support configuration updates
+ # Log and send a response back to this effect
+ log.warn("Gnocchi doesn't support metric configuration\
+ updates.")
+ req_details = values['metric_create']
+ metric_name = req_details['metric_name']
+ resource_id = req_details['resource_uuid']
+ metric_id = self.get_metric_id(
+ self.endpoint, self.auth_token, metric_name, resource_id)
+
+ # Generate and send a response message
+ try:
+ resp_message = self._response.generate_response(
+ 'update_metric_response', status=False,
+ cor_id=values['correlation_id'],
+ r_id=resource_id, m_id=metric_id)
+ log.info("Response message: %s", resp_message)
+ self._producer.update_metric_response(
+ 'update_metric_response', resp_message,
+ 'metric_response')
+ except Exception as exc:
+ log.warn("Failed to send an update response:%s", exc)
+
+ elif message.key == "list_metric_request":
+ list_details = values['metrics_list_request']
+
+ metric_list = self.list_metrics(
+ self.endpoint, self.auth_token, list_details)
+
+ # Generate and send a response message
+ try:
+ resp_message = self._response.generate_response(
+ 'list_metric_response', m_list=metric_list,
+ cor_id=list_details['correlation_id'])
+ log.info("Response message: %s", resp_message)
+ self._producer.list_metric_response(
+ 'list_metric_response', resp_message,
+ 'metric_response')
+ except Exception as exc:
+ log.warn("Failed to send a list response:%s", exc)
+
+ else:
+ log.warn("Unknown key, no action will be performed.")
return
endpoint, auth_token, metric_name, resource_id)
if metric_id is None:
- # Need to create a new version of the resource for gnocchi to
- # create the new metric based on that resource
- url = "{}/v1/resource/generic".format(endpoint)
+ # Try appending metric to existing resource
try:
- # Try to create a new resource for the new metric
- metric = {'name': metric_name,
- 'archive_policy_name': 'high',
- 'unit': values['metric_unit'], }
-
- resource_payload = json.dumps({'id': resource_id,
- 'metrics': {
- metric_name: metric}})
-
- new_resource = self._common._perform_request(
- url, auth_token, req_type="post", payload=resource_payload)
-
- resource_id = json.loads(new_resource.text)['id']
- except Exception as exc:
- # Append new metric to existing resource
- log.debug("This resource already exists:%s, appending metric.",
- exc)
base_url = "{}/v1/resource/generic/%s/metric"
res_url = base_url.format(endpoint) % resource_id
payload = {metric_name: {'archive_policy_name': 'high',
'unit': values['metric_unit']}}
- self._common._perform_request(
+ result = self._common._perform_request(
res_url, auth_token, req_type="post",
payload=json.dumps(payload))
+ # Get id of newly created metric
+ for row in json.loads(result.text):
+ if row['name'] == metric_name:
+ metric_id = row['id']
+ log.info("Appended metric to existing resource.")
- metric_id = self.get_metric_id(
- endpoint, auth_token, metric_name, resource_id)
- return metric_id, resource_id, True
+ return metric_id, resource_id, True
+ except Exception as exc:
+ # Gnocchi version of resource does not exist creating a new one
+ log.info("Failed to append metric to existing resource:%s",
+ exc)
+ try:
+ url = "{}/v1/resource/generic".format(endpoint)
+ metric = {'name': metric_name,
+ 'archive_policy_name': 'high',
+ 'unit': values['metric_unit'], }
+
+ resource_payload = json.dumps({'id': resource_id,
+ 'metrics': {
+ metric_name: metric}})
+
+ resource = self._common._perform_request(
+ url, auth_token, req_type="post",
+ payload=resource_payload)
+
+ # Return the newly created resource_id for creating alarms
+ new_resource_id = json.loads(resource.text)['id']
+ log.info("Created new resource for metric: %s",
+ new_resource_id)
+
+ metric_id = self.get_metric_id(
+ endpoint, auth_token, metric_name, new_resource_id)
+
+ return metric_id, new_resource_id, True
+ except Exception as exc:
+ log.warn("Failed to create a new resource:%s", exc)
+ return None, None, False
else:
- log.debug("This metric already exists for this resource.")
+ log.info("This metric already exists for this resource.")
return metric_id, resource_id, False
"""List all metrics."""
url = "{}/v1/metric/".format(endpoint)
+ # Check for a specified list
try:
# Check if the metric_name was specified for the list
- metric_name = values['metric_name']
- result = self._common._perform_request(
- url, auth_token, req_type="get")
- metric_list = json.loads(result.text)
+ metric_name = values['metric_name'].lower()
+ if metric_name not in METRIC_MAPPINGS.keys():
+ log.warn("This metric is not supported, won't be listed.")
+ metric_name = None
+ except KeyError as exc:
+ log.info("Metric name is not specified: %s", exc)
+ metric_name = None
- # Format the list response
- metrics = self.response_list(
- metric_list, metric_name=metric_name)
- return metrics
- except KeyError:
- log.debug("Metric name is not specified for this list.")
+ try:
+ resource = values['resource_uuid']
+ except KeyError as exc:
+ log.info("Resource is not specified:%s", exc)
+ resource = None
try:
- # Check if a resource_id was specified
- resource_id = values['resource_uuid']
result = self._common._perform_request(
url, auth_token, req_type="get")
- metric_list = json.loads(result.text)
- # Format the list response
- metrics = self.response_list(
- metric_list, resource=resource_id)
- return metrics
- except KeyError:
- log.debug("Resource id not specificed either, will return a\
- complete list.")
- try:
- result = self._common._perform_request(
- url, auth_token, req_type="get")
- metric_list = json.loads(result.text)
+ metrics = json.loads(result.text)
+
+ if metrics is not None:
# Format the list response
- metrics = self.response_list(metric_list)
- return metrics
+ if metric_name is not None and resource is not None:
+ metric_list = self.response_list(
+ metrics, metric_name=metric_name, resource=resource)
+ log.info("Returning an %s resource list for %s metrics",
+ metric_name, resource)
+ elif metric_name is not None:
+ metric_list = self.response_list(
+ metrics, metric_name=metric_name)
+ log.info("Returning a list of %s metrics", metric_name)
+ elif resource is not None:
+ metric_list = self.response_list(
+ metrics, resource=resource)
+ log.info("Return a list of %s resource metrics", resource)
+ else:
+ metric_list = self.response_list(metrics)
+ log.info("Returning a complete list of metrics")
- except Exception as exc:
- log.warn("Failed to generate any metric list. %s", exc)
+ return metric_list
+ else:
+ log.info("There are no metrics available")
+ return []
+ except Exception as exc:
+ log.warn("Failed to generate any metric list. %s", exc)
return None
def get_metric_id(self, endpoint, auth_token, metric_name, resource_id):
url, auth_token, req_type="get")
return json.loads(result.text)['metrics'][metric_name]
except Exception:
- log.debug("Metric doesn't exist. No metric_id available")
+ log.info("Metric doesn't exist. No metric_id available")
return None
def get_metric_name(self, values):
"""Check metric name configuration and normalize."""
try:
# Normalize metric name
- metric_name = values['metric_name']
+ metric_name = values['metric_name'].lower()
return metric_name, METRIC_MAPPINGS[metric_name]
except KeyError:
- log.warn("Metric name %s is invalid.", metric_name)
+ log.info("Metric name %s is invalid.", metric_name)
return metric_name, None
def read_metric_data(self, endpoint, auth_token, values):
diff = PERIOD_MS[collection_unit]
else:
diff = collection_period * PERIOD_MS[collection_unit]
- s_time = (end_time - diff)/1000.0
+ s_time = (end_time - diff) / 1000.0
start_time = datetime.datetime.fromtimestamp(s_time).strftime(
'%Y-%m-%dT%H:%M:%S.%f')
base_url = "{}/v1/metric/%(0)s/measures?start=%(1)s&stop=%(2)s"
log.warn("Failed to gather specified measures: %s", exc)
return timestamps, data
- def authenticate(self, values):
- """Generate an authentication token and endpoint for metric request."""
- try:
- # Check for a tenant_id
- auth_token = self._common._authenticate(
- tenant_id=values['tenant_uuid'])
- endpoint = self._common.get_endpoint("metric")
- except KeyError:
- log.warn("Tenant ID is not specified. Will use a generic\
- authentication.")
- auth_token = self._common._authenticate()
- endpoint = self._common.get_endpoint("metric")
-
- return auth_token, endpoint
-
def response_list(self, metric_list, metric_name=None, resource=None):
"""Create the appropriate lists for a list response."""
- resp_list = []
+ resp_list, name_list, res_list = [], [], []
+ # Create required lists
for row in metric_list:
+ # Only list OSM metrics
+ if row['name'] in METRIC_MAPPINGS.keys():
+ metric = {"metric_name": row['name'],
+ "metric_uuid": row['id'],
+ "metric_unit": row['unit'],
+ "resource_uuid": row['resource_id']}
+ resp_list.append(str(metric))
+ # Generate metric_name specific list
if metric_name is not None:
if row['name'] == metric_name:
metric = {"metric_name": row['name'],
"metric_uuid": row['id'],
"metric_unit": row['unit'],
"resource_uuid": row['resource_id']}
- resp_list.append(metric)
- elif resource is not None:
+ name_list.append(str(metric))
+ # Generate resource specific list
+ if resource is not None:
if row['resource_id'] == resource:
metric = {"metric_name": row['name'],
"metric_uuid": row['id'],
"metric_unit": row['unit'],
"resource_uuid": row['resource_id']}
- resp_list.append(metric)
- else:
- metric = {"metric_name": row['name'],
- "metric_uuid": row['id'],
- "metric_unit": row['unit'],
- "resource_uuid": row['resource_id']}
- resp_list.append(metric)
- return resp_list
+ res_list.append(str(metric))
+
+ # Join required lists
+ if metric_name is not None and resource is not None:
+ return list(set(res_list).intersection(name_list))
+ elif metric_name is not None:
+ return name_list
+ elif resource is not None:
+ return list(set(res_list).intersection(resp_list))
+ else:
+ return resp_list