osm_mon/collector/backends/prometheus.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Copyright 2018 Whitestack, LLC
   4 # *************************************************************
   5
   6 # This file is part of OSM Monitoring module
   7 # All Rights Reserved to Whitestack, LLC
   8
   9 # Licensed under the Apache License, Version 2.0 (the "License"); you may
  10 # not use this file except in compliance with the License. You may obtain
  11 # a copy of the License at
  12
  13 #         http://www.apache.org/licenses/LICENSE-2.0
  14
  15 # Unless required by applicable law or agreed to in writing, software
  16 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  18 # License for the specific language governing permissions and limitations
  19 # under the License.
  20 # For those usages not covered by the Apache License, Version 2.0 please
  21 # contact: bdiaz@whitestack.com or glavado@whitestack.com
  22 ##
  23 import logging
  24 from typing import List
  25
  26 from prometheus_client import start_http_server
  27 from prometheus_client.core import REGISTRY, GaugeMetricFamily
  28
  29 from osm_mon.collector.backends.base import BaseBackend
  30 from osm_mon.collector.metric import Metric
  31
  32 log = logging.getLogger(__name__)
  33
  34 OSM_METRIC_PREFIX = 'osm_'
  35
  36
  37 class PrometheusBackend(BaseBackend):
  38
  39     def __init__(self):
  40         self.custom_collector = CustomCollector()
  41         self._start_exporter(8000)
  42
  43     def handle(self, metrics: List[Metric]):
  44         prometheus_metrics = []
  45         for metric in metrics:
  46             prometheus_metric = GaugeMetricFamily(
  47                 OSM_METRIC_PREFIX + metric.name,
  48                 'OSM metric',
  49                 labels=['ns_id', 'vnf_member_index', 'vdu_name']
  50             )
  51             prometheus_metric.add_metric([metric.nsr_id, metric.vnf_member_index, metric.vdur_name], metric.value)
  52             prometheus_metrics.append(prometheus_metric)
  53         self.custom_collector.metrics = prometheus_metrics
  54
  55     def _start_exporter(self, port):
  56         log.debug('_start_exporter')
  57         REGISTRY.register(self.custom_collector)
  58         log.info("Starting MON Prometheus exporter at port %s", port)
  59         start_http_server(port)
  60
  61
  62 class CustomCollector(object):
  63
  64     def __init__(self):
  65         self.metrics = []
  66
  67     def describe(self):
  68         log.debug('describe')
  69         return []
  70
  71     def collect(self):
  72         log.debug("collect")
  73         return self.metrics