#Dashing-SnmpGraph

This aims to be a Dashing widget, with a job and sample dashboard for visualizing SNMP data from your devices

##Installation

• Clone the repository
• Run the scripts/deploy.sh shell script, which will perform the needed actions to install this widget.
• ./scripts/deploy.sh /home/pi/dashing-plugins/dashing-snmpgraph parent_dir_of_install dashboard_install_dir
• Create snmpgraph_whatever.yaml file(s) in the conf.d directory just outside your dashboard_install_dir. It is recommended to create one file per device, but that's only to ease management.
  • model this file from the example_snmpgraph_interfaces.yaml file in the conf.d. It will not be symlinked into your dashboard's conf.d directory, and is intended to provide an example of how to use this plugin.
• Restart Dashing to pick up the new changes.
• Navigate to the newly installed snmpgraph dashboard in your browser, and revel in the dashboardy goodness.

###Required Widgets

The graphs depend on Jason Walton's Rickshawgraph plugin.

It is important to note that as of 5/11/2015 the bgcolor support is only hacked in via my fork of this plugin Hopefully this (or something like it) will get merged in.

The process for installation is pretty straightforward. You should review the installation instructions contained within the repo, as they may supersede these; but this should get you going. There are two ways to do it.

• Manual Installation of the Rickshawgraph plugin

  • Create a rickshawgraph directory in the widgets directory of your dashboard installation.
  • Place the rickshawgraph.coffee, rickshawgraph.html, and rickshawgraph.scss file, the Inside the newly created widgets\rickshawgraph directory
  • Restart Dashing.

• Automatic Installation of the Rickshawgraph plugin

  • from within your dashboard directory; install the gist with the dashing install command:
    • dashing install 6614023
  • Restart Dashing.

---

##Configuration

We recommend using the SafeYAML gem versus the builtin

The snmpgraph-defaults.yaml file tunes the behavior of the job. it is meant to provide you an example configuration of the configurable parameters. You are meant to create an snmpgraph-overrides.yaml file in the conf.d directory with your overrides to these settings. This permits you to update the default configuration file automatically, while simultaneously maintaining a custom local configuration. You are additionally meant to create as many snmpgraph_device_you_are_polling.yaml files as you wish. The job will inspect these files when Dashing starts, and schedule polling jobs for them.

It is important to note that the job will read any file matching conf.d/snmpgraph_.*.yaml and turn that into graph elements. It will only evaluate these files when Dashing starts.

###Configuration Parameters

The value of the first element in your yamlfile(s) should be the nice name for dashboard set. It is recommended to have one yaml file per dashboard, unless you are displaying the data element on multiple dashboards.

The sub attributes of your graph are as follows:

• name - The name of this data source. This corresponds to the data-id attribute in your dashboard template.
• address - The IP address, or fqdn of the host being polled.
• community - The SNMP community to use when polling.
• connection - What version of the SNMP protocol to use. v2c is recommended.
• depth - The number of elements to cap the timeseries array at. There seems to be a limit of 99. I am uncertain of why this is at this time.
• display_value_in_legend - Whether or not to display the last value as well as the name in the legend. This may be enabled at a graph level, or an element level.
• legend_value_format - How to display the value in the legend.
  • Supported options:
    • default - Will display the same value that is being graphed. Datasources which are being represented inverted visually will not be negative numbers.
    • total - Will display the last collected value, even if the visualization of the data is in things per second. Useful for interface errors, or other datasources where you'd like to visualize things per second, but be able to see the total.
• bgcolor - experimental This is only functional with my fork of jwalton's module. I am not certain that it should remain in it's current implementation, and may be removed.
• entities - A Hash of oids you're going to poll: The first element will be the nice name of the thing you are graphing. This will be displayed in the graph legend (if it is enabled) There should be at least one sub element. the oid key. You must specify an OID to poll in order to actually get something from snmp. :)

Additional supported entity options are: - color: The color to use for this graph. Note that you must specify all graph elements colors for this to be respected. - invert: Whether or not this element should be represented inverted. - mode: What transformation, if any, needs happen to the datasource before visualization.

  Supported modes:
  - `bits_per_second`
  - `bytes_per_second`
  - `bytes_to_MB`
  - `bytes_to_kB`
  - `bytes_to_kilobytes`
  - `bytes_to_megabytes`
  - `default`
  - `octets_to_Kbps`
  - `octets_to_Mbps`
  - `octets_to_bps`
  - `ticks_per_second`

Here's an example minimal system yaml file.

