Google Cloud Logging Plugin
The Google Cloud Log plugin enables pushing logs to your Google Cloud project.
Enterprise Feature
Custom logging is available as an add-on as part of an enterprise plan. If you would like to purchase this feature, please contact us at sales@zuplo.com or reach out to your account manager.
Most enterprise features can be used in a trial mode for a limited time. Feel free to use enterprise features for development and testing purposes.
Setup
Before you can use this plugin, you will need to create a GCP Service account that grants your Zuplo API to write logs. Create a new GCP Service account and give it the Logs Writer (roles/logging.logWriter) permission. Create a key for the service account in JSON format.
After you have downloaded the JSON formatted service account, save it as a secret environment variable in your Zuplo project.
modules/zuplo.runtime.tsts
Configuration Options
The GoogleCloudLoggingPlugin
constructor accepts an options object with the
following properties:
serviceAccountJson
- (required) The JSON content of your Google Cloud service account keylogName
- (required) The name of the log in Google Cloud Logging (e.g.,projects/my-project/logs/my-api
)fields
- (optional) Custom fields to include in each log entry. Can contain string, number, or boolean values
Custom Fields
Any custom fields you want to include in the log entry can be added to the
fields
property. These values will be appended to every log entry.
Default Fields
Every log entry will have a timestamp
and a jsonPayload
object. The value of
the jsonPayload
contains the text or objects passed into the log.
Default fields in the jsonPayload
are:
severity
- The log level (e.g.,ERROR
,INFO
,DEBUG
,WARN
)requestId
- The UUID of the request (the value of thezp-rid
header)environmentType
- Where the Zuplo API is running. Values areedge
,working-copy
, orlocal
environmentStage
- The environment stage:working-copy
,preview
, orproduction
atomicCounter
- An atomic counter used to order logs with identical timestampsenvironment
- The environment name of the Zuplo APIrayId
- The network provider identifier (e.g., Cloudflare Ray ID) of the request