Metadata-Version: 2.4
Name: nectar-metrics
Version: 2.0.0
Summary: Metrics collection for the Nectar Research Cloud
Home-page: https://github.com/NeCTAR-RC/nectar-metrics
Author: ARDC Nectar Cloud Services
Author-email: coreservices@ardc.edu.au
License: GPL-3.0-or-later
Keywords: nectar-metrics
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.12
License-File: LICENSE
Requires-Dist: python-keystoneclient
Requires-Dist: python-cinderclient
Requires-Dist: python-heatclient
Requires-Dist: python-magnumclient
Requires-Dist: python-muranoclient
Requires-Dist: python-novaclient
Requires-Dist: python-troveclient
Requires-Dist: warreclient
Requires-Dist: whisper
Requires-Dist: gnocchiclient
Requires-Dist: nectarallocationclient
Requires-Dist: manukaclient
Requires-Dist: placementclient
Requires-Dist: prometheus-client
Requires-Dist: requests
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pbr
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

===============================
nectar-metrics
===============================

Metrics collection for the NeCTAR Research Cloud.

* License: GPLv3+ license

Manual Testing
--------------

After setting up a metrics.ini and running nectar-nova-metrics using a
small selection of servers::

   $ nectar-metrics-nova --protocol debug --limit 10

   tenant.2b238c7f0f1348dcba1250841c07bc2b.total_instances 1.00 1415353638
   tenant.2b238c7f0f1348dcba1250841c07bc2b.used_memory 65536.00 1415353638
   tenant.2b238c7f0f1348dcba1250841c07bc2b.used_vcpus 16.00 1415353638
   az.monash-01.total_instances 1.00 1415353638
   az.monash-01.used_memory 65536.00 1415353638
   az.monash-01.used_vcpus 16.00 1415353638
   az.monash-01.used_disk 10.00 1415353638
   az.monash-01.tenant.2b238c7f0f1348dcba1250841c07bc2b.total_instances 1.00 1415353638
   az.monash-01.tenant.2b238c7f0f1348dcba1250841c07bc2b.used_memory 65536.00 1415353638
   az.monash-01.tenant.2b238c7f0f1348dcba1250841c07bc2b.used_vcpus 16.00 1415353638
   az.monash-01.domain.anu_edu_au.used_vcpus 16.00 1415353638
   az.monash-01.instances_deleted 0.00 1415353638
   az.monash-01.instances_created 0.00 1415353638


Nova
----

Nova metrics::

   $ nectar-metrics-nova --help
   usage: nectar-metrics-nova [-h] [-v] [-q] --protocol
                              {debug,carbon,carbon_pickle}
                              [--carbon-host CARBON_HOST]
                              [--carbon-port CARBON_PORT] [--config CONFIG]
                              [--limit LIMIT]

   optional arguments:
     -h, --help            show this help message and exit
     -v, --verbose         Increase verbosity (specify multiple times for more)
                           (default: 0)
     -q, --quiet           Don't print any logging output (default: False)
     --protocol {debug,carbon,carbon_pickle}
     --carbon-host CARBON_HOST
                           Carbon Host. (default: None)
     --carbon-port CARBON_PORT
                           Carbon Port. (default: 2003)
     --config CONFIG       Config file path. (default: /etc/nectar/metrics.ini)
     --limit LIMIT         Limit the response to some servers only. (default:
                           None)

