Kong Google Cloud Logging

Plugin for exporting Kong request data such as Service name, Route name, Consumer name or request latency to Google Cloud Logging.

Exported Data

For every request, the following data is exported:

• service name (if known)
• route name (if known)
• consumer name (if known)
• upstream_uri
• uri
• latency_request
• latency_gateway
• latency_proxy
• httpRequest

The logs are labeled with: "source": "kong-google-logging".

Usage

The plugin requires some Google service account credentials to write log entries to Google Cloud Logging. The service account requires the scope as described in the API docs. The credential details can be configured using the google_key parameter OR by providing a path to the key file using the google_key_file parameter.

The plugin uses Kong’s batch queue to send out log entries to Google in batches. For more information about the batch queue parameters, see batch_queue.lua.

Sample configuration via declarative (YAML):

plugins:
  - name: google-logging
    config:
      google_key:
        private_key: "***"
        client_email: "***"
        project_id: "***"
        token_uri: "***"
      google_key_file: /path/to/service-account-keyfile.json
      resource:
        type: k8s_cluster
        labels:
          project_id: "my project"
          location: "my location"
          cluster_name: "my cluster name"
      retry_count: 0
      flush_timeout: 2
      batch_max_size: 200

Install

Luarocks

luarocks install kong-plugin-google-logging

Source Code

> git clone https://github.com/SmartParkingTechnology/kong-google-logging-plugin.git
> cd /path/to/kong/plugins/kong-google-logging-plugin
> luarocks make *.rockspec

Configuration Reference

You can configure this plugin using the Kong Admin API or through declarative configuration, which involves directly editing the Kong configuration file.

This plugin is compatible with requests with the following protocols:

• http
• https

This plugin is compatible with DB-less mode.

In DB-less mode, Kong does not have an Admin API. If using this mode, configure the plugin using declarative configuration.

Enabling the plugin globally

A plugin which is not associated to any Service, Route, or Consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

$ curl -X POST http://<admin-hostname>:8001/plugins/ \
    --data "name=google-logging" 

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-google-logging>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config:
  <optional_parameter>: <value>
plugin: google-logging

plugins:
- name: google-logging
  config:
    <optional_parameter>: <value>

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration: