Documentationbreadcrumb arrow Pluginsbreadcrumb arrow Google BigQuerybreadcrumb arrow Configure
Grafana Cloud Enterprise Open source
Last reviewed: February 11, 2026

Configure the Google BigQuery data source

This document explains how to configure the Google BigQuery data source in Grafana.

Before you begin

Before configuring the data source, ensure you have:

  • Grafana version: 11.6.0 or later (plugin version 3.x). For older Grafana versions, use plugin version 2.x (requires Grafana 10.4.8+) or 1.x.
  • Grafana permissions: Organization administrator role to add data sources.
  • Google Cloud APIs enabled: The following APIs must be enabled in your GCP project:
  • Google Cloud credentials: Depending on your authentication method, you need either a service account key file or access to the Google Metadata Server.

Note

Each data source instance connects to a single GCP project. To visualize data from multiple GCP projects, create one data source per project.

Add the data source

To add the Google BigQuery data source:

  1. Click Connections in the left-side menu.
  2. Click Add new connection.
  3. Type BigQuery in the search bar.
  4. Select Google BigQuery.
  5. Click Add new data source.

Configure settings

SettingDescription
NameThe name used to refer to the data source in panels and queries.
DefaultToggle to make this the default data source for new panels.

Authentication

Google BigQuery data source supports multiple authentication methods. Choose the method that best fits your deployment environment.

Google Service Account key

Use this method when running Grafana outside of Google Cloud Platform, or when you need explicit credentials.

To configure service account authentication:

  1. Create a Google Cloud Platform (GCP) Service Account.
  2. Assign the following roles to the service account:
    • BigQuery Data Viewer - Provides read access to BigQuery data
    • BigQuery Job User - Allows running BigQuery jobs
  3. Create and download a JSON key file for the service account.
  4. In the data source configuration, select Google Service Account Key as the authentication type.
  5. Upload the JSON key file or paste its contents.

Google Metadata Server

Use this method when running Grafana on a Google Compute Engine (GCE) virtual machine.

When Grafana runs on a GCE virtual machine, it can automatically retrieve the default project ID and authentication token from the metadata server. To use this method:

  1. Ensure your virtual machine has a service account configured as the default account.
  2. Assign the service account the BigQuery Data Viewer and BigQuery Job User roles.
  3. In the data source configuration, select Google Metadata Server as the authentication type.

Service account impersonation

Use service account impersonation when you need to delegate access to BigQuery without distributing service account keys.

To configure service account impersonation:

  1. Ensure the service account used by the plugin has the iam.serviceAccounts.getAccessToken permission. This permission is included in the Service Account Token Creator role (roles/iam.serviceAccountTokenCreator).
  2. Ensure the service account being impersonated has the following roles:
    • BigQuery Data Viewer
    • BigQuery Job User
  3. In the data source configuration, enable Service Account Impersonation.
  4. Enter the email address of the service account to impersonate.

Workload Identity Federation

Use Google Cloud Workload Identity Federation (WIF) to let Grafana users authenticate to BigQuery with an external identity provider (such as Okta or another OIDC provider) instead of a service account key.

Note

This authentication method is available on Grafana Cloud only. Grafana Cloud exchanges the signed-in user’s external OIDC token for a short-lived Google Cloud access token before the request reaches the plugin.

Configuring Workload Identity Federation involves three systems: Google Cloud, your Grafana Cloud stack, and the data source itself.

In Google Cloud

  1. Create a Workload Identity Pool and Provider that trusts your OIDC identity provider. When configuring the provider, set up attribute mappings so that google.subject maps to the relevant claim from your identity provider (for example, assertion.sub — the exact mapping depends on your provider’s claim format).
  2. Grant the BigQuery permissions needed to run queries. How you grant them depends on whether you use service account impersonation:
    • Without impersonation — grant the WIF pool principal directly:
      • BigQuery Data Viewer
      • BigQuery Job User
    • With impersonation — create a service account, grant it those same roles, then grant the WIF pool principal the Service Account Token Creator role on that service account.

In Grafana Cloud

  1. Configure your Grafana Cloud stack’s SSO integration against the same OIDC provider, so the signed-in user’s identity is available for Grafana Cloud to exchange for a Google Cloud access token before the request reaches the plugin. Refer to Configure OAuth2 authentication for setup details.

In the data source configuration

  1. Open the BigQuery data source settings and select Workload Identity Federation as the authentication type.

  2. In the Workload Identity Pool Provider field, enter the full resource path of your provider: projects/<project-number>/locations/global/workloadIdentityPools/<pool-id>/providers/<provider-id>

    Note

    Use the project number (a numeric ID such as 123456789), not the project ID (such as my-project). You can find the project number on the Google Cloud Console home page.

  3. If you set up service account impersonation, enter the service account email in the Service account email field. If you granted permissions directly to the WIF pool, leave this blank.

  4. Enter the Default project where your BigQuery queries will run.

