Git Product home page Git Product logo

tunnelrelic's Introduction

tunnelRelic

tunnelRelic allows you to register/create/send custom events and custom attributes to New Relic Insights. Multiple tunnels (events) can be created to send events to different Insights events.

Requirements

You'll need: New Relic Account # Insights API key

Both pieces of information are found here -> https://insights.newrelic.com/accounts/YOUR_ACCOUNT_NUM/manage/api_keys

Setup/Usage

Usage flow is drop-dead simple. Create tunnel -> send events to a tunnel -> we'll send them along to New Relic

Create a tunnel

	gopherTunnel := tunnelRelic.NewTunnel(myAccount, myAPIKey, myTunnelName, flushInterval, bufferLimit)

Tunnel properties

flushInterval   int 		//How often should we send queued events?
bufferLimit     int 		//Ignore interval if we reach this many events in the queue
myAPIKey     	string 		//An insert key from the API keys tab of Insights
myAccount	 	string 		//Your numberical New Relic account
myTunnelName   	string 		//Name of the event you're registering

Create an event

Events can be resused/modified, and do not need to be allocated each time you want to register an event.

	anEvent := gopherTunnel.NewTransaction()
	anEvent["key"] = "value"
	anEvent["Dammit"] = "Yoyo"

Send an event

	gopherTunnel.RegisterEvent(anEvent)

Example

Events sent to Insights are fully queryable/pullable through the Insights product.

Queryable

Explorable

	package main

	import (
		"./src"
	)

	func main() {

		//create tunnelRelic
		myAccount := "123"
		myAPIKey := "456"
		myTunnelName := "Purchase"
		flushInterval := 60
		bufferLimit := 15
		tunnel := tunnelRelic.NewTunnel(myAccount, myAPIKey, myTunnelName, flushInterval, bufferLimit)

		//Create sample event (can be reused)
		anEvent := tunnelRelic.NewTransaction()
		anEvent["key"] = "value"
		anEvent["Dammit"] = "Yoyo"

		//send event
		tunnel.RegisterEvent(anEvent)
	}

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

TODO

Verbose logging on/off Multiple events in single post

tunnelrelic's People

Contributors

ericmannkochava avatar otternq avatar ericdmann avatar

Stargazers

 avatar Cem Ezberci avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.