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 



4501
4502
4503
 
# File 'lib/kaltura_client.rb', line 4501

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 interpret 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



4528
4529
4530
4531
4532
4533
4534
4535
4536
 
# File 'lib/kaltura_client.rb', line 4528

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



4541
4542
4543
4544
4545
4546
4547
4548
4549
 
# File 'lib/kaltura_client.rb', line 4541

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.



4553
4554
4555
4556
4557
4558
4559
4560
4561
 
# File 'lib/kaltura_client.rb', line 4553

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.



4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
 
# File 'lib/kaltura_client.rb', line 4565

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 



4577
4578
4579
4580
4581
4582
4583
4584
4585
 
# File 'lib/kaltura_client.rb', line 4577

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