GCP Event Pollers

Turbot offers a polling mechanism for obtaining relevant events from GCP and updating its CMDB. This mechanism is easy to configure and will not require sending events to a public webhook endpoint (i.e., AWS API Gateway). While it is possible to configure both event poller and event handlers, Turbot highly recommends using the GCP event handlers. Event Pollers and Event Handlers should never be enabled at the same time.

Choose Event Poller for ease of configuration. This is the pull method.
Choose Event Handler for efficiency and timeliness. This is the push method.

In the case of the Turbot GCP Event Poller, StackDriver is queried for relevant events on a schedule and forwards them to the Turbot router for processing.

Be aware of logging limits and quotas, including:

Limited to 1 entries.list call per second, per project.
Log retention is 400 days for system and admin activity logs, 30 days for data access logs.

Configuration of GCP Pollers

The following policies will need to be configured in the environment to enable event polling:

Policy Type	Description
GCP > Turbot > Event Poller	Enable/ Disable polling
GCP > Turbot > Event Poller > Interval	The polling interval - how often to poll
GCP > Turbot > Event Poller > Window	The polling window - how far back to retrieve events when polling. This must exceed the interval, and is required in case events are recieved by stackdriver out of order
GCP > Turbot > Event Poller > Filter	The GCP Logging filter to use when querying events (same as GCP > Turbot > Event Handlers > Logging > Sink > Compiled Filter )

Relevant policy schema

GCP > Turbot > Event Poller

description: |
  Configure the GCP Event Poller. When set to Enabled, the poller will run at the interval specified to retrieve the latest events and forward them to the Turbot Router.

  Note: The Event Poller and Turbot Event Handlers are different mechanisms for sending information to Turbot. You should enable one or the other, but not both.

targets: GCP Project

schema:
  type: String
  enum:
    - Enabled
    - Disabled
  default: Enabled

GCP > Turbot > Event Poller > Interval

description: |
  The polling interval. This policy determines how often the event poller will run.

targets: GCP Project

schema:
  type: String
  enum:
    - Every 1 minute
    - Every 2 minutes
    - Every 3 minutes
    - Every 4 minutes
    - Every 5 minutes
    - Every 6 minutes
    - Every 7 minutes
    - Every 8 minutes
    - Every 9 minutes
    - Every 10 minutes

  default: Every 2 minutes

GCP > Turbot > Event Poller > Window

description: |
  The polling window, in minutes. This policies determines the oldest events the event poller will retrieve. For example, setting the window to '5 minutes' will cause the poller to retrieve all events from the previous 5 minutes every time it runs.

  The Window must be greater than the Interval, and it is recommended to be at least twice the Interval. For example, if the Interval is 'Every 5 Minutes', the Window should be at least '10 Minutes'.

targets: GCP Project

schema:
  type: String
  enum:
    - 5 minutes
    - 6 minutes
    - 7 minutes
    - 8 minutes
    - 9 minutes
    - 10 minutes
    - 11 minutes
    - 12 minutes
    - 13 minutes
    - 14 minutes
    - 15 minutes
    - 16 minutes
    - 17 minutes
    - 18 minutes
    - 19 minutes
    - 20 minutes
  default: 5 minutes

GCP > Turbot > Event Poller > Filter

description: |
  A GCP logs [advanced filter](https://cloud.google.com/logging/docs/view/advanced-queries) used to specify a subset of log entries that will be queried by the event poller.

  This is a read-only policy that is used internally by Turbot

targets: GCP Project

schema:
  type: String
  default: calculated - value of `GCP > Turbot > Event Handlers > Logging > Sink > Compiled Filter`