sbIMetrics Interface Reference

Metrics service interface This is an interface to the songbird metrics service, used to phone home and send metrics gathered since the last report was sent. More...

import"sbIMetrics.idl";

Inheritance diagram for sbIMetrics:

Collaboration diagram for sbIMetrics:

Public Member Functions
void	checkUploadMetrics ()
	Perform anonymous metrics upload if needed. This method checks how much time has elapsed since the last time metrics were uploaded. If enough time has elapsed, metrics data is extracted from the user's dataremote repository and sent to the metrics server. The metrics repository is then emptied and a new metrics gathering session begins. This function may return without performing any task if the user has disabled metrics gathering. More...
void	metricsInc (in AString aCategory, in AString aUniqueID, in AString aExtraString)
	Increments a metrics key. More...
void	metricsAdd (in AString aCategory, in AString aUniqueID, in AString aExtraString, in long long aIntValue)
	Adds to a metrics key. More...

Detailed Description

Metrics service interface This is an interface to the songbird metrics service, used to phone home and send metrics gathered since the last report was sent.

Definition at line 44 of file sbIMetrics.idl.

Member Function Documentation

void sbIMetrics::checkUploadMetrics

(

)

Perform anonymous metrics upload if needed. This method checks how much time has elapsed since the last time metrics were uploaded. If enough time has elapsed, metrics data is extracted from the user's dataremote repository and sent to the metrics server. The metrics repository is then emptied and a new metrics gathering session begins. This function may return without performing any task if the user has disabled metrics gathering.

void sbIMetrics::metricsAdd	(	in AString	aCategory,
		in AString	aUniqueID,
		in AString	aExtraString,
		in long long	aIntValue
	)

Adds to a metrics key.

The key for the metric to be incremented is:

aCategory + "." + aUniqueID + ( (aExtraString) ? "." + aExtraString : "" );

Parameters

aCategory	The category string
aUniqueID	The unique ID string
aExtraString	The (optional) extra string, usually null
aIntValue	The integer value to add

void sbIMetrics::metricsInc	(	in AString	aCategory,
		in AString	aUniqueID,
		in AString	aExtraString
	)

Increments a metrics key.

The key for the metric to be incremented is:

aCategory + "." + aUniqueID + ( (aExtraString) ? "." + aExtraString : "" );

Parameters

aCategory	The category string
aUniqueID	The unique ID string
aExtraString	The (optional) extra string, usually null

---

The documentation for this interface was generated from the following file:

• /home/martin/dev/nightingale-hacking/components/metrics/public/sbIMetrics.idl