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 



4460
4461
4462
 
# File 'lib/kaltura_client.rb', line 4460

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



4487
4488
4489
4490
4491
4492
4493
4494
4495
 
# File 'lib/kaltura_client.rb', line 4487

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



4500
4501
4502
4503
4504
4505
4506
4507
4508
 
# File 'lib/kaltura_client.rb', line 4500

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.



4512
4513
4514
4515
4516
4517
4518
4519
4520
 
# File 'lib/kaltura_client.rb', line 4512

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.



4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
 
# File 'lib/kaltura_client.rb', line 4524

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 



4536
4537
4538
4539
4540
4541
4542
4543
4544
 
# File 'lib/kaltura_client.rb', line 4536

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