Package com.google.appengine.api.log.dev

Class LocalLogService

java.lang.Object

com.google.appengine.tools.development.AbstractLocalRpcService

com.google.appengine.api.log.dev.LocalLogService

All Implemented Interfaces:

DevLogService, LocalRpcService

@AutoService(LocalRpcService.class)
public class LocalLogService
extends AbstractLocalRpcService
implements DevLogService

Implementation of local log service.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.appengine.tools.development.LocalRpcService

LocalRpcService.Status

Field Summary

Fields inherited from interface com.google.appengine.tools.development.DevLogService

PACKAGE

Constructor Summary

Constructors

Constructor	Description
LocalLogService()

Method Summary

Modifier and Type	Method	Description
void	addAppLogLine(String requestId, long time, int level, String message)
void	addRequestInfo(String appId, String versionId, String requestId, @Nullable String ip, @Nullable String nickname, long startTimeUsec, long endTimeUsec, String method, String resource, String httpVersion, @Nullable String userAgent, boolean complete, @Nullable Integer status, @Nullable String referrer)
void	addRequestInfo(String appId, String moduleId, String versionId, String requestId, @Nullable String ip, @Nullable String nickname, long startTimeUsec, long endTimeUsec, String method, String resource, String httpVersion, @Nullable String userAgent, boolean complete, @Nullable Integer status, @Nullable String referrer)
void	clear()	Clears out the internal logs stored.
void	clearResponseSize()	Clears a response size previously registered by calling registerResponseSize(long).
Handler	getLogHandler()
String	getPackage()	Returns the package for the service, for example, "datastore_v3".
Long	getResponseSize()
com.google.apphosting.api.logservice.LogServicePb.LogReadResponse	read(LocalRpcService.Status status, com.google.apphosting.api.logservice.LogServicePb.LogReadRequest request)	Reads log records from the in-memory log list and applies user-specified filters to the results to return.
void	registerResponseSize(long responseSize)	Registers the response size of a request for use by addRequestInfo(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, long, long, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.Integer, java.lang.String).

Methods inherited from class com.google.appengine.tools.development.AbstractLocalRpcService

getDefaultDeadline, getMaxApiRequestSize, getMaximumDeadline, init, start, stop

Methods inherited from class java.lang.Object

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

Constructor Details

LocalLogService

public LocalLogService()

Method Details

getPackage

public String getPackage()

Description copied from interface: LocalRpcService

Returns the package for the service, for example, "datastore_v3".

Specified by:

getPackage in interface LocalRpcService

Returns:

The package name associated with this API.

read

public com.google.apphosting.api.logservice.LogServicePb.LogReadResponse read(LocalRpcService.Status status,
 com.google.apphosting.api.logservice.LogServicePb.LogReadRequest request)

Reads log records from the in-memory log list and applies user-specified filters to the results to return.

Parameters:

request - A set of parameters that indicate restrictions on the results that should be returned.

Returns:

A set of logs matching the parameters given. If the number of logs returned exceed either the user-specified amount or the API-specified limit, then an offset is returned that has a reference to the next record to read from in subsequent requests.

registerResponseSize

public void registerResponseSize(long responseSize)

Registers the response size of a request for use by addRequestInfo(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, long, long, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.Integer, java.lang.String). This is helpful because ResponseRewriterFilter computes the response length but has no direct way to convey the information to JettyContainerService.ApiProxyHandler which calls addRequestInfo(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, long, long, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.Integer, java.lang.String)

getResponseSize

public Long getResponseSize()

clearResponseSize

public void clearResponseSize()

Clears a response size previously registered by calling registerResponseSize(long).

addRequestInfo

public void addRequestInfo(String appId,
 String versionId,
 String requestId,
 @Nullable String ip,
 @Nullable String nickname,
 long startTimeUsec,
 long endTimeUsec,
 String method,
 String resource,
 String httpVersion,
 @Nullable String userAgent,
 boolean complete,
 @Nullable Integer status,
 @Nullable String referrer)

addRequestInfo

public void addRequestInfo(String appId,
 String moduleId,
 String versionId,
 String requestId,
 @Nullable String ip,
 @Nullable String nickname,
 long startTimeUsec,
 long endTimeUsec,
 String method,
 String resource,
 String httpVersion,
 @Nullable String userAgent,
 boolean complete,
 @Nullable Integer status,
 @Nullable String referrer)

addAppLogLine

public void addAppLogLine(String requestId,
 long time,
 int level,
 String message)

getLogHandler

public Handler getLogHandler()

Specified by:

getLogHandler in interface DevLogService

clear

public void clear()

Clears out the internal logs stored.