Google BigQuery BI Engine Metrics via Telegraf

Google BI Engine stands as a unique collection of services nestled within Google Cloud. It is meticulously designed for the creation, deployment, and management of business intelligence systems, promoting secure and effective interaction between various software elements in a cloud-based ecosystem.

• Begin by heading over to the 'Project Selector' and select the specific project from which you wish to send metrics.
• Progress to the 'Service Account Details' screen. Here, assign a distinct name to your service account and opt for 'Create and Continue'.
• In the 'Grant This Service Account Access to Project' screen, ensure the following roles: 'Compute Viewer', 'Monitoring Viewer', and 'Cloud Asset Viewer'.
• Upon completion of the above, click 'Done'.
• Now find and select your project in the 'Service Accounts for Project' list.
• Move to the 'KEYS' section.
• Navigate through Keys > Add Key > Create New Key, and specify 'JSON' as the key type.
• Lastly, click on 'Create', and make sure to save your new key.

Now add the environment variable for the key

On the machine run:

export GOOGLE_APPLICATION_CREDENTIALS=<your-gcp-key>

This integration allows you to configure a Telegraf agent to send your metrics, in multiple formats, to Logit.io.

Telegraf is a flexible server agent equipped with plug-in support, useful for sending metrics and events from data sources like web servers, APIs, application logs, and cloud services.

To ship your metrics to Logit.io, we will integrate the relevant input and outputs.http plug-in into your Telegraf configuration file.

Choose the install for your operating system below to get started:

Windows

wget https://dl.influxdata.com/telegraf/releases/telegraf-1.19.2_windows_amd64.zip

Download and extract to: C:\Program Files\Logitio\telegraf\

Configuration file: C:\Program Files\Logitio\telegraf\

MacOS

brew install telegraf

Configuration file x86_64 Intel: /usr/local/etc/telegraf.conf Configuration file ARM (Apple Silicon): /opt/homebrew/etc/telegraf.conf

Ubuntu/Debian

wget -q https://repos.influxdata.com/influxdata-archive_compat.key
echo '393e8779c89ac8d958f81f942f9ad7fb82a25e133faddaf92e15b16e6ac9ce4c influxdata-archive_compat.key' | sha256sum -c && cat influxdata-archive_compat.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg > /dev/null
echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg] https://repos.influxdata.com/debian stable main' | sudo tee /etc/apt/sources.list.d/influxdata.list

sudo apt-get update
sudo apt-get install telegraf

Configuration file: /etc/telegraf/telegraf.conf

RedHat and CentOS

cat <<EOF | sudo tee /etc/yum.repos.d/influxdata.repo
[influxdata]
name = InfluxData Repository - Stable
baseurl = https://repos.influxdata.com/stable/\$basearch/main
enabled = 1
gpgcheck = 1
gpgkey = https://repos.influxdata.com/influxdata-archive_compat.key
EOF

sudo yum install telegraf

Configuration file: /etc/telegraf/telegraf.conf

SLES & openSUSE

zypper ar -f obs://devel:languages:go/ go
zypper in telegraf

Configuration file: /etc/telegraf/telegraf.conf

FreeBSD/PC-BSD

sudo pkg install telegraf

Configuration file: /etc/telegraf/telegraf.conf

Read more about how to configure data scraping and configuration options for Telegraf

First you need to set up the input plug-in to enable Telegraf to scrape the GCP data from your hosts. This can be accomplished by incorporating the following code into your configuration file:

# Gather timeseries from Google Cloud Platform v3 monitoring API
[[inputs.stackdriver]]
  ## GCP Project
  project = "<your-project-name>"

  ## Include timeseries that start with the given metric type.
  metric_type_prefix_include = [
    "bigquerybiengine.googleapis.com",
  ]

  ## Most metrics are updated no more than once per minute; it is recommended
  ## to override the agent level interval with a value of 1m or greater.
  interval = "1m"

Read more about how to configure data scraping and configuration options for Stackdriver

Once you have generated the configuration file, you need to set up the output plug-in to allow Telegraf to transmit your data to Logit.io in Prometheus format. This can be accomplished by incorporating the following code into your configuration file:

[[outputs.http]]
  
  url = "https://<your-metrics-username>:<your-metrics-password>@<your-metrics-stack-id>-vm.logit.io:0/api/v1/write"
  data_format = "prometheusremotewrite"

  [outputs.http.headers]
    Content-Type = "application/x-protobuf"
    Content-Encoding = "snappy"

Windows

telegraf.exe --service start

MacOS

telegraf --config telegraf.conf

Linux

sudo service telegraf start

for systemd installations

systemctl start telegraf

Data should now have been sent to your Stack.

View my data

If you don't see metrics take a look at How to diagnose no data in Stack below for how to diagnose common issues.

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.

For efficient monitoring and insightful examination of Google BI Engine metrics across distributed systems, the indispensability of a robust and capable metrics management solution is considerable. A fitting option for this role is Telegraf, an open-source server agent known for its ability to gather and report metrics from Google BI Engine and a myriad of other sources, such as active system instances, databases, and corresponding applications.

Telegraf possesses an extensive range of input plugins, allowing users to collect important metrics such as query counts, latency, error rates, and more. These metrics are crucial for understanding the performance of the Google BI Engine. For storing and analyzing these gathered metrics, organizations can employ Prometheus, a highly respected open-source monitoring and alerting toolkit, acclaimed for its adaptable query language and strong data visualization capabilities.

Transmitting Google BI Engine metrics from Telegraf to Prometheus involves setting up Telegraf to produce metrics in Prometheus's format, followed by arranging Prometheus to scrape these metrics from the Telegraf server.

Once the metrics are successfully integrated into Prometheus, further comprehensive analysis and visualization can be carried out using Grafana. Grafana, a prime open-source platform renowned for its monitoring and observability features, integrates effortlessly with Prometheus. It allows users to create dynamic, interactive dashboards for an in-depth look into the metrics data, providing a thorough understanding of performance patterns and potential issues within Google BI Engine.

If you need any further assistance with shipping your log data to Logit.io 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.