ARRIS Enterprises, Inc. Confidential Information

Transmitting HTTPS log

The HTTPS log transmission is enabled by the IIP kreatv-option-log-http and configured by using the following configuration objects:

Configuration Objects

Control the HTTPS logging behavior by using two configuration objects:

The STB sends the log to the receiving server address specified in CFG_LOG_UPLOAD_ADDRESS. The type of this parameter is string. It should be an available HTTPS address and port number. For example: https://www.example.com:3000 or https://10.202.6.188:3002

CFG_LOG_UPLOAD_ENDTIME sets the logging end time. The STB will continue sending its log until the end time. During the log sending period, a new value can be set for this object and the endtime will be updated to the new value. The logging will stop if an invalid time is set, the object is removed or when the end time has passed. The time format used should be UTC format like '2016-02-14T16:32:59Z'. The Time format is a subset of ISO 8601.

Here is an example to enable HTTPS logging. Supposing current time on STB is 2016-02-14T13:00:00Z, the logging end time must be greater than the current time.


var values = [];
values.push({toi.consts.ToiInformationService.CFG_LOG_UPLOAD_ADDRESS, "https://www.example.com:3000"});
values.push({toi.consts.ToiInformationService.CFG_LOG_UPLOAD_ENDTIME, "2016-02-14T20:20:20Z"});
toi.informationService.set(values, toi.consts.ToiInformationService.STORAGE_PERMANENT);

To disable HTTPS logging before endtime, any value that is smaller than the current time can be used. Suppose current time is 2016-02-14T18:00:00Z, here is an example to disable HTTPS logging.


toi.informationService.set({toi.consts.ToiInformationService.CFG_LOG_UPLOAD_ENDTIME, "2016-02-14T11:11:11Z"}, toi.consts.ToiInformationService.STORAGE_PERMANENT);

VAR_LOG_UPLOAD_STATUS is a readonly parameter, which indicates the log upload status. There are four status:

Enabled: the log is sending to remote HTTPS server
Disabled: the log sending is stopped
CertificateError: HTTPS certificate verification failed when connects with HTTPS server.
ConnectionError: can't connect with HTTPS server.

The example for getting the status.


var info = toi.informationService.get(toi.consts.ToiInformationService.VAR_LOG_UPLOAD_STATUS);
var status = info[0].objectItem.value;

See the page on Receiving HTTPS log for information on how to receive the log on your HTTPS server.