Turbonomic Report Interface
Project description
vmt-report: Reporting Helper
vmt-report adds Turbonomic specific handlers for the arbiter data handling package. This enabled Turbonomic API calls to be easily combined and manipulated into standardized output formats such as CSV, and JSON for data export or simple reporting needs.
Installation
pip install vmtreport
Usage
vmt-report installs the appropriate vmtconnect
and credstore
handlers for
connecting to Turbonomic instances using vmt-connect. The JSON config controls most of the behavior of arbiter,
while the process worker handles data manipulation.
Example Script (example.py)
# Dump selected fields from all market actions
import arbiter
import vmtreport
import umsg
# source worker sub-process must accept 3 parameters
def actions(source, config, logger):
umsg.log(f"Retrieving data from {config['resource']}", logger=logger)
res = source.connect().get_actions()
fields = ['createTime', 'actionType', 'details']
return [{x: res[x]} for x in res if x in fields]
if __name__ == '__main__':
report = arbiter.Process('report.config', actions)
report.run()
Example Config (report.config)
{
"sources": [
{
"handler": "vmtconnect",
"resource": "https://localhost",
"authentication": {
"type": "credstore",
"credential": "./credential.credstore",
"keyfile": "./turbo.keyfile"
}
}
],
"outputs": [
{
"handler": "CSV",
"resource": "file:/tmp/{timestamp}-actions.csv"
}
],
"notifications": [
{
"handler": "email",
"on_success": true,
"on_failure": true,
"options": {
"email": {
"from": ["no-reply@turbonomic.com"],
"to": ["user@example.com"],
"subject": "Actions Report for {date}",
"body": "Wasted Storage Report generated on {timestamp}.",
"body_error": "Errors happened: {errors}"
}
}
}
],
"logging": {
"mode": "DEBUG"
},
"process_timeout": 60
}
Documentation
The user guide is a good place to start. Detailed documentation is also available here.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file vmtreport-2.1.0.tar.gz
.
File metadata
- Download URL: vmtreport-2.1.0.tar.gz
- Upload date:
- Size: 20.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfe721f660f63e8eb132890e889de02bd70170970a05735c6dc77acf93cf5c2c |
|
MD5 | 8bd5e7e10969aa6b5012a7e5eaa7020d |
|
BLAKE2b-256 | 65ecfdb13ff45b7caae9a3d3e0bfeb981a91dea37294cd0f69deb59e27feb3e5 |
File details
Details for the file vmtreport-2.1.0-py3-none-any.whl
.
File metadata
- Download URL: vmtreport-2.1.0-py3-none-any.whl
- Upload date:
- Size: 25.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0343cdfe2cefd549d3d64f0775583689322ed3b77de52765400cbd1f8e9c46e8 |
|
MD5 | 421051078ab43ff29b15a601817e9571 |
|
BLAKE2b-256 | 459534c234bfd40ebcab863c2de05b4dd17d665a8204bc57ff3899b194e9ab3e |