public_git
/
unpoller_unpoller
mirror of https://github.com/unpoller/unpoller.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

file formatting fixes

This commit is contained in:
Cody Lee 2022-11-23 22:08:48 -06:00
parent 0f0398d7a7
commit c811ebc1bb
No known key found for this signature in database
5 changed files with 58 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -81,6 +81,7 @@ documentation support. This project succeeds because of them. Thank you!
</p> </p>
## Copyright & License ## Copyright & License
<img style="float: right;" align="right" width="200px" src="https://unpoller.com/img/unpoller.png"> <img style="float: right;" align="right" width="200px" src="https://unpoller.com/img/unpoller.png">
- Copyright © 2018-2020 David Newhall II. - Copyright © 2018-2020 David Newhall II.

5
core/poller/README.md
View File

@ -6,8 +6,7 @@ This module ties the inputs together with the outputs.
Aggregates metrics on request. Provides CLI app and args parsing. Aggregates metrics on request. Provides CLI app and args parsing.
## Ideal
# Ideal
This library has no notion of "UniFi" or controllers, or Influx, or Prometheus. This library has no notion of "UniFi" or controllers, or Influx, or Prometheus.
This library simply provides an input interface and an output interface. This library simply provides an input interface and an output interface.
@ -17,7 +16,7 @@ Cisco gear, or any other network (or even non-network) data. The existing plugin
should provide ample example of how to use this library, but at some point the should provide ample example of how to use this library, but at some point the
godoc will improve. godoc will improve.
# Features ## Features
- Automatically unmarshal's plugin config structs from config file and/or env variables. - Automatically unmarshal's plugin config structs from config file and/or env variables.
- Initializes all "imported" plugins on startup. - Initializes all "imported" plugins on startup.

1
core/unifi/README.md
View File

@ -14,6 +14,7 @@ adding methods to update data, and I'm okay with that. I'll even help add them.
Pull requests, feature requests, code reviews and feedback are welcomed! Pull requests, feature requests, code reviews and feedback are welcomed!
Here's a working example: Here's a working example:
```golang ```golang
package main package main

4
integrations/mysqlunifi/README.md
View File

@ -13,7 +13,8 @@ notification if it changes. The possibilities are endless.
You must compile your plugin using the unifi-poller source for the version you're You must compile your plugin using the unifi-poller source for the version you're
using. In other words, to build a plugin for version 2.0.1, do this: using. In other words, to build a plugin for version 2.0.1, do this:
```
```bash
mkdir -p $GOPATH/src/github.com/unifi-poller mkdir -p $GOPATH/src/github.com/unifi-poller
cd $GOPATH/src/github.com/unifi-poller cd $GOPATH/src/github.com/unifi-poller
@ -25,4 +26,5 @@ git checkout v2.0.1
cp -r <your plugin> plugins/ cp -r <your plugin> plugins/
GOOS=linux make plugins GOOS=linux make plugins
``` ```
The plugin you copy in *must* have a `main.go` file for `make plugins` to build it. The plugin you copy in *must* have a `main.go` file for `make plugins` to build it.