Nova output is grouped in several ways: by tenant, by cell, by cell by
tenant and by cell by email domain of the user who launched the
hosts.::

   $ nectar-metrics-nova --protocol debug --limit 1
   tenant.2b238c7f0f1348dcba1250841c07bc2b.total_instances 1.00 1415353638
   tenant.2b238c7f0f1348dcba1250841c07bc2b.used_memory 65536.00 1415353638
   tenant.2b238c7f0f1348dcba1250841c07bc2b.used_vcpus 16.00 1415353638
   az.monash-01.total_instances 1.00 1415353638
   az.monash-01.used_memory 65536.00 1415353638
   az.monash-01.used_vcpus 16.00 1415353638
   az.monash-01.used_disk 10.00 1415353638
   az.monash-01.tenant.2b238c7f0f1348dcba1250841c07bc2b.total_instances 1.00 1415353638
   az.monash-01.tenant.2b238c7f0f1348dcba1250841c07bc2b.used_memory 65536.00 1415353638
   az.monash-01.tenant.2b238c7f0f1348dcba1250841c07bc2b.used_vcpus 16.00 1415353638
   az.monash-01.domain.anu_edu_au.used_vcpus 16.00 1415353638
   az.monash-01.instances_deleted 0.00 1415353638
   az.monash-01.instances_created 0.00 1415353638

Cinder
------

Cinder gathers usage information about current cinder usage.::

   $ nectar-metrics-cinder --help
   usage: nectar-metrics-cinder [-h] [-v] [-q] --protocol
                                {debug,carbon,carbon_pickle}
                                [--carbon-host CARBON_HOST]
                                [--carbon-port CARBON_PORT] [--config CONFIG]
                                [--limit LIMIT]

   optional arguments:
     -h, --help            show this help message and exit
     -v, --verbose         Increase verbosity (specify multiple times for more)
                           (default: 0)
     -q, --quiet           Don't print any logging output (default: False)
     --protocol {debug,carbon,carbon_pickle}
     --carbon-host CARBON_HOST
                           Carbon Host. (default: None)
     --carbon-port CARBON_PORT
                           Carbon Port. (default: 2003)
     --config CONFIG       Config file path. (default: /etc/nectar/metrics.ini)
     --limit LIMIT         Limit the response to some volumes only. (default:
                           None)

Cinder metrics are grouped by tenant and by az by tenant::

   $ nectar-metrics-cinder --protocol debug --limit 1
   tenant.f4fff40d98984cea9e39af597456001b.used_volume_size 1000.00 1415354196
   tenant.f4fff40d98984cea9e39af597456001b.total_volumes 1.00 1415354196
   az.NCI.tenant.f4fff40d98984cea9e39af597456001b.used_volume_size 1000.00 1415354196
   az.NCI.tenant.f4fff40d98984cea9e39af597456001b.total_volumes 1.00 1415354196

RCShibboleth
------------

RCShibboleth queries the RCShibboleth database and gathers details of
the current user registrations.::

   $ nectar-metrics-rcshibboleth --help
   usage: nectar-metrics-rcshibboleth [-h] [-v] [-q] --protocol
                                      {debug,carbon,carbon_pickle}
                                      [--carbon-host CARBON_HOST]
                                      [--carbon-port CARBON_PORT]
                                      [--config CONFIG] [--from-date FROM_DATE]
                                      [--to-date TO_DATE]

   optional arguments:
     -h, --help            show this help message and exit
     -v, --verbose         Increase verbosity (specify multiple times for more)
                           (default: 0)
     -q, --quiet           Don't print any logging output (default: False)
     --protocol {debug,carbon,carbon_pickle}
     --carbon-host CARBON_HOST
                           Carbon Host. (default: None)
     --carbon-port CARBON_PORT
                           Carbon Port. (default: 2003)
     --config CONFIG       Config file path. (default: /etc/nectar/metrics.ini)
     --from-date FROM_DATE
                           When to backfill data from. (default: 2015-02-23
                           15:59:54.720779)
     --to-date TO_DATE     When to backfill data to. (default: 2015-02-23
                           15:59:54.720840)


The only metric that is reported is the current registrations grouped by IdP::

   $ nectar-metrics-rcshibboleth --protocol debug
   users.total 5018.00 1424666333
   users.idp_cc_swin_edu_au.total 59.00 1424666333
   users.aaf_latrobe_edu_au.total 40.00 1424666333
   users.idp1_griffith_edu_au.total 83.00 1424666333
   users.idp_csu_edu_au.total 17.00 1424666333
   users.idp_murdoch_edu_au.total 37.00 1424666333