## conf.d/snmpgraph_firewall.yaml
myfw:
    - name: 'myfw_int1'
      address: '10.1.8.1'
      community: 'example'
      connection: 'v2c'
      depth: 99
      bgcolor: '#9ad99b'
      entities:
        Err_In: #visualize this interface's errors per second, but show total in legend
          oid: '1.3.6.1.2.1.2.2.1.14.5'
          invert: false
          legend_value_format: 'total'
          mode: 'ticks_per_second'
        Err_Out: #visualize this interface's errors per second, but show total in legend
          oid: '1.3.6.1.2.1.2.2.1.20.5'
          invert: true
          legend_value_format: 'total'
          mode: 'ticks_per_second'
        Kbps_Down:
          oid: '1.3.6.1.2.1.2.2.1.10.2'
          color: '#2DA62F'
          invert: true
          mode: 'octets_to_Kbps'
        kBps_Up:
          oid: '1.3.6.1.2.1.2.2.1.16.2'
          color: '#59CA5B'
          invert: false
          mode: 'octets_to_Kbps'
    - name: 'myfw_int1_fw'
      address: '10.1.8.1'
      community: 'example'
      connection: 'v2c'
      depth: 99
      bgcolor: '#9ad99b'
      entities:
        Out_Block:
          oid: '1.3.6.1.4.1.12325.1.200.1.8.2.1.14.5'
          color: '#cccc00'
          invert: true
          mode: 'ticks_per_second'
        Out_Pass:
          oid: '1.3.6.1.4.1.12325.1.200.1.8.2.1.13.5'
          color: '#66cc00'
          invert: true
          mode: 'ticks_per_second'
        In_Pass:
          oid: '1.3.6.1.4.1.12325.1.200.1.8.2.1.11.5'
          color: '#0000cc'
          mode: 'ticks_per_second'
        In_Block:
          oid: '1.3.6.1.4.1.12325.1.200.1.8.2.1.12.5'
          color: '#9933ff'
          mode: 'ticks_per_second'
    - name: 'myfw_int2'
      address: '10.1.8.1'
      community: 'example'
      connection: 'v2c'
      depth: 99
      bgcolor: '#66b2ff'
      entities:
        Err_In:
          oid: '1.3.6.1.2.1.2.2.1.14.3'
          invert: false
        Err_Out:
          oid: '1.3.6.1.2.1.2.2.1.20.3'
          invert: true
          mode: 'default'
        Kbps_In:
          oid: '1.3.6.1.2.1.2.2.1.10.3'
          invert: false
          mode: 'octets_to_Kbps'
        Kbps_Out:
          oid: '1.3.6.1.2.1.2.2.1.16.3'
          invert: true
          mode: 'octets_to_Kbps'
    - name: 'myfw_CPU'
      address: '10.1.8.1'
      community: 'example'
      connection: 'v2c'
      depth: 99
      bgcolor: '#4a4a4a'
      entities:
        Usr:
          oid: '1.3.6.1.4.1.2021.11.50.0'
          mode: 'ticks_per_second'
          color: '#000099'
        Nce:
          oid: '1.3.6.1.4.1.2021.11.51.0'
          mode: 'ticks_per_second'
          color: '#99ff99'
        Sys:
          oid: '1.3.6.1.4.1.2021.11.52.0'
          mode: 'ticks_per_second'
          color: '#ff0000'
        Idl:
          oid: '1.3.6.1.4.1.2021.11.53.0'
          mode: 'ticks_per_second'
          color: '#009999'
        W8:
          oid: '1.3.6.1.4.1.2021.11.54.0'
          mode: 'ticks_per_second'
          color: '#33ffff'
        Krn:
          oid: '1.3.6.1.4.1.2021.11.54.0'
          mode: 'ticks_per_second'
          color: '#ff8000'
        Int:
          oid: '1.3.6.1.4.1.2021.11.55.0'
          mode: 'ticks_per_second'
          color: '#660000'
        IRQ:
          oid: '1.3.6.1.4.1.2021.11.56.0'
          mode: 'ticks_per_second'
          color: '#ff3333'
    - name: 'myfw_Memory'
      address: '10.1.8.1'
      community: 'example'
      connection: 'v2c'
      depth: 99
      bgcolor: '#99f'
      entities:
        Shared:
          oid: '1.3.6.1.4.1.2021.4.13.0'
          mode: 'bytes_to_kB'
        Buffer:
          oid: '1.3.6.1.4.1.2021.4.14.0'
          mode: 'bytes_to_kB'
        Cached:
          oid: '1.3.6.1.4.1.2021.4.15.0'
          mode: 'bytes_to_kB'
        Free:
          oid: '1.3.6.1.4.1.2021.4.11.0'
          mode: 'bytes_to_kB'