entries
Creates, updates, deletes, gets or lists an entries
resource.
Overview
Name | entries |
Type | Resource |
Id | google.logging.entries |
Fields
The following fields are returned by SELECT
queries:
- entries_list
Successful response
Name | Datatype | Description |
---|---|---|
entries | array | A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information. |
nextPageToken | string | If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
entries_list | select | Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs (https://cloud.google.com/logging/docs/export). | ||
entries_copy | exec | Copies a set of log entries from a log bucket to a Cloud Storage bucket. | ||
entries_write | exec | Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resource names (projects, organizations, billing accounts or folders), where the resource name for a log entry is determined from its logName field. | ||
entries_tail | exec | Streaming read of log entries as they are received. Until the stream is terminated, it will continue reading logs. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|
SELECT
examples
- entries_list
Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs (https://cloud.google.com/logging/docs/export).
SELECT
entries,
nextPageToken
FROM google.logging.entries;
Lifecycle Methods
- entries_copy
- entries_write
- entries_tail
Copies a set of log entries from a log bucket to a Cloud Storage bucket.
EXEC google.logging.entries.entries_copy
@@json=
'{
"name": "{{ name }}",
"filter": "{{ filter }}",
"destination": "{{ destination }}"
}';
Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resource names (projects, organizations, billing accounts or folders), where the resource name for a log entry is determined from its logName field.
EXEC google.logging.entries.entries_write
@@json=
'{
"logName": "{{ logName }}",
"resource": "{{ resource }}",
"labels": "{{ labels }}",
"entries": "{{ entries }}",
"partialSuccess": {{ partialSuccess }},
"dryRun": {{ dryRun }}
}';
Streaming read of log entries as they are received. Until the stream is terminated, it will continue reading logs.
EXEC google.logging.entries.entries_tail
@@json=
'{
"resourceNames": "{{ resourceNames }}",
"filter": "{{ filter }}",
"bufferWindow": "{{ bufferWindow }}"
}';