Class: Kaltura::KalturaStatsService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

Stats Service

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaStatsService

Returns a new instance of KalturaStatsService.



4234
4235
4236
# File 'lib/kaltura_client.rb', line 4234

def initialize(client)
	super(client)
end

Instance Method Details

#collect(event) ⇒ Object

Will write to the event log a single line representing the event client version - will help interprete the line structure. different client versions might have slightly different data/data formats in the line event_id - number is the row number in yuval’s excel datetime - same format as MySql’s datetime - can change and should reflect the time zone session id - can be some big random number or guid partner id entry id unique viewer widget id ui_conf id uid - the puser id as set by the ppartner current point - in milliseconds duration - milliseconds user ip process duration - in milliseconds control id seek new point referrer KalturaStatsEvent $event



4261
4262
4263
4264
4265
4266
4267
4268
4269
# File 'lib/kaltura_client.rb', line 4261

def collect(event)
	kparams = {}
	client.add_param(kparams, 'event', event)
	client.queue_service_action_call('stats', 'collect', 'bool', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#kmc_collect(kmc_event) ⇒ Object

Will collect the kmcEvent sent form the KMC client // this will actually be an empty function because all events will be sent using GET and will anyway be logged in the apache log



4274
4275
4276
4277
4278
4279
4280
4281
4282
# File 'lib/kaltura_client.rb', line 4274

def kmc_collect(kmc_event)
	kparams = {}
	client.add_param(kparams, 'kmcEvent', kmc_event)
	client.queue_service_action_call('stats', 'kmcCollect', '', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#report_error(error_code, error_message) ⇒ Object

Use this action to report errors to the kaltura server.



4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
# File 'lib/kaltura_client.rb', line 4296

def report_error(error_code, error_message)
	kparams = {}
	client.add_param(kparams, 'errorCode', error_code)
	client.add_param(kparams, 'errorMessage', error_message)
	client.queue_service_action_call('stats', 'reportError', '', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#report_kce_error(kaltura_ce_error) ⇒ Object



4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'lib/kaltura_client.rb', line 4284

def report_kce_error(kaltura_ce_error)
	kparams = {}
	client.add_param(kparams, 'kalturaCEError', kaltura_ce_error)
	client.queue_service_action_call('stats', 'reportKceError', 'KalturaCEError', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end