Github Mirror / telegraf-plugins: 77563f0c

verified

Sort out README's and attach license info

Sort out README's and attach license info

Commit 77563f0c.

Authored 2021-12-04T15:45:51.000+00:00 by B Tasker in project Github Mirror / telegraf-plugins

+74 lines -1 lines

Commit Signature

Changes

diff --git a/bunny-cdn-stats/README.md b/bunny-cdn-stats/README.md
--- a/bunny-cdn-stats/README.md
+++ b/bunny-cdn-stats/README.md
# @@ -0,0 +1,49 @@
# +# BunnyCDN Telegraf exec plugin
# +
# +An `exec` plugin for Telegraf to poll the [BunnyCDN](https://bunny.net) API and retrieve stats for properties served through their CDN.
# +
# +By default, this will write into a measurement called `bunnycdn` - you can change this at the head of the script.
# +
# +
# +### Stats collected
# +
# +The following stats are extracted from the API
# +
# +- Request Hit Ratio (`RHR`)
# +- Bytes served at the edge (`edge_bytes`)
# +- Average origin response time (`mean_origin_response_time`)
# +- Average Request Hit Ratio (`mean_rhr`)
# +- Bytes served by origin (`origin_bytes`)
# +- Origin Response time (`origin_response_time`)
# +- Number of requests served (`requests_served`)
# +- Requests with 3xx status (`status_3xx`)
# +- Requests with 4xx status (`status_4xx`)
# +- Requests with 5xx status (`status_5xx`)
# +- Total bandwidth used (`total_bandwidth_used`)
# +- Total origin traffic (`total_origin_traffic`)
# +- Total Requests served (`total_requests_served`)
# +
# +### Setup
# +
# +Configure in telegraf as follows
# +
# +```
# +[[inputs.exec]]
# + commands = [
# + "/usr/local/src/telegraf_plugins/bunny-cdn-stats.py [API_KEY]",
# + ]
# + timeout = "60s"
# + interval = "15m"
# + name_suffix = ""
# + data_format = "influx"
# +```
# +
# +Replacing `[API_KEY]` with your BunnyCDN API Key (visible under "My Account")
# +
# +---
# +
# +### Copyright
# +
# +Copyright (c) 2021 [Ben Tasker](https://www.bentasker.co.uk)
# +
# +Released under [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt)
#
diff --git a/bunny-cdn-stats/bunny-cdn-stats.py b/bunny-cdn-stats/bunny-cdn-stats.py
--- a/bunny-cdn-stats/bunny-cdn-stats.py
+++ b/bunny-cdn-stats/bunny-cdn-stats.py
# @@ -1,5 +1,11 @@
# #!/usr/bin/env python3
# -
# +#
# +# Telegraf Exec plugin to poll BunnyCDN's API and retrieve stats
# +#
# +# Copyright (c) 2021 B Tasker
# +# Released under GNU GPL v3 - https://www.gnu.org/licenses/gpl-3.0.txt
# +#
# +#
# import requests
# import sys
# import time
#
diff --git a/nextcloud-user-quotas/README.md b/nextcloud-user-quotas/README.md
--- a/nextcloud-user-quotas/README.md
+++ b/nextcloud-user-quotas/README.md
# @@ -2,6 +2,8 @@
#
# An `exec` plugin that uses Nextcloud's API in order to retrieve current quota usage for each Nextcloud user - allowing reporting and alarming.
#
# +A fuller example of how to set this up can be [seen on my site](https://www.bentasker.co.uk/posts/documentation/linux/collecting-nextcloud-user-quota-info-with-telegraf.html)
# +
#
# ### Nextcloud setup
#
# @@ -53,3 +55,13 @@ To graph out per user, but exclude specific users, you can use the following Flu
# |> filter(fn: (r) => r.user != "admin" and r.user != "telegraf_api_poller")
# |> aggregateWindow(every: 5m, fn: mean)
# |> keep(columns: ["_time", "user", "_value"])
# +
# +
# +----
# +
# +### Copyright
# +
# +Copyright (c) 2021 [Ben Tasker](https://www.bentasker.co.uk)
# +
# +Released under [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt)
# +
#
diff --git a/nextcloud-user-quotas/nextcloud_user_quotas.py b/nextcloud-user-quotas/nextcloud_user_quotas.py
--- a/nextcloud-user-quotas/nextcloud_user_quotas.py
+++ b/nextcloud-user-quotas/nextcloud_user_quotas.py
# @@ -3,6 +3,8 @@
# # Telegraf Exec plugin to monitor nextcloud user quota usage
# #
# # Copyright (c) 2021 B Tasker
# +# Released under GNU GPL v3 - https://www.gnu.org/licenses/gpl-3.0.txt
# +#
# #
# import base64
# import requests
#
diff --git a/uptime-robot/README.md b/uptime-robot/README.md
--- a/uptime-robot/README.md
+++ b/uptime-robot/README.md
# @@ -40,3 +40,5 @@ Note: unless you've got an Uptime-Robot Pro account, there's no point in an inte
# ### Copyright
#
# Copyright (c) 2021 [Ben Tasker](https://www.bentasker.co.uk)
# +
# +Released under [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt)
#
diff --git a/uptime-robot/uptime-robot.py b/uptime-robot/uptime-robot.py
--- a/uptime-robot/uptime-robot.py
+++ b/uptime-robot/uptime-robot.py
# @@ -4,6 +4,8 @@
# # Hit the Uptime Robot API to fetch response times and status
# #
# # Copyright (c) 2021 B Tasker
# +# Released under GNU GPL v3 - https://www.gnu.org/licenses/gpl-3.0.txt
# +#
# #
# import requests
#
#