Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doitintl/bigquery-grafana
Google BigQuery Datasource Plugin for Grafana. (NO LONGER MAINTAINED)
https://github.com/doitintl/bigquery-grafana
bigquery bigquery-datasource google-bigquery google-cloud-platform grafana grafana-bigquery grafana-bigquery-datasource grafana-datasource metrics monitoring typescript
Last synced: about 16 hours ago
JSON representation
Google BigQuery Datasource Plugin for Grafana. (NO LONGER MAINTAINED)
- Host: GitHub
- URL: https://github.com/doitintl/bigquery-grafana
- Owner: doitintl
- License: mit
- Archived: true
- Created: 2019-02-21T12:43:41.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-08T13:58:01.000Z (over 2 years ago)
- Last Synced: 2024-09-25T23:03:21.248Z (4 months ago)
- Topics: bigquery, bigquery-datasource, google-bigquery, google-cloud-platform, grafana, grafana-bigquery, grafana-bigquery-datasource, grafana-datasource, metrics, monitoring, typescript
- Language: TypeScript
- Homepage: https://www.doit-intl.com/labs/
- Size: 280 MB
- Stars: 242
- Watchers: 19
- Forks: 76
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
### We have retired the [DoiT International BigQuery DataSource plugin](https://grafana.com/grafana/plugins/doitintl-bigquery-datasource/) for Grafana, ceased all development, and put maintenance on indefinite hold. We recommend you migrate to the official [Google BigQuery data source](https://grafana.com/grafana/plugins/grafana-bigquery-datasource/) maintained by Grafana.
---
[](https://github.com/doitintl/bigquery-grafana/stargazers)
[](https://github-tools.github.io/github-release-notes/)
# BigQuery DataSource for Grafana
A production-ready BigQuery DataSource plugin that provides support for [BigQuery](https://cloud.google.com/bigquery/) as a backend database.
### Quick Start
There are multiple ways to install bigquery-grafana. See [INSTALL](https://doitintl.github.io/bigquery-grafana/INSTALL) for more information.
### Features:
- Query setup
- Raw SQL editor
- Query builder
- Macros support
- Additional functions
- Table view
- Annotations
- BQ queries in variables
- Sharded tables (`tablename_YYYYMMDD`)
- Partitioned Tables
- Granular slot allocation (Running queries in a project with flat-rate pricing)
**Plugin Demo:**
## Adding the DataSource to Grafana
1. Open the side menu by clicking the Grafana icon in the top header.
2. In the side menu under `Dashboards` you should find a link named `Data Sources`.
3. Click the `+ Add data source` button in the top header.
4. Select `BigQuery` from the _Type_ dropdown.
5. Upload or paste in the Service Account Key file. See below for steps on how to create a Service Account Key file.
> NOTE: If you're not seeing the `Data Sources` link in your side menu it means that your current user does not have the `Admin` role for the current organization.
| Name | Description |
| --------------------- | ----------------------------------------------------------------------------------- |
| _Name_ | The datasource name. This is how you refer to the datasource in panels & queries. |
| _Default_ | Default datasource means that it will be pre-selected for new panels. |
| _Service Account Key_ | Service Account Key File for a GCP Project. Instructions below on how to create it. |
### Set query priority
You can now set query priority "INTERACTIVE" or "BATCH" per datasouce
### Example of Provisioning a File
You can manage DataSource via [provisioning system](https://grafana.com/docs/administration/provisioning/#datasources). See the example below of a configuration file.
```
apiVersion: 1
datasources:
- name:
type: doitintl-bigquery-datasource
access: proxy
isDefault: true
jsonData:
authenticationType: jwt
clientEmail:
defaultProject:
tokenUri: https://oauth2.googleapis.com/token
secureJsonData:
privateKey: |
-----BEGIN PRIVATE KEY-----
-----END PRIVATE KEY-----
version: 2
readOnly: false
```
## Authentication
There are two ways to authenticate the BigQuery plugin - either by uploading a Google JWT file, or by automatically retrieving credentials from Google's metadata server. The latter is only available when running Grafana on a GCE virtual machine.
### Using a Google Service Account Key File
To authenticate with the BigQuery API, you need to create a Google Cloud Platform (GCP) Service Account for the Project you want to show data for. A Grafana datasource integrates with one GCP Project. If you want to visualize data from multiple GCP Projects then you can give the service account permissions in each project or create one datasource per GCP Project.
#### Enable APIs
Go to [BigQuery API](https://console.cloud.google.com/apis/library/bigquery.googleapis.com) and `Enable` the API:
#### Create a GCP Service Account for a Project
1. Navigate to the [APIs & Services Credentials page](https://console.cloud.google.com/apis/credentials).
2. Click on `Create credentials` and choose `Service account key`.
3. On the `Create service account key` page, choose key type `JSON`. Then in the `Service Account` dropdown, choose the `New service account` option:
4. Some new fields will appear. Fill in a name for the service account in the `Service account name` field and then choose the `BigQuery Data Viewer` and `BigQuery Job User` roles from the `Role` dropdown:
5. Click the `Create` button. A JSON key file will be created and downloaded to your computer. Store this file in a secure place as it allows access to your BigQuery data.
6. Upload it to Grafana on the datasource Configuration page. You can either upload the file or paste in the contents of the file.
7. The file contents will be encrypted and saved in the Grafana database. Don't forget to save after uploading the file!
### Using GCE Default Service Account
If Grafana is running on a Google Compute Engine (GCE) virtual machine, it is possible for Grafana to automatically retrieve default credentials from the metadata server. This has the advantage of not needing to generate a private key file for the service account and also not having to upload the file to Grafana. However for this to work, there are a few preconditions that need to be met.
1. First of all, you need to create a Service Account that can be used by the GCE virtual machine. See detailed instructions on how to do that [here](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances#createanewserviceaccount).
2. Make sure the GCE virtual machine instance is being run as the service account that you just created. See instructions [here](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances#using).
3. Allow access to the `BigQuery API` scope. See instructions [here](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances#changeserviceaccountandscopes).
Read more about creating and enabling service accounts for GCE VM instances [here](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances).
### Using the Query Builder
The query builder provides a simple yet a user-friendly interface to help you quickly compose a query. The builder enables you to define the basic parts of your query, The common ones are:
1. The table you want to query from
2. The time field and metric field
3. WHERE clause - Either use one of the pre-defined macros, to speed your writing time, or set up your own expression. Existing supported Macros are:
a. Macro $__timeFiler with last 7 days example:
```
WHERE `createDate` BETWEEN TIMESTAMP_MILLIS (1592147699012) AND TIMESTAMP_MILLIS (1592752499012) AND _PARTITIONTIME >= '2020-06-14 18:14:59' AND _PARTITIONTIME < '2020-06-21 18:14:59'
```
b. Macro $__timeFrom with last 7 days example:
```
WHERE `createDate` > TIMESTAMP_MILLIS (1592223758609) AND _PARTITIONTIME >= '2020-06-15 15:22:38' AND _PARTITIONTIME < '2020-06-22 15:22:38'
```
c. Macro $__timeTo with last 7 days example:
```
WHERE `createDate` < TIMESTAMP_MILLIS (1592828659681) AND _PARTITIONTIME >= '2020-06-15 15:24:19' AND _PARTITIONTIME < '2020-06-22 15:24:19'
```
You can now use timeFilter macro in raw sql mode
4. GROUP BY option - You can use a pre-defined macro or use one of the fields from your query
a. time ($__interval,none)
5. ORDER BY option
Note: If your processing location is not the Default US one set your location from the processing Location drop-down at the top right bottom of the query builder
### Troubleshooting
Viewing your Query
1. Use The Query Inspector located at the top of the query builder
2. The query Inspector enables you to see the clean query and troubleshoot SQL errors
The Query builder comes with a set of defaults which are control from the top of the Query Builder
### Build
The build works with Yarn:
#### Development Build
```
yarn run build:dev
```
#### Production Build
```
yarn run build:prod
```
Tests can be run with Jest:
```
yarn run test
```
## Contributing
See the [CONTRIBUTING](https://doitintl.github.io/bigquery-grafana/CONTRIBUTING) file.
## License
See the [LICENSE](https://doitintl.github.io/bigquery-grafana/LICENSE) file.