redis-heartbeat v1.0.0

redis-heartbeat

Pulse a heartbeat to redis. This can be used to detach or attach servers to nginx or similar problems.

Breaking changes

Version 1.0.0

• Since this version the metrics are removed, to be able to install it for node 10.
• Because of the use of coffee-script 2, also dropped support for node version < 6

Install

  npm install redis-heartbeat

Initialize

	var Heartbeat = require( "redis-heartbeat" );
	var HBInst = new Heartbeat( { name: "FOO", identifier: "http://www.bar.biz:4223" } );
	HBInst.on( "error", function( err ){
		// Init errors 
	} )

Options

• name : ( String required ) The name of this current service group. E.g. "restservice"
• identifier : ( String|Function required ) The identifier of the current server. E.g. "http://api.myresthost.com:8080". If also possible to pass in a function that returnes the identifier.
• intervalHeartbeat : ( Number optional: default = 5 ) Min. interval time ( in seconds ) to send the heartbeat. If set <= 0 the heartbeat will be deactivated.
• heartbeatKey : ( String optional: default = HB ) Redis key to write the heartbeat. This could be prefixed by redisprefix.
• heartbeatExpire : ( Number optional: default = 172800 2 days ) Time in seconds until unused heartbeat will automatically removed. If set to 0 the key will never be removed
• useRedisTime : ( Boolean optional: default = true ) Use redis server time or us the own machine time
• autostart : ( Boolean optional: default = true ) Start the heartbeat on int. Otherwise you have to call the method .start() of your instance.
• localtime : ( Boolean optional: default = false ) Force the module to use the local time instead of a server independent local machine time
• host : ( String optional: default = localhost ) Redis host name
• port : ( Number optional: default = 6379 ) Redis port
• options : ( Object optional: default = {} ) Redis options
• client : ( RedicClient optional: default = null ) It also possible to pass in a already existing redis client instance. In this case the options host, port and options ar ignored.
• redisprefix : ( String optional: default = {} ) A general redis key prefix
• diskCheckPath : ( String optional: default = / or c: for win32 ) The disk path to ckeck for free space. If null or empty this check will be skipped. More details see module diskusage

Methods

.start()

Start the heartbeat.

Return

( Booelan ): If it has been started. Could be false if the heartbeat has been already active

.stop()

Stop the heartbeat.

.isActive()

Ask if the heartbeat is currently active.

Return

( Booelan ): Haertbeat is active

.quit()

Stop the heartbeat anc close the internal connection to redis.
After this this instance cannot be reused.

Events

started

Emitted on start of the intervals

beforeHeartbeat

Emitted before heartbeat write. With this event it's possible to change the heartbeat content in operation

Arguments

• identifier : ( String ) The current identifier

connected

Emitted on connection to redis

disconnect

Emitted on a disconnect of redis

error

An internal error occoured.

redis:error

Emitted on general redis error

Arguments

• err : ( Error|String ) The error details

TODO

• add content tests

Release History

Other projects

The MIT License (MIT)

Copyright © 2013 Mathias Peter, http://www.tcs.de

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.