Greenfinch Ruby Library

한국신용데이터 data lake로 서비스 내 각종 event를 전송하는 ruby library 입니다.

설치하기

gem install greenfinch-ruby

라이브러리 설치 후 발급받은 토큰와 서비스명으로 tracker 생성 후 track 호출로 이벤트 전송

tracker = Greenfinch::Tracker.new('<YOUR TOKEN>', '<YOUR SERVICE>', true)
tracker.track('<USER ID>', '<EVENT NAME>')

사용하기

Greenfinch::Tracker.new

greenfinch tracker를 초기화 하는 함수입니다. 아래와 같이 초기화 후 사용하시기 바랍니다.

tracker = Greenfinch::Tracker.new('<YOUR TOKEN>', '<YOUR SERVICE>', true, use_internal_domain: true)

Argument	Type	Description
token	String, required	부여받은 token
service_name	String, required	부여받은 service name
debug	Boolean, required	true: staging, false: production
error_handler	Greenfinch::ErrorHandler, optional	error handler
use_internal_domain	Boolean, optional	true: internal (private) domain, false: public domain

Greenfinch::Tracker.track

custom한 event를 전송하는 함수입니다.

tracker.track('123456', 'Registered', {Gender: 'Male', Age: 21});

Argument	Type	Description
user_id	String, required	user_id
event_name	String, required	이벤트 이름
properties	Object, optional	추가적으로 전송할 properties

Greenfinch::ErrorHandler

Greenfinch 사용 중 발생하는 에러를 처리합니다. Tracker.new 호출 시 인자로 넘겨 사용하시면 됩니다.

require 'logger'

class MyErrorHandler < Greenfinch::ErrorHandler

  def initialize
    @logger = Logger.new('mylogfile.log')
    @logger.level = Logger::ERROR
  end

  def handle(error)
    logger.error "#{error.inspect}\n Backtrace: #{error.backtrace}"
  end

end

my_error_handler = MyErrorHandler.new
tracker = Greenfinch::Tracker.new('<YOUR TOKEN>', '<YOUR SERVICE>', true, my_error_handler)