Skip to content

1Birdo/Dash-birdo_sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Python + Javascript (In Dev)

Dashboard.birdo.uk SDK's

https://dashboard.birdo.uk

Currently The import is still being approved and test by PyPI Im also still trying to work with jsdelivr + NPM providers for the javascript distribution

https://www.jsdelivr.com/package/npm/birdo-sdk?tab=files

image

Python / Python3 (In Dev)

Official Python SDK for the Birdo Monitoring Service.

Installation

pip install BirdoDash-sdk

Usage

This will all be used to collect and send metric / statitics to your personal Dashboard to monitor all your servers visually

Avg CPU Usage Avg Memory Usage Avg Disk Usage Network In + Out

from BirdoDash_sdk import BirdoClient

# Initialize client
client = BirdoClient(
    api_key="your_api_key",
    server_name="MyServer"
)

# Start monitoring
client.start()

# ... your application runs ...

# Stop when done
client.stop()

Javascript (In Dev)

For Reference / Usage

https://www.jsdelivr.com/package/npm/birdo-sdk?tab=files

Usage Examples Browser Usage

<script src="https://cdn.jsdelivr.net/npm/birdo-sdk@latest/dist/browser.min.js"></script>
<script>
  const monitor = new Birdo({
    apiKey: 'your_api_key_here',
    serverName: 'MyWebApp'
  });
  
  monitor.start();
</script>

Node.js Usage

const Birdo = require('birdo-sdk');

const monitor = new Birdo({
  apiKey: 'your_api_key_here',
  serverName: 'MyServer',
  interval: 10000 // 10 seconds
});

monitor.start();

// Graceful shutdown
process.on('SIGINT', () => {
  monitor.stop();
  process.exit();
});

ES Modules

import Birdo from 'birdo-sdk';

const monitor = new Birdo({
  apiKey: 'your_api_key_here',
  serverName: 'MyService'
});

// Start monitoring
monitor.start();

// Or send once
monitor.sendOnce().then(success => {
  console.log('Metrics sent:', success);
});

License

MIT License - See LICENSE file for details.