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.0.0.tar.gz (42.2 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.0.0-py3-none-any.whl (52.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nectar_metrics-2.0.0.tar.gz
  • Upload date:
  • Size: 42.2 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.0.0.tar.gz
Algorithm Hash digest
SHA256 9f2cb43eaa892d6ea3a7b2310d59ff9cabbf5a50760a67e2c70787789390a4f0
MD5 870b3775a1d7d10c70a3fffaf70f2bad
BLAKE2b-256 2dcc6f10362945c375718f94112b550600c0d979515bd5b91d6a157ef8d0684a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nectar_metrics-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 52.2 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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 db30e1794c8b2545fab0e40eab85f13f83d4992597f85313771ec170c6b79da2
MD5 321f7c1e06d9a9c4613b26a930703b32
BLAKE2b-256 092b9e9023e7ef1ac5c71040068112c755a3217cff97d1dbd76e9ed962b817d4

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