Method: entries.write

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.

HTTP request

POST https://logging.googleapis.com/v2/entries:write

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "logName": string,
  "resource": {
    object (MonitoredResource)
  },
  "labels": {
    string: string,
    ...
  },
  "entries": [
    {
      object (LogEntry)
    }
  ],
  "partialSuccess": boolean,
  "dryRun": boolean
}
Fields
logName

string

Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for logName:

  • projects/[PROJECT_ID]/logs/[LOG_ID]
  • organizations/[ORGANIZATION_ID]/logs/[LOG_ID]
  • billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]
  • folders/[FOLDER_ID]/logs/[LOG_ID]

[LOG_ID] must be URL-encoded. For example:

"projects/my-project-id/logs/syslog"
"organizations/123/logs/cloudaudit.googleapis.com%2Factivity"

The permission logging.logEntries.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry.

Authorization requires the following IAM permission on the specified resource logName:

  • logging.logEntries.create
resource

object (MonitoredResource)

Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:

{ "type": "gce_instance",
  "labels": {
    "zone": "us-central1-a", "instanceId": "00000000000000000000" }}

See LogEntry.
labels

map (key: string, value: string)

Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.
entries[]

object (LogEntry)

Required. The log entries to send to Logging. The order of log entries in this list does not matter. Values supplied in this method's logName, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.

If the timestamp or insertId fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.

Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future will not be available when calling entries.list. However, those log entries can still be exported with LogSinks.

To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should try to include several log entries in this list, rather than calling this method for each individual log entry.

Authorization requires the following IAM permission on the specified resource entries:

  • logging.logEntries.create
partialSuccess

boolean

Optional. Whether a batch's valid entries should be written even if some other entry failed due to a permanent error such as INVALID_ARGUMENT or PERMISSION_DENIED. If any entry failed, then the response status is the response status of one of the failed entries. The response will include error details in WriteLogEntriesPartialErrors.log_entry_errors keyed by the entries' zero-based index in the entries. Failed requests for which no entries are written will not include per-entry errors.
dryRun

boolean

Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.

Response body

If successful, the response body is empty.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/logging.write
  • https://www.googleapis.com/auth/logging.admin
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.