Note

Credentials from Workload Identity Federation are tied to the signed-in user’s active session — there is no long-lived credential available to the Grafana backend. This means any feature that runs without a user present will not work, including alerting, scheduled reports, and public dashboards. If you rely on these features, use a service account key (JWT) instead.

Forward OAuth Identity

Use Forward OAuth Identity when you want to use Grafana’s Google OAuth authentication with BigQuery.

To configure Forward OAuth Identity:

  1. Configure Google OAuth authentication in Grafana.
  2. Add the following scopes to the OAuth application:
    • https://www.googleapis.com/auth/bigquery (required)
    • https://www.googleapis.com/auth/drive (optional, for querying Google Sheets data)
  3. In the data source configuration, select Forward OAuth Identity as the authentication type.
  4. Enter the Default project where queries run.

Note

Credentials from Forward OAuth Identity are tied to the signed-in user’s active session — there is no long-lived credential available to the Grafana backend. This means any feature that runs without a user present will not work, including alerting, scheduled reports, and public dashboards. If you rely on these features, use a service account key (JWT) instead.

Additional settings

Expand the Additional Settings section to configure optional settings.

SettingDescription
Processing locationSpecifies the geographic location where BigQuery processes queries. Options include multi-regional locations (US, EU) and specific regions. Leave empty for automatic location selection.
Service endpointCustom network address for the BigQuery API. Use this when connecting through a private endpoint or VPC Service Controls. Example: https://bigquery.googleapis.com/bigquery/v2/
Max bytes billedLimits the bytes billed for a query. Queries that would exceed this limit fail instead of running. Use this to prevent unexpectedly expensive queries. Example: 5242880 (5 MB).

Verify the connection

Click Save & test to verify the connection. A successful test displays the message “Data source is working”. If you encounter errors, refer to Troubleshooting.

Provision the data source

You can define the data source in YAML files as part of the Grafana provisioning system. For more information, refer to Provisioning Grafana data sources.

Service account key with private key in secure JSON

YAML 
apiVersion: 1
datasources:
  - name: BigQuery
    type: grafana-bigquery-datasource
    editable: true
    enabled: true
    jsonData:
      authenticationType: jwt
      clientEmail: <SERVICE_ACCOUNT_EMAIL>
      defaultProject: <DEFAULT_PROJECT_ID>
      tokenUri: https://oauth2.googleapis.com/token
    secureJsonData:
      privateKey: <PRIVATE_KEY>

Service account key with private key path

YAML 
apiVersion: 1
datasources:
  - name: BigQuery
    type: grafana-bigquery-datasource
    editable: true
    enabled: true
    jsonData:
      authenticationType: jwt
      clientEmail: <SERVICE_ACCOUNT_EMAIL>
      defaultProject: <DEFAULT_PROJECT_ID>
      tokenUri: https://oauth2.googleapis.com/token
      privateKeyPath: '/etc/secrets/bigquery.pem'

Google Metadata Server

YAML 
apiVersion: 1
datasources:
  - name: BigQuery
    type: grafana-bigquery-datasource
    editable: true
    enabled: true
    jsonData:
      authenticationType: gce

Google Metadata Server with service account impersonation

YAML 
apiVersion: 1
datasources:
  - name: BigQuery
    type: grafana-bigquery-datasource
    editable: true
    enabled: true
    jsonData:
      authenticationType: gce
      usingImpersonation: true
      serviceAccountToImpersonate: <SERVICE_ACCOUNT_EMAIL>
      defaultProject: <DEFAULT_PROJECT_ID>

Workload Identity Federation

Available on Grafana Cloud only.

YAML 
apiVersion: 1
datasources:
  - name: BigQuery
    type: grafana-bigquery-datasource
    editable: true
    enabled: true
    jsonData:
      authenticationType: workloadIdentityFederation
      workloadIdentityPoolProvider: projects/<PROJECT_NUMBER>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>
      wifServiceAccountEmail: <SERVICE_ACCOUNT_EMAIL> # optional
      defaultProject: <DEFAULT_PROJECT_ID>

Forward OAuth Identity

YAML 
apiVersion: 1
datasources:
  - name: BigQuery
    type: grafana-bigquery-datasource
    editable: true
    enabled: true
    jsonData:
      authenticationType: forwardOAuthIdentity
      defaultProject: <DEFAULT_PROJECT_ID>
      oauthPassThru: true

With additional settings

