google/appengine/api/log/RequestLog.php
Copyright 2007 Google Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
\google\appengine\api\log\RequestLog
Package:
Default
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Represents the details of a single request and may optionally contain
application logs written during the request using the
syslog
function.
Methods
getAppLogs
()
:
\google\appengine\api\log\AppLogLine[]
Type | Description |
---|---|
\google\appengine\api\log\AppLogLine[] | The {@link AppLogLine}s added during this request. |
getCombined
()
: string
Type | Description |
---|---|
string | The Apache-format combined log entry for this request. While the information in this field can be constructed from the rest of this message, we include this method for convenience. |
getEndDateTime
()
: \google\appengine\api\log\DateTime
Type | Description |
---|---|
\google\appengine\api\log\DateTime | The same value as {@link getEndTimeUsec()} as a DateTime instance accurate to the second. For greater accuracy use {@link getEndTimeUsec()}. |
getEndTimeUsec
()
: double
Type | Description |
---|---|
double | The time at which the request finished processing, in microseconds since the Unix epoch. |
getHost
()
: string
Type | Description |
---|---|
string | The Internet host and port number of the resource being requested. |
getInstanceIndex
()
: integer
Type | Description |
---|---|
integer | The module instance that handled the request if manual_scaling or basic_scaling is configured or -1 for automatic_scaling. |
getInstanceKey
()
: string
Type | Description |
---|---|
string | Mostly-unique identifier for the instance that handled the request, or the empty string. |
getIp
()
: string
Type | Description |
---|---|
string | The origin IP address of this request. App Engine uses an origin IP address from the 0.0.0.0/8 range when the request is to a web hook. Some examples of web hooks are task queues, cron jobs and warming requests. |
getLatencyUsec
()
: double
Type | Description |
---|---|
double | The time required to process this request in microseconds. |
getMethod
()
: string
Type | Description |
---|---|
string | The request's HTTP method (e.g., GET, PUT, POST). |
getModuleId
()
: string
Type | Description |
---|---|
string | The version of the application that handled this request. |
getNickname
()
: string
Type | Description |
---|---|
string | The nickname of the user that made the request. An empty string is returned if the user is not logged in. |
getOffset
()
: string
Type | Description |
---|---|
string | A url safe value that may be used as an option to <code>LogService::fetch($options)</code> to continue reading after this log. |
getPendingTimeUsec
()
: double
Type | Description |
---|---|
double | The time, in microseconds, that this request spent in the pending request queue, if it was pending at all. |
getRequestId
()
: string
Type | Description |
---|---|
string | A globally unique identifier for a request, based on the request's starting time. |
getResource
()
: string
Type | Description |
---|---|
string | The resource path on the server requested by the client. Contains only the path component of the request URL. |
getResponseSize
()
: integer
Type | Description |
---|---|
integer | The size (in bytes) of the response sent back to the client. |
getStartDateTime
()
: \google\appengine\api\log\DateTime
Type | Description |
---|---|
\google\appengine\api\log\DateTime | The same value as {@link getStartTimeUsec()} as a DateTime instance accurate to the second. For greater accuracy use {@link getStartTimeUsec()}. |
getStartTimeUsec
()
: double
Type | Description |
---|---|
double | The time at which this request began processing, in microseconds since the Unix epoch. |
getTaskName
()
: string
Type | Description |
---|---|
string | The request's task name, if this request was generated via the Task Queue API. |
getTaskQueueName
()
: string
Type | Description |
---|---|
string | The request's queue name, if this request was generated via the Task Queue API. |
getUrlMapEntry
()
: string
Type | Description |
---|---|
string | The file or class within the URL mapping used for this request. Useful for tracking down the source code which was responsible for managing the request, especially for multiply mapped handlers. |
getVersionId
()
: string
Type | Description |
---|---|
string | The version of the application that handled this request. |
isFinished
()
: boolean
Type | Description |
---|---|
boolean | Whether or not this request has finished processing. If not, this request is still active. |