1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
|
#!/usr/bin/env python3
"""
OpenStack exporter for the prometheus monitoring system
Copyright (C) 2016-2019 Canonical, Ltd.
Authors:
Jacek Nykis <jacek.nykis@canonical.com>
Laurent Sesques <laurent.sesques@canonical.com>
Paul Collins <paul.collins@canonical.com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3,
as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranties of
MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
import argparse
import yaml
import json
import ast
from os import environ as env
from os import rename, path
import traceback
import urlparse
from threading import Thread
import pickle
import requests
from time import sleep, time
from neutronclient.v2_0 import client as neutron_client
# from novaclient.v1_1 import client as nova_client
# http://docs.openstack.org/developer/python-novaclient/api.html
from cinderclient.v2 import client as cinder_client
from novaclient import client as nova_client
from BaseHTTPServer import BaseHTTPRequestHandler
from BaseHTTPServer import HTTPServer
from SocketServer import ForkingMixIn
from prometheus_client import CollectorRegistry, generate_latest, Gauge, CONTENT_TYPE_LATEST
from netaddr import IPRange
import random
import swift.common.utils
from swift.common.ring.ring import Ring
import logging
import logging.handlers
config = None
log = logging.getLogger('poe-logger')
def get_creds_dict(*names):
"""Get dictionary with cred envvars"""
return {name: env['OS_%s' % name.upper()]
for name in names if 'OS_%s' % name.upper() in env}
def get_creds_list(*names):
"""Get list with cred envvars, error if not set"""
return [env['OS_%s' % name.upper()] for name in names]
def maybe_get_cacert():
"""Get cacert, None if unset"""
return env.get("OS_CACERT")
def get_clients():
ks_version = int(env.get('OS_IDENTITY_API_VERSION', 2))
if ks_version == 2:
from keystoneclient.v2_0 import client as keystone_client
# Legacy v2 env vars:
# OS_USERNAME OS_PASSWORD OS_TENANT_NAME OS_AUTH_URL OS_REGION_NAME
ks_creds = get_creds_dict("username", "password", "tenant_name",
"auth_url", "region_name")
cacert = maybe_get_cacert()
if cacert:
ks_creds["cacert"] = cacert
nova_creds = [2] + get_creds_list("username", "password", "tenant_name",
"auth_url")
cinder_creds = get_creds_list("username", "password", "tenant_name",
"auth_url")
keystone = keystone_client.Client(**ks_creds)
nova = nova_client.Client(*nova_creds, cacert=cacert)
neutron = neutron_client.Client(**ks_creds)
cinder = cinder_client.Client(*cinder_creds, cacert=cacert)
elif ks_version == 3:
from keystoneauth1.identity import v3
from keystoneauth1 import session
from keystoneclient.v3 import client
# A little helper for the poor human trying to figure out which env vars
# are needed, it worked for me (jjo) having:
# OS_USERNAME OS_PASSWORD OS_USER_DOMAIN_NAME OS_AUTH_URL
# OS_PROJECT_DOMAIN_NAME OS_PROJECT_DOMAIN_ID OS_PROJECT_ID OS_DOMAIN_NAME
# Keystone needs domain creds for e.g. project list
# project and project_domain are needed for listing projects
ks_creds_domain = get_creds_dict(
"username", "password", "user_domain_name", "auth_url",
"project_domain_name", "project_name", "project_domain_id", "project_id")
# Need non-domain creds to get full catalog
ks_creds_admin = get_creds_dict(
"username", "password", "user_domain_name", "auth_url",
"project_domain_name", "project_name", "project_domain_id", "project_id")
auth_domain = v3.Password(**ks_creds_domain)
auth_admin = v3.Password(**ks_creds_admin)
# Need to pass in cacert separately
verify = maybe_get_cacert()
if verify is None:
verify = True
sess_domain = session.Session(auth=auth_domain, verify=verify)
sess_admin = session.Session(auth=auth_admin, verify=verify)
keystone = client.Client(session=sess_domain)
nova = nova_client.Client(2, session=sess_admin)
neutron = neutron_client.Client(session=sess_admin)
cinder = cinder_client.Client(session=sess_admin)
else:
raise(ValueError("Invalid OS_IDENTITY_API_VERSION=%s" % ks_version))
log.debug("Client setup done, keystone ver {}".format(ks_version))
return (keystone, nova, neutron, cinder)
class DataGatherer(Thread):
"""Periodically retrieve data from openstack in a separate thread,
save as pickle to cache_file
"""
def __init__(self):
Thread.__init__(self)
self.daemon = True
self.duration = 0
self.refresh_interval = config.get('cache_refresh_interval', 900)
self.cache_file = config['cache_file']
self.use_nova_volumes = config.get('use_nova_volumes', True)
def _get_keystone_info(self, keystone):
info = {}
try:
info['tenants'] = [x._info for x in keystone.tenants.list()]
except AttributeError:
log.info("Error getting tenants.list, continue with projects.list")
info['tenants'] = [x._info for x in keystone.projects.list()]
log.debug("Number of projects: %s", len(info['tenants']))
return info
def _get_neutron_info(self, neutron):
info = {}
info['floatingips'] = neutron.list_floatingips()['floatingips']
info['networks'] = neutron.list_networks()['networks']
info['ports'] = neutron.list_ports()['ports']
info['routers'] = neutron.list_routers()['routers']
info['subnets'] = neutron.list_subnets()['subnets']
return info
def _get_nova_info(self, nova, cinder, prodstack):
info = {}
info['hypervisors'] = [x._info for x in nova.hypervisors.list()]
info['services'] = [x._info for x in nova.services.list()]
info['flavors'] = [x._info for x in nova.flavors.list(is_public=None)]
info['aggregates'] = [x.to_dict() for x in nova.aggregates.list()]
info['instances'] = []
# Exclude instances in 'BUILD' state as they cannot be used as markers:
# https://github.com/CanonicalLtd/prometheus-openstack-exporter/issues/90
valid_statuses = ['ACTIVE', 'ERROR', 'SHELVED_OFFLOADED', 'SHUTOFF', 'SUSPENDED', 'VERIFY_RESIZE']
for status in valid_statuses:
marker = ''
while True:
search_opts = {'all_tenants': '1', 'limit': '100', 'marker': marker, 'status': status}
new_instances = [x._info for x in nova.servers.list(search_opts=search_opts)]
if new_instances:
marker = new_instances[-1]['id']
info['instances'].extend(new_instances)
else:
break
info['volume_quotas'] = {}
info['nova_quotas'] = {}
for t in prodstack['tenants']:
tid = t['id']
if self.use_nova_volumes:
info['volume_quotas'][tid] = cinder.quotas.get(tid, usage=True)._info
# old OS versions (e.g. Mitaka) will 404 if we request details
try:
info['nova_quotas'][tid] = nova.quotas.get(tid, detail=True)._info
except Exception:
info['nova_quotas'][tid] = nova.quotas.get(tid)._info
return info
def run(self):
log.debug("Starting data gather thread")
prodstack = {}
while True:
start_time = time()
try:
keystone, nova, neutron, cinder = get_clients()
prodstack.update(self._get_keystone_info(keystone))
prodstack.update(self._get_neutron_info(neutron))
prodstack.update(self._get_nova_info(nova, cinder, prodstack))
except Exception:
# Ignore failures, we will try again after refresh_interval.
# Most of them are termporary ie. connectivity problmes
# To alert on stale cache use openstack_exporter_cache_age_seconds metric
log.critical("Error getting stats: {}".format(traceback.format_exc()))
else:
with open(self.cache_file + '.new', "wb+") as f:
pickle.dump((prodstack, ), f, pickle.HIGHEST_PROTOCOL)
rename(self.cache_file + '.new', self.cache_file)
log.debug("Done dumping stats to {}".format(self.cache_file))
self.duration = time() - start_time
sleep(self.refresh_interval)
def get_stats(self):
registry = CollectorRegistry()
labels = ['cloud']
age = Gauge('openstack_exporter_cache_age_seconds',
'Cache age in seconds. It can reset more frequently '
'than scraping interval so we use Gauge',
labels, registry=registry)
label_values = [config['cloud']]
age.labels(*label_values).set(time() - path.getmtime(self.cache_file))
duration = Gauge('openstack_exporter_cache_refresh_duration_seconds',
'Cache refresh duration in seconds.',
labels, registry=registry)
duration.labels(*label_values).set(self.duration)
return generate_latest(registry)
class Neutron():
def __init__(self):
self.registry = CollectorRegistry()
self.prodstack = {}
with open(config['cache_file'], 'rb') as f:
self.prodstack = pickle.load(f)[0]
self.tenant_map = {t['id']: t['name'] for t in self.prodstack['tenants']}
self.network_map = {n['id']: n['name'] for n in self.prodstack['networks']}
self.subnet_map = {
n['id']: {'name': n['name'], 'pool': n['allocation_pools']} for n in self.prodstack['subnets']}
self.routers = self.prodstack['routers']
self.ports = self.prodstack['ports']
self.floating_ips = self.prodstack['floatingips']
def _get_router_ip(self, uuid):
owner = "network:router_gateway"
for port in self.ports:
if port["device_id"] == uuid and port["device_owner"] == owner:
if port["status"] == "ACTIVE" and port["fixed_ips"]:
return port["fixed_ips"][0]["ip_address"]
def get_floating_ips(self):
ips = {}
for ip in self.floating_ips:
subnet = self.network_map[ip['floating_network_id']]
try:
tenant = self.tenant_map[ip['tenant_id']]
except KeyError:
tenant = 'Unknown tenant ({})'.format(ip['tenant_id'])
key = (config['cloud'], subnet, tenant, 'floatingip', ip['status'])
if key in ips:
ips[key] += 1
else:
ips[key] = 1
return ips
def get_router_ips(self):
ips = {}
for r in self.routers:
if self._get_router_ip(r['id']):
if r['tenant_id'].startswith('<Tenant {'):
r['tenant_id'] = ast.literal_eval(r['tenant_id'][8:-1])['id']
try:
tenant = self.tenant_map[r['tenant_id']]
except KeyError:
tenant = 'Unknown tenant ({})'.format(r['tenant_id'])
subnet = self.network_map[r['external_gateway_info']['network_id']]
key = (config['cloud'], subnet, tenant, 'routerip', r['status'])
if key in ips:
ips[key] += 1
else:
ips[key] = 1
return ips
def gen_subnet_size(self):
labels = ['cloud', 'network_name']
net_size = Gauge('neutron_net_size',
'Neutron networks size',
labels, registry=self.registry)
for n in self.prodstack['networks']:
size = 0
for subnet in n['subnets']:
for pool in self.subnet_map[subnet]['pool']:
if ':' in pool['start']:
# Skip IPv6 address pools; they are big enough to
# drown the IPv4 numbers we might care about.
continue
size += IPRange(pool['start'], pool['end']).size
label_values = [config['cloud'], self.network_map[n['id']]]
net_size.labels(*label_values).set(size)
def get_stats(self):
labels = ['cloud', 'subnet_name', 'tenant', 'ip_type', 'ip_status']
ips = self.get_floating_ips()
ips.update(self.get_router_ips())
metrics = Gauge('neutron_public_ip_usage',
'Neutron floating IP and router IP usage statistics',
labels, registry=self.registry)
for k, v in ips.items():
metrics.labels(*k).set(v)
self.gen_subnet_size()
return generate_latest(self.registry)
class Cinder():
def __init__(self):
self.registry = CollectorRegistry()
self.prodstack = {}
with open(config['cache_file'], 'rb') as f:
self.prodstack = pickle.load(f)[0]
self.tenant_map = {t['id']: t['name'] for t in self.prodstack['tenants']}
self.use_nova_volumes = config.get('use_nova_volumes', True)
def gen_volume_quota_stats(self):
gbs = Gauge('cinder_quota_volume_disk_gigabytes',
'Cinder volume metric (GB)',
['cloud', 'tenant', 'type'], registry=self.registry)
vol = Gauge('cinder_quota_volume_disks',
'Cinder volume metric (number of volumes)',
['cloud', 'tenant', 'type'], registry=self.registry)
if not self.use_nova_volumes:
return
for t, q in self.prodstack['volume_quotas'].items():
if t in self.tenant_map:
tenant = self.tenant_map[t]
else:
tenant = 'orphaned'
for tt in ['limit', 'in_use', 'reserved']:
gbs.labels(config['cloud'], tenant, tt).inc(q['gigabytes'][tt])
vol.labels(config['cloud'], tenant, tt).inc(q['volumes'][tt])
def get_stats(self):
self.gen_volume_quota_stats()
return generate_latest(self.registry)
class Nova():
def __init__(self):
self.registry = CollectorRegistry()
self.prodstack = {}
with open(config['cache_file'], 'rb') as f:
self.prodstack = pickle.load(f)[0]
self.hypervisors = self.prodstack['hypervisors']
self.tenant_map = {t['id']: t['name'] for t in self.prodstack['tenants']}
self.flavor_map = {f['id']: {'ram': f['ram'], 'disk': f['disk'], 'vcpus': f['vcpus']}
for f in self.prodstack['flavors']}
self.aggregate_map = {}
self.services_map = {}
for s in self.prodstack['services']:
if s['binary'] == 'nova-compute':
self.services_map[s['host']] = s['status']
for agg in self.prodstack['aggregates']:
self.aggregate_map.update({i: agg['name'] for i in agg['hosts']})
def _get_schedulable_instances(self, host):
free_vcpus = host['vcpus'] * config['openstack_allocation_ratio_vcpu'] - host['vcpus_used']
free_ram_mbs = host['memory_mb'] * config['openstack_allocation_ratio_ram'] - host['memory_mb_used']
free_disk_gbs = host['local_gb'] * config['openstack_allocation_ratio_disk'] - host['local_gb_used']
s = config['schedulable_instance_size']
return min(int(free_vcpus / s['vcpu']),
int(free_ram_mbs / s['ram_mbs']),
int(free_disk_gbs / s['disk_gbs']))
def _get_schedulable_instances_capacity(self, host):
capacity_vcpus = host['vcpus'] * config['openstack_allocation_ratio_vcpu']
capacity_ram_mbs = host['memory_mb'] * config['openstack_allocation_ratio_ram']
capacity_disk_gbs = host['local_gb'] * config['openstack_allocation_ratio_disk']
s = config['schedulable_instance_size']
return min(int(capacity_vcpus / s['vcpu']),
int(capacity_ram_mbs / s['ram_mbs']),
int(capacity_disk_gbs / s['disk_gbs']))
def gen_hypervisor_stats(self):
labels = ['cloud', 'hypervisor_hostname', 'aggregate', 'nova_service_status', 'arch']
vms = Gauge('hypervisor_running_vms', 'Number of running VMs', labels, registry=self.registry)
vcpus_total = Gauge('hypervisor_vcpus_total', 'Total number of vCPUs', labels, registry=self.registry)
vcpus_used = Gauge('hypervisor_vcpus_used', 'Number of used vCPUs', labels, registry=self.registry)
mem_total = Gauge(
'hypervisor_memory_mbs_total', 'Total amount of memory in MBs', labels, registry=self.registry)
mem_used = Gauge('hypervisor_memory_mbs_used', 'Used memory in MBs', labels, registry=self.registry)
disk_total = Gauge(
'hypervisor_disk_gbs_total', 'Total amount of disk space in GBs', labels, registry=self.registry)
disk_used = Gauge('hypervisor_disk_gbs_used', 'Used disk space in GBs', labels, registry=self.registry)
schedulable_instances = Gauge('hypervisor_schedulable_instances',
'Number of schedulable instances, see "schedulable_instance_size" option',
labels, registry=self.registry)
schedulable_instances_capacity = Gauge('hypervisor_schedulable_instances_capacity',
'Number of schedulable instances we have capacity for',
labels, registry=self.registry)
def squashnone(val, default=0):
if val is None:
return default
return val
for h in self.hypervisors:
log.debug("Hypervisor: %s", h)
host = h['service']['host']
log.debug("host: %s", host)
cpu_info = h['cpu_info']
log.debug("cpu_info: %s", cpu_info)
arch = 'Unknown'
if not cpu_info:
log.info("Could not get cpu info")
elif type(cpu_info) != dict:
cpu_info = json.loads(cpu_info)
arch = cpu_info['arch']
label_values = [
config['cloud'], host, self.aggregate_map.get(host, 'unknown'), self.services_map[host], arch]
# Disabled hypervisors return None below, convert to 0
vms.labels(*label_values).set(squashnone(h['running_vms']))
vcpus_total.labels(*label_values).set(squashnone(h['vcpus']))
vcpus_used.labels(*label_values).set(squashnone(h['vcpus_used']))
mem_total.labels(*label_values).set(squashnone(h['memory_mb']))
mem_used.labels(*label_values).set(squashnone(h['memory_mb_used']))
disk_total.labels(*label_values).set(squashnone(h['local_gb']))
disk_used.labels(*label_values).set(squashnone(h['local_gb_used']))
if config.get("schedulable_instance_size", False):
schedulable_instances.labels(*label_values).set(self._get_schedulable_instances(h))
schedulable_instances_capacity.labels(*label_values).set(self._get_schedulable_instances_capacity(h))
def gen_instance_stats(self):
missing_flavors = False
instances = Gauge('nova_instances',
'Nova instances metrics',
['cloud', 'tenant', 'instance_state'], registry=self.registry)
res_ram = Gauge('nova_resources_ram_mbs',
'Nova RAM usage metric',
['cloud', 'tenant'], registry=self.registry)
res_vcpus = Gauge('nova_resources_vcpus',
'Nova vCPU usage metric',
['cloud', 'tenant'], registry=self.registry)
res_disk = Gauge('nova_resources_disk_gbs',
'Nova disk usage metric',
['cloud', 'tenant'], registry=self.registry)
for i in self.prodstack['instances']:
if i['tenant_id'] in self.tenant_map:
tenant = self.tenant_map[i['tenant_id']]
else:
tenant = 'orphaned'
instances.labels(config['cloud'], tenant, i['status']).inc()
if i['flavor']['id'] in self.flavor_map:
flavor = self.flavor_map[i['flavor']['id']]
res_ram.labels(config['cloud'], tenant).inc(flavor['ram'])
res_vcpus.labels(config['cloud'], tenant).inc(flavor['vcpus'])
res_disk.labels(config['cloud'], tenant).inc(flavor['disk'])
else:
missing_flavors = True
# If flavors were deleted we can't reliably find out resouerce use
if missing_flavors:
self.registry.unregister(res_ram)
self.registry.unregister(res_vcpus)
self.registry.unregister(res_disk)
res_ram = Gauge('nova_resources_ram_mbs', 'Nova RAM usage metric unavailable, missing flavors',
[], registry=self.registry)
res_vcpus = Gauge('nova_resources_vcpus', 'Nova vCPU usage metric unavailable, missing flavors',
[], registry=self.registry)
res_disk = Gauge('nova_resources_disk_gbs', 'Nova disk usage metric unavailable, missing flavors',
[], registry=self.registry)
def gen_overcommit_stats(self):
labels = ['cloud', 'resource']
openstack_overcommit = Gauge('openstack_allocation_ratio', 'Openstack overcommit ratios',
labels, registry=self.registry)
label_values = [config['cloud'], 'vcpu']
openstack_overcommit.labels(*label_values).set(config['openstack_allocation_ratio_vcpu'])
label_values = [config['cloud'], 'ram']
openstack_overcommit.labels(*label_values).set(config['openstack_allocation_ratio_ram'])
label_values = [config['cloud'], 'disk']
openstack_overcommit.labels(*label_values).set(config['openstack_allocation_ratio_disk'])
def gen_quota_stats(self):
cores = Gauge('nova_quota_cores',
'Nova cores metric',
['cloud', 'tenant', 'type'], registry=self.registry)
fips = Gauge('nova_quota_floating_ips',
'Nova floating IP addresses (number)',
['cloud', 'tenant', 'type'], registry=self.registry)
inst = Gauge('nova_quota_instances',
'Nova instances (number)',
['cloud', 'tenant', 'type'], registry=self.registry)
ram = Gauge('nova_quota_ram_mbs',
'Nova RAM (MB)',
['cloud', 'tenant', 'type'], registry=self.registry)
for t, q in self.prodstack['nova_quotas'].items():
if t in self.tenant_map:
tenant = self.tenant_map[t]
else:
tenant = 'orphaned'
# we get detailed quota information only on recent OS versions
if isinstance(q['cores'], int):
cores.labels(config['cloud'], tenant, 'limit').set(q['cores'])
fips.labels(config['cloud'], tenant, 'limit').set(q['floating_ips'])
inst.labels(config['cloud'], tenant, 'limit').set(q['instances'])
ram.labels(config['cloud'], tenant, 'limit').set(q['ram'])
else:
for tt in ['limit', 'in_use', 'reserved']:
cores.labels(config['cloud'], tenant, tt).inc(q['cores'][tt])
fips.labels(config['cloud'], tenant, tt).inc(q['floating_ips'][tt])
inst.labels(config['cloud'], tenant, tt).inc(q['instances'][tt])
ram.labels(config['cloud'], tenant, tt).inc(q['ram'][tt])
def get_stats(self):
log.debug("get_stats")
self.gen_hypervisor_stats()
self.gen_instance_stats()
self.gen_overcommit_stats()
self.gen_quota_stats()
return generate_latest(self.registry)
class Swift():
def __init__(self):
self.registry = CollectorRegistry()
self.baseurl = 'http://{}:6000/recon/{}'
self.swift_hosts = config.get('swift_hosts', [])
def gen_up_stats(self):
labels = ['cloud', 'hostname']
swift_up = Gauge('swift_host_up', 'Swift host reachability',
labels, registry=self.registry)
for h in self.swift_hosts:
try:
requests.get(self.baseurl.format(h, 'diskusage'))
swift_up.labels(config['cloud'], h).set(1)
except requests.exceptions.RequestException:
swift_up.labels(config['cloud'], h).set(0)
def gen_disk_usage_stats(self):
labels = ['cloud', 'hostname', 'device', 'type']
swift_disk = Gauge('swift_disk_usage_bytes', 'Swift disk usage in bytes',
labels, registry=self.registry)
for h in self.swift_hosts:
try:
r = requests.get(self.baseurl.format(h, 'diskusage'))
except requests.exceptions.RequestException:
continue
for disk in r.json():
if not all([disk.get(i, False) for i in ['size', 'used', 'device']]):
continue
swift_disk.labels(config['cloud'], h, disk['device'], 'size').set(int(disk['size']))
swift_disk.labels(config['cloud'], h, disk['device'], 'used').set(int(disk['used']))
def gen_quarantine_stats(self):
labels = ['cloud', 'hostname', 'ring']
swift_quarantine = Gauge('swift_quarantined_objects', 'Number of quarantined objects',
labels, registry=self.registry)
for h in self.swift_hosts:
try:
r = requests.get(self.baseurl.format(h, 'quarantined'))
except requests.exceptions.RequestException:
continue
for ring in ['accounts', 'objects', 'containers']:
swift_quarantine.labels(config['cloud'], h, ring).set(r.json().get(ring))
def _get_object_ring_replication_stats(self, h, swift_repl_duration):
# Object replication is special
try:
r = requests.get(self.baseurl.format(h, 'replication/object'))
except requests.exceptions.RequestException:
return
try:
swift_repl_duration.labels(config['cloud'], h, 'object').set(r.json()['object_replication_time'])
except TypeError:
print(traceback.format_exc())
def _get_ring_replication_stats(self, ring, h, swift_repl_duration, swift_repl):
metrics = ['attempted', 'diff', 'diff_capped', 'empty',
'failure', 'hashmatch', 'no_change', 'remote_merge',
'remove', 'rsync', 'success', 'ts_repl']
try:
r = requests.get(self.baseurl.format(h, 'replication/' + ring))
except requests.exceptions.RequestException:
return
try:
swift_repl_duration.labels(config['cloud'], h, ring).set(r.json()['replication_time'])
except TypeError:
print(traceback.format_exc())
for metric in metrics:
try:
swift_repl.labels(config['cloud'], h, ring, metric).set(r.json()['replication_stats'][metric])
except TypeError:
print(traceback.format_exc())
def gen_replication_stats(self):
labels = ['cloud', 'hostname', 'ring', 'type']
swift_repl = Gauge('swift_replication_stats', 'Swift replication stats', labels, registry=self.registry)
labels = ['cloud', 'hostname', 'ring']
swift_repl_duration = Gauge('swift_replication_duration_seconds', 'Swift replication duration in seconds',
labels, registry=self.registry)
for h in self.swift_hosts:
self._get_object_ring_replication_stats(h, swift_repl_duration)
for ring in ['account', 'container']:
self._get_ring_replication_stats(ring, h, swift_repl_duration, swift_repl)
def get_stats(self):
self.gen_up_stats()
self.gen_disk_usage_stats()
self.gen_quarantine_stats()
self.gen_replication_stats()
return generate_latest(self.registry)
class SwiftAccountUsage():
def __init__(self):
self.registry = CollectorRegistry()
self.hash_path_prefix = config.get('hash_path_prefix', None)
if self.hash_path_prefix:
swift.common.utils.HASH_PATH_PREFIX = self.hash_path_prefix
self.hash_path_suffix = config.get('hash_path_suffix', None)
if self.hash_path_suffix:
swift.common.utils.HASH_PATH_SUFFIX = self.hash_path_suffix
self.reseller_prefix = config.get('reseller_prefix', 'AUTH_')
self.ring_path = config.get('ring_path', '/etc/swift')
try:
self.account_ring = self._get_account_ring()
except SystemExit:
# Most likely raised by swift.common.utils.validate_configuration().
raise Exception(
"Is swift.conf readable or at least one hash path variable configured?")
def _read_keystone_tenants_map(self, map_path):
if not map_path:
return {}
m = {}
with open(map_path) as km:
line = km.readline()
while line != '':
name, id = line.strip().split()
m[name] = id
line = km.readline()
return m
def _get_account_ring(self):
"""Read the account ring from the configured location, and return it."""
return Ring(
serialized_path=self.ring_path,
ring_name='account',
)
def _get_account_usage(self, account):
partition, nodes = self.account_ring.get_nodes(account=account)
node = random.choice(nodes)
account_url = 'http://{ip}:{port}/{device}/{partition}/{account}'.format(
account=account,
partition=partition,
**node)
response = requests.head(account_url)
if response.status_code == 204:
return int(response.headers['X-Account-Bytes-Used'])
else:
return 0
def gen_account_stats(self):
self.keystone_tenants_map = self._read_keystone_tenants_map(
config.get('keystone_tenants_map', None))
labels = ['cloud', 'swift_account', 'tenant']
swift_account = Gauge(
'swift_account_bytes_used', 'Swift account usage in bytes', labels, registry=self.registry)
for tenant_name, tenant_id in self.keystone_tenants_map.iteritems():
account = self.reseller_prefix + tenant_id
bytes_used = self._get_account_usage(account)
swift_account.labels(config['cloud'], account, tenant_name).set(bytes_used)
def get_stats(self):
self.gen_account_stats()
return generate_latest(self.registry)
class ForkingHTTPServer(ForkingMixIn, HTTPServer):
pass
# This could perhaps be cleverer, but surely not simpler.
COLLECTORS = {
'cinder': Cinder,
'neutron': Neutron,
'nova': Nova,
'swift': Swift,
'swift-account-usage': SwiftAccountUsage,
}
DATA_GATHERER_USERS = [
'cinder',
'neutron',
'nova',
]
def get_collectors(collectors):
# For backwards compatibility and when enabled_collectors isn't defined,
# specify default set of collectors before commit 662b70f and f27cda8.
# https://github.com/CanonicalLtd/prometheus-openstack-exporter/issues/80
if not collectors:
return ['cinder', 'swift', 'nova', 'neutron']
return collectors
def data_gatherer_needed(config):
return set(get_collectors(config.get('enabled_collectors'))).intersection(DATA_GATHERER_USERS)
class OpenstackExporterHandler(BaseHTTPRequestHandler):
def __init__(self, *args, **kwargs):
BaseHTTPRequestHandler.__init__(self, *args, **kwargs)
def do_GET(self):
url = urlparse.urlparse(self.path)
if url.path == '/metrics':
try:
collectors = [COLLECTORS[collector]() for collector in get_collectors(config.get('enabled_collectors'))]
log.debug("Collecting stats..")
output = ''
for collector in collectors:
output += collector.get_stats()
if data_gatherer:
output += data_gatherer.get_stats()
self.send_response(200)
self.send_header('Content-Type', CONTENT_TYPE_LATEST)
self.end_headers()
self.wfile.write(output)
except Exception:
self.send_response(500)
self.end_headers()
self.wfile.write(traceback.format_exc())
elif url.path == '/':
self.send_response(200)
self.end_headers()
self.wfile.write("""<html>
<head><title>OpenStack Exporter</title></head>
<body>
<h1>OpenStack Exporter</h1>
<p>Visit <code>/metrics</code> to use.</p>
</body>
</html>""")
else:
self.send_response(404)
self.end_headers()
def handler(*args, **kwargs):
OpenstackExporterHandler(*args, **kwargs)
if __name__ == '__main__':
parser = argparse.ArgumentParser(usage=__doc__,
description='Prometheus OpenStack exporter',
formatter_class=argparse.RawTextHelpFormatter)
parser.add_argument('config_file', nargs='?',
help='Configuration file path',
default='/etc/prometheus/prometheus-openstack-exporter.yaml',
type=argparse.FileType('r'))
args = parser.parse_args()
log.setLevel(logging.DEBUG)
for logsock in ('/dev/log', '/var/run/syslog'):
if path.exists(logsock):
log.addHandler(logging.handlers.SysLogHandler(address=logsock))
else:
log.addHandler(logging.StreamHandler())
config = yaml.safe_load(args.config_file.read())
numeric_log_level = getattr(logging, config.get('log_level', 'INFO').upper(), None)
if not isinstance(numeric_log_level, int):
raise ValueError('Invalid log level: %s' % config.get('log_level'))
log.setLevel(numeric_log_level)
data_gatherer = None
if data_gatherer_needed(config):
data_gatherer = DataGatherer()
data_gatherer.start()
server = ForkingHTTPServer(('', config.get('listen_port')), handler)
server.serve_forever()
|