Google Cloud Workspace Configuration
Ship Google Cloud Workspace Logs to Logstash
Filebeat is an open source shipping agent that lets you ship logs from local files to one or more destinations, including Logstash.
Follow this step by step guide to get 'logs' from your system to Logit.io:
Step 1 - GCP 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 for IAM-based service account setup.
- Grant Admin SDK API Access:
- Enable access to the following APIs and services:
- Admin SDK
- 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.
- 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.
- Fill in the details:
Step 2 - Install Filebeat
- Windows
- Linux
- macOS
- DEB
- RPM
To get started you will need to install filebeat. To do this you have two main options:
- Choose the filebeat ZIP file (Windows ZIP x86_64) or
- Choose the Microsoft Software Installer MSI file (Windows MSI x86_64 (beta))
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
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
To get started you will need to install filebeat. To do this you have two main options:
- Choose the AMD / Intel file (x86_64) or
- Choose the ARM file (arm64)
You can tell if you have a Linux PC with an AMD / Intel CPU (kernel) architecture by opening a terminal and running the uname -m command. If it displays x86_64 you have AMD / Intel architecture.
If you have an x86_64 system download and extract the contents of the file using the following commands:
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-8.12.2-linux-x86_64.tar.gz
tar xzvf filebeat-8.12.2-linux-x86_64.tar.gz
If you have an arm64 system download and extract the contents of the file using the following commands:
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-8.12.2-linux-arm64.tar.gz
tar xzvf filebeat-8.12.2-linux-arm64.tar.gz
To get started you will need to install filebeat. To do this you have two main options:
- Choose the AMD / Intel file (x86_64) or
- Choose the ARM file (aarch64)
You can tell if you have a Mac with an ARM CPU architecture by opening the Terminal application and running the arch command. If it displays arm64 you have ARM architecture.
If you have an x86_64 system download and extract the contents of the file using the following commands:
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-8.12.2-darwin-x86_64.tar.gz
tar xzvf filebeat-8.12.2-darwin-x86_64.tar.gz
If you have an aarch64 system download and extract the contents of the file using the following commands:
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-8.12.2-darwin-aarch64.tar.gz
tar xzvf filebeat-8.12.2-darwin-aarch64.tar.gz
To get started you will need to install filebeat. To do this you have two main options:
- Choose the AMD / Intel file (x86_64) or
- Choose the ARM file (aarch64)
You can tell if you have a PC with an ARM CPU architecture by opening the Terminal application and running the arch command. If it displays arm64 you have ARM architecture.
If you have an x86_64 system download and install filebeat using the following commands:
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-8.12.2-amd64.deb
sudo dpkg -i filebeat-8.12.2-amd64.deb
If you have an aarch64 system download and install filebeat using the following commands:
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-8.12.2-arm64.deb
sudo dpkg -i filebeat-8.12.2-arm64.deb
To get started you will need to install filebeat. To do this you have two main options:
- Choose the AMD / Intel file (x86_64) or
- Choose the ARM file (aarch64)
You can tell if you have a PC with an ARM CPU architecture by opening the Terminal application and running the arch command. If it displays arm64 you have ARM architecture.
If you have an x86_64 system download and install filebeat using the following commands:
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-8.12.2-x86_64.rpm
sudo rpm -vi filebeat-8.12.2-x86_64.rpm
If you have an aarch64 system download and install filebeat using the following commands:
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-8.12.2-aarch64.rpm
sudo rpm -vi filebeat-8.12.2-aarch64.rpm
Step 3 - 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.
For version 7.16+ and above, use the configuration below:
fields:
type: google_workspace
# ============================== 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: ["your-logstash-host:your-ssl-port"]
loadbalance: true
ssl.enabled: true
# ================================= Processors =================================
processors:
- add_host_metadata:
when.not.contains.tags: forwarded
- add_cloud_metadata: ~
- add_docker_metadata: ~
- add_kubernetes_metadata: ~
If you’re running Filebeat 7 add this code block to the end. Otherwise, you can leave it out.
# ... For Filebeat 7 only ...
- if:
has_fields: ['gsuite']
then:
- rename:
fields:
- from: "source"
to: "gsuite_source"
- rename:
fields:
- from: "agent"
to: "filebeat_agent"
ignore_missing: true
- rename:
fields:
- from: "log.file.path"
to: "source"
ignore_missing: true
- add_id: ~
filebeat.registry.path: /var/lib/filebeat
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 is a great choice.
Step 4 - Validate configuration
- Windows
- Linux
- macOS
- DEB
- RPM
.\filebeat.exe -e -c filebeat.yml
sudo ./filebeat -e -c filebeat.yml --strict.perms=false
You’ll be running filebeat as root, so you need to change ownership of the configuration file and any configurations enabled in the modules.d directory, or run filebeat with --strict.perms=false as shown above. Read more about how to change ownership.
sudo ./filebeat -e -c filebeat.yml --strict.perms=false
You’ll be running filebeat as root, so you need to change ownership of the configuration file and any configurations enabled in the modules.d directory, or run filebeat with --strict.perms=false as shown above. Read more about how to change ownership.
sudo filebeat -e -c /etc/filebeat/filebeat.yml
sudo filebeat -e -c /etc/filebeat/filebeat.yml
Step 5 - Start filebeat
- Windows
- Linux
- macOS
- DEB
- RPM
To start Filebeat, run in Powershell:
Start-Service filebeat
To start Filebeat, run:
sudo chown root filebeat.yml
sudo chown root modules.d/{modulename}.yml
sudo ./filebeat -e
You’ll be running filebeat as root, so you need to change ownership of the configuration file and any configurations enabled in the modules.d directory, or run filebeat with --strict.perms=false as shown above. Read more about how to change ownership.
To start Filebeat, run:
sudo chown root filebeat.yml
sudo chown root modules.d/{modulename}.yml
sudo ./filebeat -e
You’ll be running filebeat as root, so you need to change ownership of the configuration file and any configurations enabled in the modules.d directory, or run filebeat with --strict.perms=false as shown above. Read more about how to change ownership.
To start Filebeat, run:
sudo service filebeat start
To start Filebeat, run:
sudo service filebeat start
Step 6 - Check Logit.io for your logs
Data should now have been sent to your Stack.
If you don't see logs take a look at How to diagnose no data in Stack below for how to diagnose common issues.
Step 7 - How to diagnose no data in Stack
If you don't see data appearing in your Stack after following the steps, visit the Help Centre guide for steps to diagnose no data appearing in your Stack or Chat to support now.
Step 8 - GCP Workspace Logging Overview
Google Workspace offers an array of APIs that seamlessly integrate with essential features, enhancing collaboration and productivity. Here's a focused overview:
People API:
- Empowers seamless access and management of contact information within Google Workspace.
Contacts API:
- Ensures a unified and up-to-date directory across the organization by facilitating the retrieval and updating of contact details.
Google Workspace Migrate API:
- Streamlines the migration of data for a smooth transition to Google Workspace, ensuring a secure and efficient process.
Gmail API:
- Provides programmatic access to Gmail features, allowing integration of Gmail functionalities into applications.
Google Calendar API:
- Enables seamless integration and management of calendar events, offering a comprehensive solution for schedule management.
Google Drive API:
- Empowers applications to access and manipulate files stored in Google Drive, facilitating seamless collaboration and file management.
Groups Migration API:
- Simplifies the migration of groups and memberships within Google Groups, ensuring a smooth transition.
Groups Settings API:
- Allows for the programmable management of group settings, providing control over group configurations.
Google Sheets API:
- Facilitates the integration and manipulation of Google Sheets data, enabling the automation of spreadsheet-related tasks.
Tasks API:
- Allows developers to integrate task management features into applications, enabling efficient task management.
If you need any further assistance with migrating your log data to ELK we're here to help you get started. Feel free to get in contact with our support team by sending us a message via live chat & we'll be happy to assist.