stackdriver-event

0.0.1 • Public • Published

stackdriver-event

Submit annotation and deploy events to StackDriver.

This helps annotating graphs so you can corelate movements to events.

Example

var submit = require('stackdriver-event')(API_KEY);
 
// simple
 
submit.annotation('increase disk space', function(err){
  // ...
});
 
submit.deploy('3560d7a', function(err){
  // ...
});
 
// or detailed
 
submit.annotation({
  message: 'increase disk space',
  annotated_by: 'Julian',
  level: 'INFO',
  instance_id: 'id'
}, function(err){
  // ...  
});
 
submit.deploy({
  revision_id: '3560d7a',
  deployed_by: 'Julian',
  deployed_to: 'production',
  repository: 'Debugger'
}, function(err){
  // ...  
});

Installation

$ npm install stackdriver-event

API

Event(key)

Create an event submitter instance with your api key.

#annotation(data|message, fn)

Submit an annotation event with message or data with those keys:

  • message (required)
  • annotated_by
  • level
  • instance_id
  • event_epoch

For more information, see the StackDriver Docs.

#deploy(data|revision_id, fn)

Submit an deploy event with revision_id or data with those keys:

  • revision_id (required)
  • deployed_by
  • deployed_to
  • repository

For more information, see the StackDriver Docs.

License

MIT

