Page Comparison

Table of Contents

minLevel	2
maxLevel	2
type	flat

Service description

This collector will retrieve the information stored in Google Cloud Platform (GCP), such as audit logs, networking, load balance, and more.

Data source description

The Google Cloud Platform (GCP) centralizes all the monitoring information from all services in the cloud catalog inside a service called Stackdriver.

There is certain information that is enabled by default and is free of charge. However, generating some other information will imply some costs and that's why it must be enabled manually. In both cases, the generated information (we will call them messages) will arrive at the Stackdriver service.

Note
There exist many more GCP services than the ones shown in the diagram, these are only a small sample.

The Stackdriver service has different ways of exporting the information stored inside (structured in messages). In this case, it uses another GCP service called PubSub, which contains a "Topic" object that will receive a filtered set of messages from the Stackdriver service. Then, the GCP collector will retrieve all those messages from the "Topic" object using a subscription (concretely in "pull" mode):

Image Removed

Image Added

The GCP collector that we provide processes the stored information and sends it to the Devo platform. Data will be sent to a central table within your Devo domain named cloud.gcp.

Image Removed

Image Added

Service name definitions

Listed in the table below are the service names, details, and how the Devo platform treats the data.

Services	Details	Devo tables
Audit Resource	Get information on Cloud Audit Logs that maintain three audit logs for each Google Cloud project, folder, and organization: Admin Activity, Data Access, and System Event. Google Cloud services write audit log entries to these logs to help you answer the questions of "who did what, where, and when?" within your Google Cloud resources.	`cloud.gcp.logging.audited_resource`
Virtual Machines	Get information about the Virtual Machine Instance, CPU, Memory, and more.	`cloud.gcp.logging.gce_instance`
Redis	Get information on memory store for Redis instance's performance, and allows you to check in on your instances to make sure they're behaving as desired.	`cloud.gcp.logging.redis`
Networking	Get information on memory store usage.	`cloud.gcp.logging.gce_subnetwork`
Load Balance	Get information about the load balancer that distributes user traffic across multiple instances of your applications.	`cloud.gcp.logging.load_balancer`
Kubernetes Engine	Get information about Google Kubernetes Engine (GKE), which provides a managed environment for deploying, managing, and scaling your containerized applications using Google infrastructure.	`cloud.gcp.logging.k8s`
PubSub	Get information about the asynchronous messaging service.	`cloud.gcp.logging.pubsub`

Setup

The collector will be executed inside of the Collector Server as well as a Standalone mode (docker container). Some configurations will be necessary for the proper functioning of the collector.

Source setup types

In order to have the GCP collector running in a proper way, the data source (in this case GCP) must have several service structures configured. Specifically, it is required to set subscription objects to pull mode.

The required GCP setup can be created either automatically or manually. Depending on a configuration file property called autoconfig, one mode or another will be used and the behavior will be the following:

Automatic

The autoconfig property must have the enabled option set to true. Also, the internal service definition should have a configuration class value set (this cannot be set by the customer). The autoconfiguration functionality will create different "sinks" using the predefined service definition or using some custom definitions from the configuration file.

Manual

The autoconfig property must have the enabled option set to false and any configuration class defined in the internal service definition will be ignored. Depending if the property subscription_name is set, two different behaviors will be applied:

If subscription_name is defined, the value will be used for connecting to the GCP subscription. If the subscription doesn't exist, it will cause an eternal loop checking every minute if that subscription exists (the console logs will show a warning).
If subscription_name is not defined, a subscription with the same name as the one auto-calculated by the autoconfiguration functionality will be expected.

Service types

The GCP collector must have at least one service entry in the services section. These services can be of two types:

Predefined services

These services will not require to set some properties in the configuration file since they are already internally defined. This is the list of predefined services:

virtual_machines → Resources from "Compute Engine" GCP service.
networking → Resources from "VPC network" GCP service.
load_balancing → Resources from "Network services > Load balancing" GCP service.
pubsub → Resources from "PubSub" service.
redis → Resources from "Redis" service.

