Project: APISIX (Orchestration & Management / API Gateway)
File: google-cloud-logging.md

title: google-cloud-logging keywords: Apache APISIX API Gateway Plugin Google Cloud logging description: This document contains information about the Apache APISIX google-cloud-logging Plugin. <!-- --> The `google-cloud-logging` Plugin is used to send APISIX access logs to . This plugin also allows to push logs as a batch to your Google Cloud Logging Service. It might take some time to receive the log data. It will be automatically sent after the timer function in the expires. | Name | Required | Default | Description | |-|-||--| | authconfig | True | | Either `authconfig` or `auth_file` must be provided. | | authconfig.clientemail | True | | Email address of the Google Cloud service account. | | authconfig.privatekey | True | | Private key of the Google Cloud service account. | | authconfig.projectid | True | | Project ID in the Google Cloud service account. | | authconfig.tokenuri | True | https://oauth2.googleapis.com/token | Token URI of the Google Cloud service account. | | authconfig.entriesuri | False | https://logging.googleapis.com/v2/entries:write | Google Cloud Logging Service API. | | auth_config.scopes | False | . | | authfile | True | | Path to the Google Cloud service account authentication JSON file. Either `authconfig` or `auth_file` must be provided. | | ssl_verify | False | true | When set to `true`, enables SSL verification as mentioned in . | | resource | False | {"type": "global"} | Google monitor resource. See for more details. | | log_id | False | apisix.apache.org%2Flogs | Google Cloud logging ID. See for details. | | log_format | False | | Log format declared as key value pairs in JSON format. Values only support strings. or variables can be used by prefixing the string with `$`. | NOTE: `encryptfields = {"authconfig.private_key"}` is also defined in the schema, which means that the field will be stored encrypted in etcd. See . This Plugin supports using batch processors to aggregate and process entries (logs/data) in a batch. This avoids the need for frequently submitting the data. The batch processor submits data every `5` seconds or when the data in the queue reaches `1000`. See for more information or setting your custom configuration. ```json { "insertId": "0013a6afc9c281ce2e7f413c01892bdc", "labels": { "source": "apache-apisix-google-cloud-logging" }, "logName": "projects/apisix/logs/apisix.apache.org%2Flogs", "httpRequest": { "requestMethod": "GET", "requestUrl": "http://localhost:1984/hello", "requestSize": 59, "responseSize": 118, "status": 200, "remoteIp": "127.0.0.1", "serverIp": "127.0.0.1:1980", "latency": "0.103s" }, "resource": { "type": "global" }, "jsonPayload": { "service_id": "", "route_id": "1" }, "timestamp":

} ``` You can also set the format of the logs by configuring the Plugin metadata. The following configurations are available: | Name | Type | Required | Default | Description | | - | | -- | -- | - | | log_format | object | False | | Log format declared as key value pairs in JSON format. Values only support strings. or variables can be used by prefixing the string with `$`. | :::info IMPORTANT Configuring the Plugin metadata is global in scope. This means that it will take effect on all Routes and Services which use the `google-cloud-logging` Plugin. ::: The example below shows how you can configure through the Admin API: :::note You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash adminkey=$(yq '.deployment.admin.adminkey[0].key' conf/config.yaml | sed 's/"//g') ``` ::: ```shell curl http://127.0.0.1:9180/apisix/admin/pluginmetadata/google-cloud-logging -H "X-API-KEY: $adminkey" -X PUT -d ' { "log_format": { "host": "$host", "@timestamp": "$time_iso8601", "clientip": "$remoteaddr" } }' ``` With this configuration, your logs would be formatted as shown below: ```json {"partialSuccess":false,"entries":[{"jsonPayload":{"clientip":"127.0.0.1","host":"localhost","@timestamp":"2023-01-09T14:47:25+08:00","routeid":"1"},"resource":{"type":"global"},"insertId":"942e81f60b9157f0d46bc9f5a8f0cc40","logName":"projects/apisix/logs/apisix.apache.org%2Flogs","timestamp":"2023-01-09T14:47:25+08:00","labels":{"source":"apache-apisix-google-cloud-logging"}}]} ``` The example below shows a complete configuration of the Plugin on a specific Route: ```shell curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d ' { "plugins": { "google-cloud-logging": { "auth_config":{ "project_id":"apisix", "client_email":"your service account email@apisix.iam.gserviceaccount.com", "private_key":"--BEGIN RSA PRIVATE KEY--your private key--END RSA PRIVATE KEY--", "token_uri":"https://oauth2.googleapis.com/token", "scopes":[ "https://www.googleapis.com/auth/logging.admin" ], "entries_uri":"https://logging.googleapis.com/v2/entries:write" }, "resource":{ "type":"global" }, "log_id":"apisix.apache.org%2Flogs", "inactive_timeout":10, "maxretrycount":0, "buffer_duration":60, "retry_delay":1, "batchmaxsize":1 } }, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }, "uri": "/hello" }' ``` The example below shows a bare minimum configuration of the Plugin on a Route: ```shell curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d ' { "plugins": { "google-cloud-logging": { "auth_config":{ "project_id":"apisix", "client_email":"your service account email@apisix.iam.gserviceaccount.com", "private_key":"--BEGIN RSA PRIVATE KEY--your private key--END RSA PRIVATE KEY--" } } }, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }, "uri": "/hello" }' ``` Now, if you make a request to APISIX, it will be logged in your Google Cloud Logging Service. ```shell curl -i http://127.0.0.1:9080/hello ``` You can then login and view the logs in . To remove the `google-cloud-logging` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect. ```shell curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d ' { "uri": "/hello", "plugins": {}, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } } }' ```