Google Cloud Logging | APISIX & API7 API Gateway Docs

Parameters

See plugin common configurations for configuration options available to all plugins.

auth_config
object
Authentication configurations. At least one of the auth_config and auth_file should be provided.
- client_email
  string
  required
  Email address of the Google Cloud service account.
- private_key
  string
  required
  Private key of the Google Cloud service account.
- project_id
  string
  required
  Project ID in the Google Cloud service account.
- token_uri
  string
  required
  default: https://oauth2.googleapis.com/token
  Token URI of the Google Cloud service account.
- entries_uri
  string
  default: https://logging.googleapis.com/v2/entries:write
  Google Cloud Logging Service API.
- scope
  array[string]
  default: ["https://www.googleapis.com/auth/logging.read", "https://www.googleapis.com/auth/logging.write", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/cloud-platform"]
  Access scopes of the Google Cloud service account. See OAuth 2.0 Scopes for Google APIs.
auth_file
string
Path to the Google Cloud service account authentication JSON file. At least one of the auth_config and auth_file should be provided.
ssl_verify
boolean
default: true
If true, verify the server's SSL certificate.
resource
object
default: {"type": "global"}
Google monitored resource composed of type and optionally labels, for example:
```
{
  "type": "gce_instance",
  "labels": {
    "project_id": "my-project",
    "instance_id": "12345678901234",
    "zone": "us-central1-a"
  }
}
```
See MonitoredResource for more details.
log_id
string
default: apisix.apache.org%2Flogs
Google Cloud logging ID. See LogEntry for details.
log_format
object
Custom log format in key-value pairs in JSON format. Support built-in variables in values.
You can also configure log format on a global scale using the plugin metadata, which configures the log format for all google-cloud-logging plugin instances. If the log format configured on the individual plugin instance differs from the log format configured on plugin metadata, the log format configured on the individual plugin instance takes precedence. See the example for more details.
name
string
default: google-cloud-logging
Unique identifier of the plugin for the batch processor. If you use Prometheus to monitor APISIX metrics, the name is exported in apisix_batch_process_entries.
batch_max_size
integer
default: 1000
vaild vaule:
greater than 0
The number of log entries allowed in one batch. Once reached, the batch will be sent to the logging service. Setting this parameter to 1 means immediate processing.
inactive_timeout
integer
default: 5
vaild vaule:
greater than 0
The maximum time in seconds to wait for new logs before sending the batch to the logging service. The value should be smaller than buffer_duration.
buffer_duration
integer
default: 60
vaild vaule:
greater than 0
The maximum time in seconds from the earliest entry allowed before sending the batch to the logging service.
retry_delay
integer
default: 1
vaild vaule:
greater or equal to 0
The time interval in seconds to retry sending the batch to the logging service if the batch was not successfully sent.
max_retry_count
integer
default: 60
vaild vaule:
greater or equal to 0
The maximum number of unsuccessful retries allowed before dropping the log entries.

Plugin Metadata

log_format
object
Custom log format in key-value pairs in JSON format. Support built-in variables in values.

Parameters​

Plugin Metadata​

Parameters

Plugin Metadata