Custom services

These services will require some extra properties in the configuration file:

sink_filter_resource → This is the value of the filter that will be applied to the GCP Sink object when the all value is set in the regions section during the automatic configuration phase (if enabled).
sink_filter_resource_region → This is the value of the filter that will be applied to the GCP Sink object when any value distinct from all is set in the regions section during the autoconfiguration phase (if enabled). The filter must contain a placeholder with value {region} as part of its value.

The syntax to be used in sink_filter_resource_* properties is detailed here.

Credentials

Follow the next steps to create the Service Account that will be used to collect the alerts and enable the necessary API and scopes to use it.

Go to your Google GCP console project and open the left menu. Click IAM & Admin → Service Accounts.
Click on + Create Service Account to create the credentials.
Follow the 3 steps to create the credentials. Enter a name and click on Create. Steps 2 and 3 are optional, so you may just click Continue to go to step 3 and select Done.
Now you have to add the Keys to the service account that was previously createdand download it in JSON format. After clicking the Done button, you’ll be redirected to the services accounts of your project. Search the service account that you created and click it.
Image RemovedImage Added
In the Service account details area, click ADD KEY → Create new key, select the JSON format, and click CREATE. Download the credentials file and move it to the <any_directory>/devo-collectors/gcp/credentials/ directory.

Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).

Rw ui tabs macro

Rw tab

title	Cloud collector

We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration.

Rw tab

title	On-premise collector

This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.

Structure

The following directory structure will be required as part of the setup procedure (it can be created under any directory):

Code Block

<any_directory>
└── devo-collectors/
    └── gcp/
        ├── certs/
        │   ├── chain.crt
        │   ├── <your_domain>.key
        │   └── <your_domain>.crt
        ├── credentials/
        │   └── credentials-gcp.json
        └── config/
            └── config-gcp.yaml

Devo credentials

In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <any_directory>/devo-collectors/gcp/certs/. Learn more about security credentials in Devo here.

Editing the config-gcp.yaml file

In the config-gcp.yaml file, replace the <short_unique_identifier>, <source_id>, <project_id>, <credentials_file> and <credentials_file_content_base64> values and enter the ones that you got in the previous steps. In the <short_unique_identifier> placeholder, enter the value that you choose.

The GCP collector has many different configurations. See some usage config examples and custom services below.

Predefined services and autoconfig functionality enabled:

Code Block

globals:
  debug: false
  id: not_used
  name: gcp
  persistence:
    type: filesystem                                                  # File system persistence ON
    config:
      directory_name: state                                           # Directory where the persistence will be saved in case of using filesystem
outputs:
  devo_1:                                                             # Cloud Devo config EU (for US use us.elb.relay.logtrust.net)
    type: devo_platform
    config:
      address: collector-eu.devo.io                                   # URL to use for sending messages
      port: 443                                                       # SSL for using certificates or TCP for sending without encryption
      type: SSL
      chain: chain.crt                                                # \
      cert: <your_domain>.crt                                         #  Credential files downloaded from a Devo domain
      key: <your_domain>.key                                          # /
