sfxapi

sfxapi.js

The JavaScript client for the Signalfx API.

In the browser

To use, include one of these files in your application:

• sfxapi.js
• sfxapi.js.min, a minified version (source map)

You may also bower install sfxapi to install using bower. Once you've included the script, you can use the global sfxapi object to issue requests:

sfxapi.token(API_TOKEN);
sfxapi.job.getInstance('BuVusGuAYAA')
  .then(function(job){
    // do something with the job object
  }).catch(function(response){
    // this is called when an error occurs
    // response.error includes the error object
    // response.data is the response body
    // response.code is the HTTP code of the response
  });

In Node.js

Install the package by executing npm install --save sfxapi. After it has been installed you can add var sfxapi = require('sfxapi'); to your application and use it in the same way you would use the browser version of the client.

As a CLI

To interact with the Signalfx API from your client, install Node.js and run npm install -g sfxapi in your terminal.

# install signalfx api cli 
$ npm install -g sfxapi
 
# list resources 
$ sfxapi
 
# list operations on a resource 
$ sfxapi <resource>
 
# perform an operation 
$ sfxapi <resource> <operation> --<param-name> <param-value>
 
# For operations with a single parameter or a single required parameter 
# you may omit the dashdash. 
$ sfxapi metric search sf_metric:*mysql*

Authorization

You may pass your api key via the --auth <token> parameter for each call, or create a SFXAPI_AUTH environment variable for the token, or create a yaml/json file called .sfxapi with a auth key in the user home directory (e.g., ~/.sfxapi).

Example