Skip to content

Introduce setDebugLoggingEnabled API #549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zugaldia merged 3 commits into from
Aug 29, 2017
Merged

Introduce setDebugLoggingEnabled API #549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4842cb
include isDebugLoggingEnabled api to manually control the verbosity o…
zugaldia Aug 29, 2017
2bbc896
preserve previous behavior
zugaldia Aug 29, 2017
4c97a24
update note on logging
zugaldia Aug 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions ...ndroid-telemetry/src/main/java/com/mapbox/services/android/telemetry/MapboxTelemetry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ public class MapboxTelemetry implements Callback, LocationEngineListener {
protected CopyOnWriteArrayList<TelemetryListener> telemetryListeners;
private Hashtable<String, Object> customTurnstileEvent = null;
private int sessionIdRotationTime = TelemetryConstants.DEFAULT_SESSION_ID_ROTATION_HOURS;
private boolean debugLoggingEnabled = false;

/**
* Private constructor for configuring the single instance per app.
Expand Down Expand Up @@ -167,6 +168,25 @@ public void setSessionIdRotationTime(@IntRange(from = 1, to = 24) int sessionIdR
this.sessionIdRotationTime = sessionIdRotationTime; // in hours
}

// For internal use only
// This is an experimental API. Experimental APIs are quickly evolving and
// might change or be removed in minor versions.
@Experimental
public boolean isDebugLoggingEnabled() {
return debugLoggingEnabled;
}

// For internal use only
// This is an experimental API. Experimental APIs are quickly evolving and
// might change or be removed in minor versions.
@Experimental
public void setDebugLoggingEnabled(boolean debugLoggingEnabled) {
this.debugLoggingEnabled = debugLoggingEnabled;
if (this.client != null) {
this.client.setDebugLoggingEnabled(debugLoggingEnabled);
}
}

/**
* Checks that TelemetryService has been configured by developer
*/
Expand Down
13 changes: 11 additions & 2 deletions ...d-telemetry/src/main/java/com/mapbox/services/android/telemetry/http/TelemetryClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ public class TelemetryClient {
private String eventsCnEndpoint = MapboxEvent.MAPBOX_EVENTS_CN_BASE_URL;
private boolean stagingEnvironment = false;
private boolean enableCnEndpoint = false;
private boolean debugLoggingEnabled = false;
private OkHttpClient client;

public TelemetryClient(String accessToken) {
Expand Down Expand Up @@ -88,6 +89,14 @@ public void setEnableCnEndpoint() {
this.enableCnEndpoint = true;
}

public boolean isDebugLoggingEnabled() {
return debugLoggingEnabled;
}

public void setDebugLoggingEnabled(boolean debugLoggingEnabled) {
this.debugLoggingEnabled = debugLoggingEnabled;
}

/**
* Based on http://square.github.io/okhttp/3.x/okhttp/okhttp3/CertificatePinner.html
*
Expand Down Expand Up @@ -218,8 +227,8 @@ private void sendEventsWrapped(Vector<Hashtable<String, Object>> events, Callbac
RequestBody body = RequestBody.create(JSON, payload);
String url = getEventsEndpoint() + "/events/v2?access_token=" + getAccessToken();

// Extra debug in staging mode
if (isStagingEnvironment()) {
// Extra debug if manually enabled or if in staging mode
if (isDebugLoggingEnabled() || isStagingEnvironment()) {
Log.d(LOG_TAG, String.format("Sending POST to %s with %d event(s) (user agent: %s) with payload: %s",
url, events.size(), getUserAgent(), payload));
}
Expand Down