Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 3.15 KB

README.md

File metadata and controls

79 lines (52 loc) · 3.15 KB
Raw

Instrumental PHP Agent

Instrumental is a application monitoring platform built for developers who want a better understanding of their production software. Powerful tools, like the Instrumental Query Language, combined with an exploration-focused interface allow you to get real answers to complex questions, in real-time.

This agent supports custom metric monitoring for PHP applications. It provides high-data reliability at high scale.

Composer Installation

composer require instrumental/instrumental_agent

Visit instrumentalapp.com and create an account, then initialize the agent with your API key, found in the Docs section.

Usage

$I = new \Instrumental\Agent();
$I->setApiKey("PROJECT_API_TOKEN");
$I->setEnabled($isProduction); // only send metrics in production

You'll probably want something like the above, using your project API token, only enabling the agent in production mode so you don't have development and production data writing to the same value. Or you can setup two projects, so that you can verify stats in one, and release them to production in another.

Now you can begin to use Instrumental to track your application.

$I->gauge('load', 1.23);                                # value at a point in time

$I->increment('signups');                               # increasing value, think "events"

$post = $I->time('query_time', function(){              # time a block of code
  return Post->find(1);
});
$post = $I->time_ms('query_time_in_ms', function(){     # prefer milliseconds?
  return Post->find(1);
});

Note: If it is unable to connect to the service, it will discard data after reaching a low memory threshold.

Want to track an event (like an application deploy, or downtime)? You can capture events that are instantaneous, or events that happen over a period of time.

$I->notice('Jeffy deployed rev ef3d6a'); # instantaneous event
$I->notice('Testing socket buffer increase', time() - (3*24*60*60), 20*60); # an event (three days ago) with a duration (20 minutes)

Agent Control

Need to quickly disable the agent? Use $I->setEnabled(FALSE); on initialization and you don't need to change any application code.

Symfony

For usage with Symfony applications, we recommend registering the agent as a Symfony service.

Troubleshooting & Help

We are here to help. Email us at [email protected].

Release Process

  1. Pull latest master
  2. Merge feature branch(es) into master
  3. script/test
  4. Increment version in code
  • lib/Agent.php
  1. Update CHANGELOG.md
  2. Commit "Release version vX.Y.Z"
  3. Push to GitHub
  4. Tag version: git tag 'vX.Y.Z' && git push --tags (GitHub webhook will tell packagist and release a new version)
  5. Verify update on https://packagist.org/packages/instrumental/instrumental_agent
  6. Refresh documentation on instrumentalapp.com

Version Policy

This library follows Semantic Versioning 2.0.0.