YAML 
apiVersion: 1
datasources:
  - name: BigQuery
    type: grafana-bigquery-datasource
    editable: true
    enabled: true
    jsonData:
      authenticationType: jwt
      clientEmail: <SERVICE_ACCOUNT_EMAIL>
      defaultProject: <DEFAULT_PROJECT_ID>
      tokenUri: https://oauth2.googleapis.com/token
      processingLocation: US
      MaxBytesBilled: 5242880
      serviceEndpoint: https://bigquery.googleapis.com/bigquery/v2/
    secureJsonData:
      privateKey: <PRIVATE_KEY>

Provisioning configuration reference

KeyTypeDescription
authenticationTypestringAuthentication method: jwt, gce, workloadIdentityFederation, or forwardOAuthIdentity
clientEmailstringService account email (required for jwt)
defaultProjectstringDefault GCP project for queries
tokenUristringOAuth token endpoint (required for jwt): https://oauth2.googleapis.com/token
privateKeyPathstringPath to private key file (alternative to secureJsonData.privateKey)
usingImpersonationbooleanEnable service account impersonation
serviceAccountToImpersonatestringEmail of service account to impersonate
workloadIdentityPoolProviderstringWIF provider resource path (required for workloadIdentityFederation, Grafana Cloud only)
wifServiceAccountEmailstringService account to impersonate via WIF (optional, Grafana Cloud only)
oauthPassThrubooleanEnable OAuth pass-through (required for forwardOAuthIdentity)
processingLocationstringQuery processing location (for example, US, EU, us-central1)
MaxBytesBilledintegerMaximum bytes billed per query
serviceEndpointstringCustom BigQuery API endpoint URL
enableSecureSocksProxybooleanEnable Secure Socks Proxy (requires Grafana configuration)
Secure KeyTypeDescription
privateKeystringService account private key (PEM format)

Provision with Terraform

You can provision the data source using the Grafana Terraform provider.

Service account key

hcl 
resource "grafana_data_source" "bigquery" {
  type = "grafana-bigquery-datasource"
  name = "BigQuery"

  json_data_encoded = jsonencode({
    authenticationType = "jwt"
    clientEmail        = "<SERVICE_ACCOUNT_EMAIL>"
    defaultProject     = "<DEFAULT_PROJECT_ID>"
    tokenUri           = "https://oauth2.googleapis.com/token"
  })

  secure_json_data_encoded = jsonencode({
    privateKey = file("path/to/service-account-key.pem")
  })
}

Google Metadata Server

hcl 
resource "grafana_data_source" "bigquery" {
  type = "grafana-bigquery-datasource"
  name = "BigQuery"

  json_data_encoded = jsonencode({
    authenticationType = "gce"
  })
}

With service account impersonation

hcl 
resource "grafana_data_source" "bigquery" {
  type = "grafana-bigquery-datasource"
  name = "BigQuery"

  json_data_encoded = jsonencode({
    authenticationType          = "gce"
    usingImpersonation          = true
    serviceAccountToImpersonate = "<SERVICE_ACCOUNT_EMAIL>"
    defaultProject              = "<DEFAULT_PROJECT_ID>"
  })
}

Workload Identity Federation

Available on Grafana Cloud only.

hcl 
resource "grafana_data_source" "bigquery" {
  type = "grafana-bigquery-datasource"
  name = "BigQuery"

  json_data_encoded = jsonencode({
    authenticationType           = "workloadIdentityFederation"
    workloadIdentityPoolProvider = "projects/<PROJECT_NUMBER>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>"
    wifServiceAccountEmail       = "<SERVICE_ACCOUNT_EMAIL>" # optional
    defaultProject               = "<DEFAULT_PROJECT_ID>"
  })
}

With additional settings

hcl 
resource "grafana_data_source" "bigquery" {
  type = "grafana-bigquery-datasource"
  name = "BigQuery"

  json_data_encoded = jsonencode({
    authenticationType = "jwt"
    clientEmail        = "<SERVICE_ACCOUNT_EMAIL>"
    defaultProject     = "<DEFAULT_PROJECT_ID>"
    tokenUri           = "https://oauth2.googleapis.com/token"
    processingLocation = "US"
    MaxBytesBilled     = 5242880
    serviceEndpoint    = "https://bigquery.googleapis.com/bigquery/v2/"
  })

  secure_json_data_encoded = jsonencode({
    privateKey = var.bigquery_private_key
  })
}

For more information, refer to the Grafana Terraform provider documentation.

Import queries from DoiT International BigQuery plugin

If you previously used the DoiT International BigQuery community plugin, you can import your existing queries into the Grafana BigQuery data source.

To import queries:

  1. Open the dashboard containing queries from the DoiT International plugin.
  2. Edit each panel and change the data source to Grafana BigQuery.
  3. Save the dashboard.

Note

Imported queries are converted to raw SQL queries.