inputs:
  gcp:
    id: <short_unique_identifier>                                     # The value of this field will be used internally for having independent persistence areas
    enabled: true                                                     # If "false" value this "input" will not be used by collector
    requests_per_second: 5                                            # Setup how many request API por second
    use_time_slots_for_retrievals: false
    autoconfig:
      enabled: true                                                   # Determines if the "autoconfiguration" functionality will be executed
      refresh_interval_in_seconds: 3600                               # Setting up the time for executing autoconfig interval. 3600 seconds is recommended.
    credentials:
      source_id: <source_id>                                          # This value will be used for adding to message "tag" as fourth level
      project_id: <project_id>                                        # This value will be used for adding to message "tag" as fifth level
      filename: <filename>                                            # Credentials file generated from the "GCP administration console"
      file_content_base64: <file_content_base64>                      # Credentials file content generated from the "GCP administration console" in base64 format
    services:                                                         # Services available for this collector are virtual machines, networking, load balance, redis and PubSub.
      virtual_machines:
        request_period_in_seconds: 15                                 # Setting up time interval between API requests. 15sec is recommended.
        regions:                                                      # Regions for being used as filter of source data, use "all" value for no filter by region
          - all
      networking:
        request_period_in_seconds: 15
        regions:
          - all
      load_balancing:
        request_period_in_seconds: 15
        regions:
          - all
      pubsub:
        request_period_in_seconds: 15
        regions:
          - all
      redis:
        request_period_in_seconds: 15
        regions:
          - all
      custom_service_1:
        tag_subtype: "all1"
        subscription_name: "custom_service_1-subscription"
        request_period_in_seconds: 30
      custom_service_2:
        tage: "my.app.gcp.test1"
        subscription_name: "custom_service_2-subscription"
        request_period_in_seconds: 30

The custom configuration section can be set with many different values. Find below several examples of the custom configuration section and their impact on the different services involved.

Predefined services and autoconfig functionality disabled:

Code Block

globals:
  debug: false
  id: not_used
  name: gcp
  persistence:
    type: filesystem                                                  # File system persistence ON
    config:
      directory_name: state                                           # Directory where the persistence will be saved in case of using filesystem
outputs:
  devo_1:                                                             # Cloud Devo config EU (for US use us.elb.relay.logtrust.net)
    type: devo_platform
    config:
      address: collector-eu.devo.io                                   # URL to use for sending messages
      port: 443                                                       # SSL for using certificates or TCP for sending without encryption
      type: SSL
      chain: chain.crt                                                # \
      cert: <your_domain>.crt                                         #  Credential files downloaded from a Devo domain
      key: <your_domain>.key                                          # /
inputs:
  gcp:
    id: <short_unique_identifier>                                     # The value of this field will be used internally for having independent persistence areas
    enabled: true                                                     # If "false" value this "input" will not be used by collector
    requests_per_second: 5                                            # Setup how many request API por second
    use_time_slots_for_retrievals: false
    autoconfig:
      enabled: false                                                  # Determines if the "autoconfiguration" functionality will be executed
      refresh_interval_in_seconds: 3600                               # Setting up the time for executing autoconfig interval. 3600 seconds is recommended.
    credentials:
      source_id: <source_id>                                          # This value will be used for adding to message "tag" as fourth level
      project_id: <project_id>                                        # This value will be used for adding to message "tag" as fifth level
      filename: <filename>                                            # Credentials file generated from the "GCP administration console"
      file_content_base64: <file_content_base64>                      # Credentials file content generated from the "GCP administration console" in base64 format
    services:                                                         # Services available for this collector are virtual machines, networking, load balance, redis and PubSub.
      virtual_machines:
        request_period_in_seconds: 15                                 # Setting up time interval between API requests. 15sec is recommended.
        regions:                                                      
          - europe-west2                                              # Regions for being used as filters of source data
          - europe-west3
      networking:
        request_period_in_seconds: 15
        regions:
          - europe-west3
      load_balancing:
        request_period_in_seconds: 15
        regions:
          - all
      pubsub:
        request_period_in_seconds: 15
        regions:
          - all
      redis:
        request_period_in_seconds: 15
        regions:
          - all
      custom_service_1:
        tag_subtype: "all1"
        subscription_name: "custom_service_1-subscription"
        request_period_in_seconds: 30
      custom_service_2:
        tag: "my.app.gcp.test1"
        subscription_name: "custom_service_2-subscription"
        request_period_in_seconds: 30

Custom services, autoconfig functionality enabled and using regions:

Code Block

globals:
  debug: false
  id: not_used
  name: gcp
  persistence:
    type: filesystem                                                  # File system persistence ON
    config:
      directory_name: state                                           # Directory where the persistence will be saved in case of using filesystem
