The following Google Cloud APIs must be enabled
- Cloud Monitoring
- Cloud Logging
- Cloud Trace
The following network access is required between the BindPlane Agent and the following Google API endpoint URLs.
Google Cloud Logging API v2:
Google Cloud Monitoring API v3:
Google Cloud Trace API:
👍 Typically, when sent telemetry from a GCP hosted system, these URLs are part of default network access.
The Google Cloud destination supports two forms of authentication.
- Access Scopes
- Access Scopes are used when the BindPlane Agent is running on a GCP-hosted VM.
- Service Account
- Services Account auth is the only option for sending telemetry from non-GCP-hosted agents.
Google Cloud Access Scopes
When running within Google Cloud, you can configure your Compute Engine instances with the following access scopes. This will allow the Google Cloud destination to configure authentication automatically.
You can read more about access scopes here.
If running outside of Google Cloud, or within Google Compute Engine without access scopes, you can create a service account for authentication.
- Create a Google service account following this documentation.
- Assign your service account the following roles
- Logs Writer:
- Monitoring Metric Writer:
- Cloud Trace Agent:
- Logs Writer:
- Create and download a Service Account Access Key following this documentation.
The downloaded access key will be used when configuring the Google Cloud destination.
|project||The Google Cloud Project ID to send logs, metrics, and traces to.|
|auth_type||auto||The method used for authenticating to Google Cloud. 'auto' will attempt to use the collector's environment, which is useful when running on Google Cloud or when you have set GOOGLE_APPLICATION_CREDENTIALS in the collector's environment. 'json' takes the JSON contents of a Google Service Account's credentials file. 'file' is the file path to a Google Service Account credential file.|
|credentials||JSON value from a Google Service Account credential file.|
|credentials_file||Path to a Google Service Account credential file on the collector system. The collector's runtime user must have permission to read this file.|
Supported Retry and Queuing Settings
This destination supports the following retry and queuing settings:
|Sending Queue||Persistent Queue||Retry on Failure|
This example uses the
auto Authentication Method. When running within Google Cloud with the correct access scopes, the destination will perform automatic authentication and send metrics, traces, and logs to the project
Service Account Credentials (JSON)
BindPlane OP can embed credentials into the agent configuration when the authentication method
json is selected.
When using the
json option, paste the service account JSON key into the text box. This method is convenient as it does not require copying the service account key on the agent system.
Service Account Credentials (File)
If you would prefer to copy the service account key to the agent system instead of having BindPlane handle it, you can select the
file option. In this example, the service account access key file is located at