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.



4380
4381
4382
 
# File 'lib/kaltura_client.rb', line 4380

def initialize(client)
  super(client)
end

Instance Method Details

#collect(event) ⇒ bool

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

Returns:

  • (bool) 


4407
4408
4409
4410
4411
4412
4413
4414
4415
 
# File 'lib/kaltura_client.rb', line 4407

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

Returns:



4420
4421
4422
4423
4424
4425
4426
4427
4428
 
# File 'lib/kaltura_client.rb', line 4420

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_device_capabilities(data) ⇒ Object

Use this action to report device capabilities to the kaltura server.

Returns:



4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'lib/kaltura_client.rb', line 4432

def report_device_capabilities(data)
  kparams = {}
  client.add_param(kparams, 'data', data)
  client.queue_service_action_call('stats', 'reportDeviceCapabilities', '', 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.

Returns:



4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
 
# File 'lib/kaltura_client.rb', line 4444

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) ⇒ KalturaCEError

Returns:



4456
4457
4458
4459
4460
4461
4462
4463
4464
 
# File 'lib/kaltura_client.rb', line 4456

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