outputs:
  devo_1:                                                             # Cloud Devo config EU (for US use us.elb.relay.logtrust.net)
    type: devo_platform
    config:
      address: collector-eu.devo.io                                   # URL to use for sending messages
      port: 443                                                       # SSL for using certificates or TCP for sending without encryption
      type: SSL
      chain: chain.crt                                                # \
      cert: <your_domain>.crt                                         #  Credential files downloaded from a Devo domain
      key: <your_domain>.key                                          # /
inputs:
  gcp:
    id: <short_unique_identifier>                                     # The value of this field will be used internally for having independent persistence areas
    enabled: true                                                     # If "false" value this "input" will not be used by collector
    requests_per_second: 5                                            # Setup how many request API por second
    use_time_slots_for_retrievals: false
    autoconfig:
      enabled: true                                                   # Determines if the "autoconfiguration" functionality will be executed
      refresh_interval_in_seconds: 3600                               # Setting up the time for executing autoconfig interval. 3600 seconds is recommended.
    credentials:
      source_id: <source_id>                                          # This value will be used for adding to message "tag" as fourth level
      project_id: <project_id>                                        # This value will be used for adding to message "tag" as fifth level
      filename: <filename>                                            # Credentials file generated from the "GCP administration console"
      file_content_base64: <file_content_base64>                      # Credentials file content generated from the "GCP administration console" in base64 format
    services:
      all_resources_na:
          sink_filter_resource: "resource.type:\"\""
          sink_filter_resource_region: "resource.type:\"\" AND resource.labels.zone:\"{region}\""
          regions:
            - northamerica
            - us
        all_resources_europe:
          sink_filter_resource: "resource.type:\"\""
          sink_filter_resource_region: "resource.type:\"\" AND resource.labels.zone:\"{region}\""
          regions:
            - europe

Info
The syntax to be used in sink_filter_resource_* properties is detailed here.

Custom services, autoconfig functionality disabled and using regions:

Code Block

globals:
  debug: false
  id: not_used
  name: gcp
  persistence:
    type: filesystem                                                  # File system persistence ON
    config:
      directory_name: state                                           # Directory where the persistence will be saved in case of using filesystem
outputs:
  devo_1:                                                             # Cloud Devo config EU (for US use us.elb.relay.logtrust.net)
    type: devo_platform
    config:
      address: collector-eu.devo.io                                   # URL to use for sending messages
      port: 443                                                       # SSL for using certificates or TCP for sending without encryption
      type: SSL
      chain: chain.crt                                                # \
      cert: <your_domain>.crt                                         #  Credential files downloaded from a Devo domain
      key: <your_domain>.key                                          # /
inputs:
  gcp:
    id: <short_unique_identifier>                                     # The value of this field will be used internally for having independent persistence areas
    enabled: true                                                     # If "false" value this "input" will not be used by collector
    requests_per_second: 5                                            # Setup how many request API por second
    use_time_slots_for_retrievals: false
    autoconfig:
      enabled: false                                                  # Determines if the "autoconfiguration" functionality will be executed
      refresh_interval_in_seconds: 3600                               # Setting up the time for executing autoconfig interval. 3600 seconds is recommended.
    credentials:
      source_id: <source_id>                                          # This value will be used for adding to message "tag" as fourth level
      project_id: <project_id>                                        # This value will be used for adding to message "tag" as fifth level
      filename: <filename>                                            # Credentials file generated from the "GCP administration console"
      file_content_base64: <file_content_base64>                      # Credentials file content generated from the "GCP administration console" in base64 format
    services:
      all_resources_na:
          sink_filter_resource: "resource.type:\"\""
          sink_filter_resource_region: "resource.type:\"\" AND resource.labels.zone:\"{region}\""
          regions:
            - northamerica
            - us
        all_resources_europe:
          sink_filter_resource: "resource.type:\"\""
          sink_filter_resource_region: "resource.type:\"\" AND resource.labels.zone:\"{region}\""
          regions:
            - europe

