marcopaganini/smartcollector

SmartThings sensor data collector for prometheus

smartcollector

Smartcollector is a command line tool to export information about your SmartThings sensors into Prometheus. The tool uses the GoSmart library to talk to SmartThings and collect sensor data, and emits files ready to be imported by Prometheus' Node Exporter.

Installation

The installation instructions assume a properly installed and configured Go development environment. The very first step is to download and build smartcollector (this step will also download and compile the GoSmart library):

$ go get -u github.com/marcopaganini/smartcollector

GoSmart configuration

Before we can use smartcollector, we need to configure GoSmart. Follow the GoSmart installation instructions carefully, making sure all steps have been followed.

With GoSmart configured, Follow the instructions to run the simple example that comes with GoSmart. Make sure the example displays a list of your sensors on the screen.

Smartcollector configuration

We now need to authorize smartcollector to access your Smartthings app. Take note of the client_id and client_secret of your SmartThings app (used when running the simple example above). Run:

$ smartcollector --client <client_id> --secret <client_secret> --textfile-dir "/tmp"

Follow the instructions to authorize the app (just like in the simple example.)

Smartcollector will write a file with your credentials to the home directory of the user running it. After the first run, only the client_id is required to run smartcollector:

$ smartcollector --client <client_id> --textfile-dir "/tmp"

Please note the textfile-dir flag above. This instructs smartcollector to write the "textfile" output into your "/tmp" directory. This makes it easy to test smartcollector and perform the initial installation, but node-exporter (Prometheus) won't read and import these files from "/tmp". In a production environment, you'll want to:

1. Make sure the -collector.textfile.directory flag of your node_exporter agrees with the value set in --textfile-dir on the smartcollector. By default, smartcollector uses "/run/textfile_collector"

2. Make sure the system user you use to run smartcollector has permissions to write under "textfile-dir".

3. Add an entry to your cron job to fetch the values every 5 or 10 minutes.

4. When everything is running well, you should start seeing a timeseries called smartthings_sensors in your prometheus console (usually, at localhost:9090).

smartcollector's Issues

Add install instructions

The source mentions Check the README.md for installation instructions.

Exporter using prometheus Go client library

Was there a particular reason you implemented this as a textfile collector and not an exporter?

It doesn't seem like there would be much to add https://prometheus.io/docs/guides/go-application/