com.android.tools.analytics

Class JournalingUsageTracker

java.lang.Object

com.android.tools.analytics.UsageTracker

com.android.tools.analytics.JournalingUsageTracker

All Implemented Interfaces:

java.lang.AutoCloseable

public class JournalingUsageTracker
extends UsageTracker

a UsageTracker that uses a spool to journal the logs tracked. This tracker can be used in both long-running as well as short-lived command-line tooling to track usage analytics. All analytics get written out to a well-known spool location and will be processed by a separate service in Android Studio for publication. Normal usage calls UsageTracker.getInstance() to get access to the UsageTracker. This will automatically be set to the correct instance based on the user choosing to opt-in to reporting usage analytics to Google or not.

Spool files are binary files protobuf using delimited streams https://developers.google.com/protocol-buffers/docs/techniques#streaming

For unittests please use TestUsageTracker. Only for integration tests that need .trk files to be generated, use the JournalingUsageTracker.

Field Summary

Fields inherited from class com.android.tools.analytics.UsageTracker

mStartTimeMs, sDateProvider

Constructor Summary

Constructors

Constructor and Description
JournalingUsageTracker(com.android.tools.analytics.AnalyticsSettings analyticsSettings, java.util.concurrent.ScheduledExecutorService scheduler, java.nio.file.Path spoolLocation) Creates an instance of JournalingUsageTracker.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the UsageTracker (closes current tracker file, disables scheduling of timeout & disables new logs from being posted).
void	logDetails(com.google.wireless.android.play.playlog.proto.ClientAnalytics.LogEvent.Builder logEvent) Logs usage data provided in the @{link ClientAnalytics.LogEvent}.
void	setMaxJournalTime(long duration, java.util.concurrent.TimeUnit unit) Sets a timeout at which point logs need to be flushed.

Methods inherited from class com.android.tools.analytics.UsageTracker

cleanAfterTesting, getAnalyticsSettings, getInstance, getMaxJournalSize, getMaxJournalTime, getScheduler, getVersion, initialize, log, setInstanceForTest, setMaxJournalSize, setVersion, updateSettingsAndTracker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JournalingUsageTracker

public JournalingUsageTracker(com.android.tools.analytics.AnalyticsSettings analyticsSettings,
                              java.util.concurrent.ScheduledExecutorService scheduler,
                              java.nio.file.Path spoolLocation)

Creates an instance of JournalingUsageTracker. Ensures spool location is available and locks the first journaling file.

Parameters:

spoolLocation - location to use for spool files.

scheduler - used for scheduling writing logs and closing & starting new files on timeout/size limits.

Method Detail

logDetails

public void logDetails(@NonNull
                       com.google.wireless.android.play.playlog.proto.ClientAnalytics.LogEvent.Builder logEvent)

Description copied from class: UsageTracker

Logs usage data provided in the @{link ClientAnalytics.LogEvent}. Normally using {#log} is preferred please talk to this code's author if you need UsageTracker.logDetails(com.google.wireless.android.play.playlog.proto.ClientAnalytics.LogEvent.Builder) instead.

Specified by:

logDetails in class UsageTracker

close

public void close()
           throws java.lang.Exception

Closes the UsageTracker (closes current tracker file, disables scheduling of timeout & disables new logs from being posted).

Throws:

java.lang.Exception

setMaxJournalTime

public void setMaxJournalTime(long duration,
                              java.util.concurrent.TimeUnit unit)

Description copied from class: UsageTracker

Sets a timeout at which point logs need to be flushed. Zero or less indicates no timeout should be used.

Overrides:

setMaxJournalTime in class UsageTracker