grafana / grafana/google-bigquery-datasource

Plugin should notify user if IAM permissions are missing for Storage API

Open
#463 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
40
Forks
24
Avg merge
3d 21h
Merged PRs (30d)
8

Description

Hi, we were recently debugging why our BigQuery queries that return a few hundred megabytes of data were so slow (>15s) despite having the "Use Storage API" option ticked (#341). It turns out that the plugin fails open for these queries when they lack the IAM permission to use the Storage API, falling back to the standard query API, with no indication of this happening to the user. To a user, it looks like even with Storage API seemingly enabled, queries take a long time.

In our case, the IAM user that the plugin was using in our GCP project had the "BigQuery Job User" role but not the "BigQuery Read Session User" role, which is noted as required on https://docs.cloud.google.com/bigquery/docs/reference/storage. This should probably be mentioned in the documentation on https://grafana.com/docs/plugins/grafana-bigquery-datasource/latest/query-editor/#storage-api, and it may be sensible to include an error or warning message if this option is checked for a query despite missing IAM perms.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.