Skip to main content

Client for the Clowder monitoring server

Project description

# Clowder Python Client

This is the python repository for the Clowder python client.

### How to install
```
sudo pip install clowder
```


### How to test

Basic example for tracking memory usage on server
Create a python file memory_usage.py

```
import clowder
import psutil

clowder.api_key = '29rTtCyrBfZvABBMMbne'

clowder.ok({
'name': 'Memory Utilization',
'value': psutil.phymem_usage().percent
})
```

### How to use

Run the file and make sure it works

```
python memory_usage.py
```

Then create a cron job to run every 5 minutes

```
*/5 * * * * python memory_usage.py
```

### Parameters

Passed as python dictionary

- *name*: (string - REQUIRED) A unique name for the check. All checks with this name will be combined.
- *url*: (string - optional) The url to send data to. Defaults to www.clowder.io
- *value*: (float - optional) The value of the check (such as response time, queue length, rows processed, etc.)
- *status*: (integer - optional) Whether our not the check is passing (1, 0, -1). If failing, an alert is send.
- *frequency*: (integer - optional) Duration in minutes until next check. If time passes without check, alert sounds.
- *alert*: (function - optional) A lamdba function that passes or fails based on *value*

Project details


Download files

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

Source Distribution

clowder-0.1.4.tar.gz (10.0 kB view details)

Uploaded Source

File details

Details for the file clowder-0.1.4.tar.gz.

File metadata

  • Download URL: clowder-0.1.4.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for clowder-0.1.4.tar.gz
Algorithm Hash digest
SHA256 860a6c841f79b41fc73b6b0e994c91ca079b827152f0b23a03f833822b5439e4
MD5 f966587be4e1186d9c6dc130b3b68597
BLAKE2b-256 24665c8367233222d6566aa6a836d4fcc8f4c39bc151f0ce4996cf59677d2b47

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