rcrowe/librato-annotation

Send a deployment annotation to Librato

Librato Annotations

This class allows you to send annotations to Librato from Phing, _(*1)

I use this to mark deployments when I put my code onto production servers. I can easily see from my dashboard / graphs if the last deployment has affected performance., _(*2)

Installation

I have only tested this with installation through Composer, so know guarantees whether this will work not installed through Composer., _(*3)

{
    "require": {
        "rcrowe/librato-annotation": "0.1.2",
        "phing/phing": "2.4.14"
    },
    "minimum-stability": "dev"
}

Define the the Librato task in your buildfile:, _(*4)

<taskdef name="librato" classname="rcrowe\Librato\AnnotationTask" />

Usage

To send an annotation to Librato you need to define your username and your API key. Your API key can be found on your Librato account page., _(*5)

Setting your detatils globally:, _(*6)

<property name="librato.username" value="hello@vivalacrowe.com" />
<property name="librato.password" value="12345abcdef" />

Doing it this way means you only have to do it once, and can then call Librarto multiple times. However, you can do this inline as well:, _(*7)

<librato username="hello@vivalacrowe.com" password="12345abcdef" .... />

Example

<librato name="deployment" title="Deployment" desc="Deployed to live" />

If there is an error trying to send the annotation to Librarto the default is to carry on processing the Phing buildfile. You can change this behaviour with haltonerror:, _(*8)

<librato name="deployment" title="Deployment" desc="Deployed to live" haltonerror="true" />