DOCUMENTATION

Collector Protocol

All metrics are submitted to the Instrumental collector, which resides at collector.instrumentalapp.com, port 8000. A valid agent may connect to the collector using a TCP connection and submit metrics for a specific project. The collector has a TCP connection timeout of 120 seconds.

Message Format

All messages mentioned in this document are terminated by newlines (\n).

Protocol Changes

The collector protocol is an unofficial API, and it may be changed without warning. Please contact support@instrumentalapp.com if you have any questions.

Connecting to the Collector

The connection process follows these steps:

  1. Notify the collector of the version of your agent
  2. Authenticate your agent
  3. Submit metrics or notices to the collector