Skip to content

Commit

Permalink
Add third party server interfaces to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Elliot Blackburn committed Jul 23, 2019
1 parent 062fd4b commit 9c98519
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/server_interface.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Server Interface

Server modules are Node.js [modules][nodemods] that receive metrics for StatsD.
Server interfaces can be distributed and installed via systems such as NPM.

Each server module should export the following initialization function:

* `start(config, callback)`: This method is invoked from StatsD to initialize
Expand All @@ -15,3 +17,7 @@ Each server module should export the following initialization function:
The server module should return `true` from start() to indicate
success. A return of `false` indicates a failure to load the module
(missing configuration?) and will cause StatsD to exit.

# Available third-party interfaces

* [http-interface](https://github.com/msiebuhr/statsd-http-interface) Accepts data over HTTP.

0 comments on commit 9c98519

Please sign in to comment.