Google Cloud Workspace Configuration

Ship Google Cloud Workspace Logs to Logit.io

Follow the steps below to send your observability data to Logit.io

Logs

Install Integration

Please click on the Install Integration button to configure your stack for this source.

Google Cloud Workspace

Google Workspace encompasses a suite of cloud-based computing tools, productivity applications, and collaborative solutions developed and offered by Google. Sending logs from Google Workspace to Logit.io can be achieved through the utilization of Filebeat and the Google Reports API.

Set Up a Service Account:

Follow the official Google Workspace tutorial (opens in a new tab) for IAM-based service account setup.

Grant Admin SDK API Access:

Enable access to the following APIs and services:
- Admin SDK (opens in a new tab)
- People API or Contacts API.
- Google Workspace Migrate API
- Gmail API
- Google Calendar API
- Google Drive API
- Groups Migration API
- Groups Settings API
- Google Sheets API
- Tasks API

Delegate Domain-Wide Authority to Your Service Account:

Open your Google Workspace Admin console (opens in a new tab).
Navigate to Main menu > Security > API controls.
In the Domain-wide delegation pane, select Manage Domain Wide Delegation.
If the option is not visible, switch to a super-admin Google Workspace account.
Access Manage Domain Wide Delegation and click Add new.
- Fill in the details:
  - Client ID: Found in the service account's details under Unique ID and in the client_id field of the auto-downloaded credentials file.
  - OAuth Scopes: Enter the admin's API.
- Click Authorize to confirm your changes.

Install Filebeat

To get started you will need to install filebeat. To do this you have two main options:

Choose the filebeat (opens in a new tab) ZIP file (Windows ZIP x86_64) or
Choose the Microsoft Software Installer MSI (opens in a new tab) file (Windows MSI x86_64 (beta))

To successfully install filebeat and set up the required Windows service you will need to have administrator access.

If you have chosen to download the zip file:

Extract the contents of the zip file into C:\Program Files.
Rename the extracted folder to filebeat
Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select Run As Administrator).
From the PowerShell prompt, run the following commands to install filebeat as a Windows service:

cd 'C:\Program Files\filebeat'

.\install-service-filebeat.ps1

If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example:

PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-filebeat.ps1

For more information about Powershell execution policies see here (opens in a new tab).

If you have chosen to download the filebeat.msi file:

double-click on it and the relevant files will be downloaded.

At the end of the installation process you'll be given the option to open the folder where filebeat has been installed.

Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select Run As Administrator).
From the PowerShell prompt, change directory to the location where filebeat was installed and run the following command to install filebeat as a Windows service:

.\install-service-filebeat.ps1

If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example:

PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-filebeat.ps1

For more information about Powershell execution policies see here (opens in a new tab).

Update Your Configuration File

The configuration file below is pre-configured to send data to your Logit.io Stack via Logstash.

Copy the configuration file below and overwrite the contents of filebeat.yml.

####################### Logit.io Filebeat Configuration ########################
# ============================== Filebeat modules ==============================
filebeat.modules:
  - module: google_workspace
    saml:
      enabled: true
      var.jwt_file: "./credentials_file.json"
      var.delegated_account: "[email protected]"
    user_accounts:
      enabled: true
      var.jwt_file: "./credentials_file.json"
      var.delegated_account: "[email protected]"
    login:
      enabled: true
      var.jwt_file: "./credentials_file.json"
      var.delegated_account: "[email protected]"
    admin:
      enabled: true
      var.jwt_file: "./credentials_file.json"
      var.delegated_account: "[email protected]"
    drive:
      enabled: true
      var.jwt_file: "./credentials_file.json"
      var.delegated_account: "[email protected]"
    groups:
      enabled: true
      var.jwt_file: "./credentials_file.json"
      var.delegated_account: "[email protected]"
# ================================== Outputs ===================================
# ------------------------------ Logstash Output -------------------------------
output.logstash:
  hosts: ["@logstash.host:@logstash.sslPort"]
  loadbalance: true
  ssl.enabled: true
 
# ================================= Processors =================================
processors:
  - add_fields:
      fields:
        type: google_workspace  
  - add_host_metadata:
      when.not.contains.tags: forwarded
  - add_cloud_metadata: ~
  - add_docker_metadata: ~
  - add_kubernetes_metadata: ~

Validate your YAML

It's a good idea to run the configuration file through a YAML validator to rule out indentation errors, clean up extra characters, and check if your YAML file is valid. Yamllint.com (opens in a new tab) is a great choice.

Validate configuration

In the directory where Filebeat is installed, run the following command to validate the installation:

.\@beatname.exe test config -c @beatname.yml

If the yml file is invalid, @beatname will print a description of the error. For example, if the output.logstash section was missing, @beatname would print no outputs are defined, please define one under the output section

Start filebeat

To start Filebeat, run in Powershell:

Start-Service filebeat

Launch Logs to View You Data

Launch Logs

How to diagnose no data in Stack

If you don't see data appearing in your stack after following this integration, take a look at the troubleshooting guide for steps to diagnose and resolve the problem or contact our support team and we'll be happy to assist.

Google Cloud VPN Metrics Google Compute Engine