Collect nginx metrics from the status endpoint
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Build system update + bugfixing (#3) Jan 4, 2017

Snap Collector plugin - NginxPlus

Collector get nginx metrics from the nginx-plus endpoint.

  1. Getting Started
  1. Community Support
  2. Contributing
  3. License

Getting Started

A working snap agent and a running instance of nginx application which expose a rest api in json format to get access to real time nignx metrics.

System Requirements

Operating Systems

  • Linux
  • Mac OS X


Fork Clone repo into $GOPATH/src/

$ git clone<yourGithubID>/snap-plugin-collector-nginx.git

Build the plugin by running make within the cloned repo:

$ make

This builds the plugin in /build/rootfs/


Make sure that your $SNAP_PATH is set, e.g.:

$ export SNAP_PATH=<snapDirectoryPath>/build/linux/x86_64

Run the snap agent with the config file:

$SNAP_PATH/snapteld --plugin-trust 0 --log-level 1 --config $GOPATH/src/

Load the collector plugin:

$SNAP_PATH/snaptel plugin load $GOPATH/src/


To Verify nginx mertics:

$SNAP_PATH/snaptel metric list

Configuration and Usage

  • Set up the Snap framework As part of snapteld global config
  • Load the plugin and create a task, you can find example config and task manifest files in "examples" directory

Community Support

This repository is one of many plugins in Snap, a powerful telemetry framework. The full project is at To reach out on other use cases, visit Slack.


We currently have no future plans for this plugin. If you have a feature request, please add it as an issue and/or submit a pull request


This plugin is Open Source software released under the Apache 2.0 License