com.percolate.foam

Class UDPLoggingService

java.lang.Object

com.percolate.foam.ServiceImpl

com.percolate.foam.UDPLoggingService

All Implemented Interfaces:

CrashReportingService, LoggingService, Service

Direct Known Subclasses:

LogEntries, PaperTrail

abstract class UDPLoggingService
extends ServiceImpl
implements CrashReportingService, LoggingService

Remote syslog style logging service. Data is sent over UDP to an endpoint that is expecting logs in syslog format: "<priority>timestamp orange_link blue_link: message" Details: http://en.wikipedia.org/wiki/Syslog#Priority Service Object. Represents a service to which we will send data.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	host Host portion of url
private int	port Port portion of url
private java.lang.String	url UDP logging URL (eg: logs.myserver.com:12345)

Fields inherited from class com.percolate.foam.ServiceImpl

context, utils

Constructor Summary

Constructors

Constructor and Description
UDPLoggingService(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
void	enable(java.lang.String url) Enable this service.
protected java.lang.String	getSysLogFormattedDate() syslog style date formatter
boolean	isEnabled() This service is enabled
void	logEvent(StoredException storedException, retrofit.Callback<java.lang.Object> callback) Send stored exception (i.e., crashes) to UDP endpoint
void	logEvent(java.lang.String log) Send individual log messages (i.e., Log.e() calls) to UDP endpoint
protected void	sendDataOverUDP(java.lang.String syslogMessage, retrofit.Callback<java.lang.Object> deleteFileCallback) Attempt to send syslog-style message over UDP using a DatagramSocket.
protected void	sendLogEvent(java.lang.String component, java.lang.String message, retrofit.Callback<java.lang.Object> callback) Create properly formatted message to send over UDP that acts like a syslog message syslog format: "<priority>timestamp orange_link blue_link: message" Details: http://en.wikipedia.org/wiki/Syslog#Priority

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.percolate.foam.Service

getServiceType

Field Detail

url

private java.lang.String url

UDP logging URL (eg: logs.myserver.com:12345)

host

private java.lang.String host

Host portion of url

port

private int port

Port portion of url

Constructor Detail

UDPLoggingService

UDPLoggingService(android.content.Context context)

Method Detail

enable

public void enable(java.lang.String url)

Enable this service. Pass in the respective API Key (or similar)

Specified by:

enable in interface Service

Parameters:

url - API Key (aka, Tracking ID, Application Key, Project Token, etc, etc)

isEnabled

public boolean isEnabled()

This service is enabled

Specified by:

isEnabled in interface Service

Returns:

true if enabled, otherwise false.

logEvent

public void logEvent(StoredException storedException,
                     retrofit.Callback<java.lang.Object> callback)

Send stored exception (i.e., crashes) to UDP endpoint

Specified by:

logEvent in interface CrashReportingService

Specified by:

logEvent in interface LoggingService

Parameters:

storedException - StoredException data. Never null.

callback - Retrofit callback. Use NoOpCallback if no action is required.

logEvent

public void logEvent(java.lang.String log)

Send individual log messages (i.e., Log.e() calls) to UDP endpoint

Specified by:

logEvent in interface LoggingService

Parameters:

log - Log message to send.

sendLogEvent

protected void sendLogEvent(java.lang.String component,
                            java.lang.String message,
                            retrofit.Callback<java.lang.Object> callback)

Create properly formatted message to send over UDP that acts like a syslog message syslog format: "<priority>timestamp orange_link blue_link: message" Details: http://en.wikipedia.org/wiki/Syslog#Priority

Parameters:

component - Component (eg, Thread name)

message - Message to send

callback - Callback to execute after data is sent. Can be null. Will only be executed if the data is successfully sent.

getSysLogFormattedDate

protected java.lang.String getSysLogFormattedDate()

syslog style date formatter

Returns:

Current time in syslog format.

sendDataOverUDP

protected void sendDataOverUDP(java.lang.String syslogMessage,
                               retrofit.Callback<java.lang.Object> deleteFileCallback)

Attempt to send syslog-style message over UDP using a DatagramSocket. Errors will be logged but not retried. UDP is also not guaranteed.

Parameters:

syslogMessage - Message to send

deleteFileCallback - Retrofit Callback. After data is sent this Callback is executed to delete the file that contained the data that was sent.