Skip to content

README.md

Latest commit

 

History

History
47 lines (39 loc) · 2.61 KB

README.md

File metadata and controls

47 lines (39 loc) · 2.61 KB

IOT JSON Munin Plugin

Parse JSON information fron popular ESP8266 IT firmware like ESPeasy or Espurna

This is a Virtual Node plugin. This mean that it can run on any regular node (or on the Munin master), and each instance (symlink) can point to an external devices. Here is a usefull link that explains how to setup a virtual node.

Installation

  • Copy iot-json_ to the main Munin plugin directory, ie :/usr/share/munin/plugins/
  • Then symlink it from the /etc/munin/plugins/ folder, carefully naming it as described below
  • Update the /etc/munin/munin.conf adding your node hostname or IP between brackets, and set the address parameter to the IP of the node where iot-json_ is installed. Example, if the node is on the same host as the server :
# address or name of the ESP device (must be the same as the HOSTNAME defined in the symlink name)
[192.168.0.1]
      address 127.0.0.1
      # this the address of the NODE containing the symlink to iot-json_

Wilcard Naming

Link to this file with a symlink named as : iot-json_HOSTNAME_FIRMWARE_TYPE Where

  • HOSTNAME is the Host Name or IP address.

  • FIRMWARE is either espeasy or espurna

  • TYPE is one of the supported TYPES:

    • free : Free RAM
    • load : CPU Load
    • rssi : Wifi strength
    • uptime : Uptime in minutes

    either a custom TYPE, that will be the name of the JSON key to extract. ie if you want to extract a JSON field named "Temp", use "Temp" as TYPE, and optionally change the following env.xxx to better describe/draw it

example: iot-json_192.168.0.1_espeasy_uptime

ENV Settings

You can add the following "env.xx" inside the [iot-json_HOSTNAME_FIRMWARE_TYPE] definitions in /etc/munin/plugin-conf.d/

  • env.url : use another API url (ie for Espurna , be sure to end it with ?apikey=)
  • env.api_key : (espurna only) API Key
  • env.json_key : use a JSON key different than the custom TYPE set in the name (ie useful if there is a space in the key)
  • env.graph_title : munin graph_title
  • env.graph_vlabel : munin graph_vlabel
  • env.graph_category: munin graph_category
  • env.graph_scale : munin graph_scale
  • env.graph_args : munin graph_args
  • env.graph_info : munin graph_info
  • env.TYPE.label : munin line label (where TYPE is the TYPE used in the plugin name)
  • env.TYPE.info : munin line info (where TYPE is the TYPE used in the plugin name)