Repository is archived
No commit activity in last 3 years
No release in over 3 years
Library to emit data to Loggregator
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0.8.14, ~> 0.8
>= 0
>= 2.14.1, ~> 2.14

Runtime

~> 1.0.0
 Project Readme

Loggregator Emitter

Build Status Coverage Status Gem Version

About

This gem provides an API to emit messages to the loggregator agent from Ruby applications.

Create an emitter object with the loggregator router host and port, an origin, and a source name of the emitter.

Call emit() or emit_error() on this emitter with the application GUID and the message string.

A valid source name is any 3 character string. Some common component sources are:
API (Cloud Controller)
RTR (Go Router)
UAA
DEA
APP (Warden container)
LGR (Loggregator)

Setup

Add the loggregator_emitter gem to your gemfile.

gem "loggregator_emitter"

Sample Workflow

require "loggregator_emitter"

emitter = LoggregatorEmitter::Emitter.new("10.10.10.16:38452", "origin", API")

app_guid = "a8977cb6-3365-4be1-907e-0c878b3a4c6b" # The GUID(UUID) for the user's application

emitter.emit(app_guid, message) # Emits messages with a message type of OUT

emitter.emit(app_guid, message, {"key" => "value"}) # Emits messages with tags

emitter.emit_error(app_guid, error_message) # Emits messages with a message type of ERR

Regenerating Protobuf library

BEEFCAKE_NAMESPACE=Sonde protoc --beefcake_out lib/sonde -I ~/workspace/cf-release/src/loggregator/src/github.com/cloudfoundry/sonde-go/definitions/events ~/workspace/cf-release/src/loggregator/src/github.com/cloudfoundry/sonde-go/definitions/events/envelope.proto

Versioning

This gem is versioned using semantic versioning.