Documentation

Write an external plugin

This page documents an earlier version of Telegraf. Telegraf v1.20 is the latest stable version. View this page in the v1.20 documentation.

Set up your plugin to use it with execd.

For listed external plugins, the author of the external plugin is also responsible for the maintenance and feature development of external plugins.

  1. Write your Telegraf plugin. Follow InfluxData’s best practices:
  2. If your plugin is written in Go, follow the steps for the Execd Go Shim.
  3. Add usage and development instructions in the homepage of your repository for running your plugin with its respective execd plugin. Refer to openvpn and awsalarms for examples. Include the following steps:
    • How to download the release package for your platform or how to clone the binary for your external plugin
    • Commands to build your binary
    • Location to edit your telegraf.conf
    • Configuration to run your external plugin with inputs.execd, processors.execd or outputs.execd
  4. Submit your plugin by opening a PR to add your external plugin to the /EXTERNAL_PLUGINS.md list. Include the plugin name, a link to the plugin repository and a short description of the plugin.

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.