Skip to main content

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nectar_metrics-2.1.0.tar.gz (44.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nectar_metrics-2.1.0-py3-none-any.whl (52.9 kB view details)

Uploaded Python 3

File details

Details for the file nectar_metrics-2.1.0.tar.gz.

File metadata

  • Download URL: nectar_metrics-2.1.0.tar.gz
  • Upload date:
  • Size: 44.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for nectar_metrics-2.1.0.tar.gz
Algorithm Hash digest
SHA256 017c8c12de124f4408a76e749a5f47c4aa0f8a7e1e4e5dcd1deea07eba47128c
MD5 db617f97cb7e55accdfaa22be060dab1
BLAKE2b-256 b24dda9362b78f7a9029966509553e18e89acf6cd2a3e84aa622ee6d27d395ef

See more details on using hashes here.

File details

Details for the file nectar_metrics-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: nectar_metrics-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 52.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for nectar_metrics-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61a40b1a8228c55ccf0595e466c99ea6afb3c4b266bcf217ee14e718fc695a17
MD5 61d5aadaa42b526f6639c1d88ed617bd
BLAKE2b-256 2d089e04fd4ee4d7bb882e2fa4a717945026c5e17159d0095385490c1dc7cd9e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page