/meter-plugin-udp

Example meter plugin in programming language that extracts data from a UDP data server.

Primary LanguageCApache License 2.0Apache-2.0

TrueSight Pulse UDP Metric Plugin

Example plugin written using the meter plugin SDK for C.

Collects meterics from example application that presents metrics via a UDP interface called metric-daemon

Prerequisites

OS Linux Windows SmartOS OS X
Supported v v v v

Plugin Setup

Metric Daemon

Install the Metric Daemon according to the instructions here.

Meter Plugin SDK

For this plugin to run the TrueSight Pulse Meter Plugin SDK for C must be installed on the same host where the plugin is running.

Plugin Installation

  1. Download plugin distribution to the target platform:

    $ wget https://github.com/boundary/meter-plugin-udp/releases/download/v1.0.0/meter-plugin-udp-1.0.0.tar.gz
  2. Extract distribution:

    $ tar xvf meter-plugin-udp-1.0.0.tar.gz
  3. Change directory to extracted plugin distribution:

    $ cd meter-plugin-udp-1.0.0
  4. Configure plugin for compilation:

    $ ./configure
  5. Compile meter plugin executable:

    $ make
  6. Install meter plugin executable:

    $ sudo make install

Plugin Configuration Fields

Field Name Description
Host Host running the metric daemon
Port Listening port of the metric daemon
Source Label to display in the legend for the measurement.
Interval How often should the plugin poll for metrics.

Metrics Collected

Metric Name Description
EXAMPLE_BYTECOUNT A metric to track counts of bytes.
EXAMPLE_DURATION A metric to track a duration of time
EXAMPLE_NUMBER A metric to track a number value
EXAMPLE_PERCENT A metric to track a percentage value

Dashboards

  • Example Count