npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

opentsdb-url

v0.0.2

Published

OpenTSDB HTTP data request URL generator.

Downloads

110

Readme

URL

NPM version Build Status Coverage Status Dependencies

URL generator for OpenTSDB HTTP data requests.

Install

For use in Node.js,

$ npm install opentsdb-url

For use in the browser, use browserify.

Usage

To use the module,

var createFactory = require( 'opentsdb-url' );

A URL generator must be bound to a particular OpenTSDB client instance.

var createClient = require( 'opentsdb-client' );

// Create a new client:
var client = createClient();

// Bind the generator to the client:
var url = createFactory( client );

The instance has the following methods...

url.template()

Creates a URL template based on the OpenTSDB client configuration. The template contains two parameters: start and end.

url.template();

Note: this method does not provide public access to the URL template. Instead, the method returns the current URL generator instance.

url.create()

Inserts start and end times into a template OpenTSDB query string. The start and end times are obtained from the bound client instance.

url.create();
// returns '...'

Note: Ensure that you have first generated a template before trying to create a URL.

The motivation for the template/create separation is the recognition that start and end times are more likely to change than other client parameters, particularly when periodically polling OpenTSDB for data belonging to the same metric.

Examples

var createClient = require( 'opentsdb-client' ),
	mQuery = require( 'opentsdb-mquery' ),
	createFactory = require( 'opentsdb-url' ),
	end = Date.now(),
	start = end - 1000,
	client,
	query,
	url;

// Create a new metric query and configure:
query = mQuery();

query.metric( 'cpu.utilization' )
	.tags( 'beep', 'boop' );

// Create a new client and configure:
client = createClient();

client.queries( query );

// Bind the client to a URL generator:
url = createFactory( client );

// Create the url template:
url.template();

// Periodically create new URLs...
for ( var i = 0; i < 10; i++ ) {
	setTimeout( createURL( i*1000 ), i*1000 );
}

function createURL( offset ) {
	var begin = start + offset,
		stop = end + offset;
	return function onTimeout() {
		client.start( begin )
			.end( stop );

		console.log( url.create() );
	};
}

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.


Copyright

Copyright © 2014. Athan Reines.