Dependencies (1)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i stackdriver-event

    Weekly Downloads

    9

    Version

    0.0.1

    License

    MIT

    Last publish

    Collaborators

    • ssuneja
    • azhaotwilio
    • ldelossantos
    • cjo2
    • achandrashekaran
    • aparna.singhal
    • ynguyen
    • timmyzsearcy
    • igracheva-twilio
    • yashnit-segment
    • nanotimm
    • srivig21
    • chenchensegmentcom
    • sanket.mishra
    • lweimersegment
    • rcheedhalla
    • jxin_twilio
    • odoren_segment
    • aditi.raveesh
    • dltnbrks-segment
    • sai-patanjali
    • himanshuph
    • alecjacobs-segment
    • sshaikh_segment
    • john.lee1100
    • dazu70
    • brian.aguirre
    • pooja.patil
    • segment_fan
    • nlubchenco
    • jamezhutwilio
    • knksmith57-segment
    • jsh-wu
    • nithin-benny
    • poojasegment
    • ebru.odok
    • bannapple
    • rodhilton_twilio
    • guthriesegment
    • srishti-nema
    • cdelaomartinez
    • miguelpdiaz8
    • sundareswar.jayakumar
    • gbatra
    • spencerattick
    • akodankiry
    • nanette.ranes
    • gsolis_segment
    • nitinpm432
    • aadityabhatt10
    • amigandhi
    • segmentsean
    • hmohanram_seg
    • jrupasinghe
    • myrontin.segment
    • devthale
    • smccoy-twilio
    • seg-leonelsanches
    • jibrang
    • sethgrid_segment
    • light-bringer-blr
    • aubreysine
    • ed-twilion-npm
    • harsh-joshi99
    • irfan.ali.segment
    • kbhargavaram-sg
    • needcaffeine
    • nat-grid
    • wlumsegment
    • vivek-26
    • moyara2
    • bala.singareddy
    • gbbastos
    • akash.gautam07
    • preetyp
    • viveksainaneesegment
    • msaraf
    • kjoerres
    • rokatyal
    • ainatancinco
    • anton-vylushchak
    • sowjanyasegment
    • alayvora
    • msaunders-segment
    • tw-dgarcia
    • parag.panda
    • blangtwilio
    • ryanrouleau-segment
    • twjosiah
    • mcullenmeyer
    • david.anusontarangkul.segment
    • mckern_segment
    • segment-admin
    • nainy.agrawal
    • tdibacco
    • sudojatin
    • nageshgolem
    • brandonheyer-segment
    • alfrimpong
    • dobrin.ganev
    • ankit.gupta.unthinkable
    • marinhero
    • benattwilio
    • bharath.boregowda
    • conniechen
    • sungju.jin
    • pooyaj
    • yli119
    • ea_segment
    • emilyjia
    • kx-segment
    • xinghao.huang
    • harsh.vardhan
    • joe.ayoub.segment
    • gkochar123
    • rollcode
    • ariel.silvestri
    • cherylj-segment
    • immanoj
    • aaronklish
    • michelr
    • maneesh.dharma29
    • msolorzano-segment
    • brianhumphreystwilio
    • jfehrman.segment
    • joetessy
    • pmunin
    • jalexy12
    • jbandi-twilio
    • prayansh-twilio
    • dominicbarnes
    • brandon.scott-segment
    • bgillan
    • phillip.thomas
    • ricardo.rossi
    • forgetfulfellow
    • fauzy.yy
    • mayur-pitale
    • dbaik-twilio-segment
    • seg-rustybailey
    • tanya.gupta.segment
    • pmiller-twilio
    • nevermore2022
    • aishikawaki
    • csayuso
    • mcoulibali
    • shupadhyay
    • jahood-twilio
    • saisagarkappaganthula
    • rmukundan
    • arubiochavez
    • shuvrajit9904
    • s3gm3nt
    • ama0223
    • tbrennanj
    • dangmai-segment
    • shraddha-twilio
    • sa-jsooter
    • enyi.asonye
    • afsha-nazim-seg
    • mschaszberger
    • lnamba
    • varadarajan-tw
    • seanhan-segment
    • replatero
    • sayan-das-in
    • justeen
    • sausingh
    • jgabe13
    • meg1000
    • funlu
    • ashwitha.bg
    • whaider_twilio
    • tcgilbert
    • kevinburkesegment
    • felttrip
    • prabhnoor1997
    • akashyap91
    • clintz.seg
    • karimkeshwani
    • wally.tg
    • rhall-twilio
    • yash-twilio
    • brookstaylorjr
    • shayan-golafshani
    • lerahulram
    • mugelstad
    • hdamani
    • rrivera-segment
    • sethnutetwilio
    • manali-bhosale
    • chtoombs
    • sethsegment
    • eric-hyde
    • elmoselyee
    • michaelghseg
    • jayakrishnannair
    • lateefat
    • maryam.sharif
    • wdbetts
    • ryanligon
    • sindhusegment
    • lfdelossantos
    • aramakrishnan
    • segment-camden
    • vbatanov
    • lluque-twilio
    • jair.aviles
    • pmaid
    • song4you
    • peterdemartini
    • emmy.byrne
    • vincen7tran
    • dean-huynh
    • cdignam-segment
    • abhinavsureka
    • arunlalam-segment
    • cjradek
    • neeharikakondipati
    • simpixelated
    • chihchun-twilio
    • acharles14
    • jyim008
    • hema-segment
    • oscb
    • krousseau
    • sachinwathore
    • fhalim-segment
    • cfree
    • hjoonpm
    • celine-segment
    • pmcanseco-segment
    • masira
    • amillet89
    • cholt002
    • av-segment
    • aghotikar
    • vikrant-segment
    • larryatsegment
    • ariel_segment
    • scruwys1
    • kyliepedersen
    • jinapark
    • segmentio
    • rajulvadera
    • lpediredla
    • n2parko
    • tyson_segment
    • bgamwell
    • uditmehta
    • salolivares
    • erikdw
    • chenxiangzhang
    • mericsson
    • prayansh-segmentt
    • jeremylarkin
    • bsneed
    • danieljackins
    • segment-seth
    • james9446
    • priscilla.giatti
    • nlsun
    • drew-thompson
    • segment-jsingh
    • andrius-segment
    • valerieernst
    • kelcook
    • gilomer
    • marcelopv
    • eric.rogner
    • kdharaiya
    • jon.anderson-at-segment.com
    • stacy.song
    • rexatsegment
    • nickaguilar
    • bradenbecker
    • reneewang
    • dan.lasky
    • sam.tapia
    • vikramkumar19
    • mpriyad25
    • jeremy.parker
    • smidges