Info
The syntax to be used in sink_filter_resource_* properties is detailed here.

Custom services and specifying "subscription name". In order to do this, the autoconfig functionality must be disabled and the use of the regions section is not allowed in this case (it will be ignored if exists):

Code Block

globals:
  debug: false
  id: not_used
  name: gcp
  persistence:
    type: filesystem                                                  # File system persistence ON
    config:
      directory_name: state                                           # Directory where the persistence will be saved in case of using filesystem
outputs:
  devo_1:                                                             # Cloud Devo config EU (for US use us.elb.relay.logtrust.net)
    type: devo_platform
    config:
      address: collector-eu.devo.io                                   # URL to use for sending messages
      port: 443                                                       # SSL for using certificates or TCP for sending without encryption
      type: SSL
      chain: chain.crt                                                # \
      cert: <your_domain>.crt                                         #  Credential files downloaded from a Devo domain
      key: <your_domain>.key                                          # /
inputs:
  gcp:
    id: <short_unique_identifier>                                     # The value of this field will be used internally for having independent persistence areas
    enabled: true                                                     # If "false" value this "input" will not be used by collector
    requests_per_second: 5                                            # Setup how many request API por second
    use_time_slots_for_retrievals: false
    autoconfig:
      enabled: false                                                  # Determines if the "autoconfiguration" functionality will be executed
      refresh_interval_in_seconds: 90                                 # Setting up the time for executing autoconfig interval. 90sec is recommended.
    credentials:
      source_id: <source_id>                                          # This value will be used for adding to message "tag" as fourth level
      project_id: <project_id>                                        # This value will be used for adding to message "tag" as fifth level
      filename: <filename>                                            # Credentials file generated from the "GCP administration console"
      file_content_base64: <file_content_base64>                      # Credentials file content generated from the "GCP administration console" in base64 format
    services:
      all_resources_usa:
        subscription_name: "subscription-a"
      all_resources_europe:
        subscription_name: "subscription-b"

Download the Docker image

The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:

Collector Docker image	SHA-256 hash
collector-gcp-docker-image-1.1.24.tgz	`0571ba2a9615f68efb4e5bc44197a33d3b6c28443b54173ace9c906f099c24fa491084e8ba92e0c5ac02e1ea49dc4a36097f77bd4b0bc3059f9ec8327cd2a37f`

Use the following command to add the Docker image to the system:

Code Block
gunzip -c collector-gcp-docker-image-<version>.tgz \| docker load

Info
Once the Docker image is imported, it will show the real name of the Docker image (including version info).

The Docker image can be deployed on the following services:

Docker

Execute the following command on the root directory <any_directory>/devo-collectors/gcp/

Code Block

docker run \
--name collector-gcp \
--volume $PWD/certs:/devo-collector/certs \
--volume $PWD/config:/devo-collector/config \
--volume $PWD/state:/devo-collector/state \
--env CONFIG_FILE=config-gcp.yaml \
--rm -it docker.devo.internal/collector/gcp:<version>

Note
Replace `<version>` with the proper version.

Docker Compose

The following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/gcp/ directory.

Code Block

version: '3'
services:
  collector-gcp:
    build:
      context: .
      dockerfile: Dockerfile
    image: docker.devo.internal/collector/gcp:${IMAGE_VERSION:-latest}
    container_name: collector-gcp
    volumes:
      - ./certs:/devo-collector/certs
      - ./config:/devo-collector/config
      - ./state:/devo-collector/state
    environment:
      - CONFIG_FILE=${CONFIG_FILE:-config-gcp.yaml}

To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/gcp/ directory:

Code Block
IMAGE_VERSION=<version> docker-compose up -d

Versions Compared

Old Version 1

New Version Current

Key

Service description

Data source description

Service name definitions

Setup

Source setup types

Service types

Credentials

Run the collector

Structure

Devo credentials

Editing the config-gcp.yaml file

Download the Docker image

Docker

Docker Compose