https://github.com/includeos/cortisol
Cortisol is a tool to run arbitrary performance benchmarks and log data to a google sheet
https://github.com/includeos/cortisol
Last synced: 4 months ago
JSON representation
Cortisol is a tool to run arbitrary performance benchmarks and log data to a google sheet
- Host: GitHub
- URL: https://github.com/includeos/cortisol
- Owner: includeos
- License: apache-2.0
- Created: 2017-11-10T09:26:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-10T09:39:47.000Z (over 7 years ago)
- Last Synced: 2025-01-18T17:49:22.088Z (5 months ago)
- Language: Python
- Size: 6.84 KB
- Stars: 0
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cortisol
Cortisol is a tool to run arbitrary performance benchmarks and log data to a google sheet
IncludeOS uses this internally to track performance over time. Tests can be written in any language.
Cortisol uses [gspread] to log data to Google Sheets.
## Tests
The test is given a parameter, typically test host to run against. The first line of output is the primary metric delivered by the test. Any following output will be added to the sheet as unprocessed text.
## Authentication and authorization
We use a Google API Service Account to auth/authz against the Google Sheet API. Each service account has a client_email which you'll find in the JSON file describing the service account. Share your sheet with this email. It'll look something like this: [email protected]
How to set up:
* Set up the Service Account
* Place the JSON file in the directory, naming it cortisol-service-acct.json
* Create a sheet
* Make sure the cell A1 contains the magic string ('This sheet is machine generated') so cortisol will allow itself to write to the sheet
* Place tests in the tests/ folder
* Set up tests.json and enter your tests and your targets
* Do a test run, fix any errors
* place cortisol in a cron job
[gspread]: https://github.com/burnash/gspread