Introduction to Cloud SQL Insights

Cloud SQL Query Insights helps you detect, diagnose, and prevent query performance problems for Cloud SQL databases. It provides self-service, intuitive monitoring, and diagnostic information that goes beyond detection to help you to identify the root cause of performance problems.

In this codelab, you will learn how to set up a Cloud SQL for PostgreSQL instance, deploy a Node.js app to use the Cloud SQL instance as its backend storage, and then use Cloud SQL Insights to view and monitor queries.

Prerequisites

  • Basic familiarity with Node.js programming language and tools

What you'll do

  • Use Cloud SQL in a Node.js app.
  • Enable SQL Commenter in a Node.js app.
  • Use Cloud SQL Insights to monitor and investigate query performance.

What you'll need

  • A Google Cloud account where you have permissions to enable APIs and create services

Self-paced environment setup

  1. Sign in to Cloud Console and create a new project or reuse an existing one. (If you don't already have a Gmail or Google Workspace account, you must create one.)

Remember the project ID for the project you are using. It will be referred to later in this codelab as PROJECT-ID.

  1. Next, you'll need to enable billing in Cloud Console in order to use Google Cloud resources.

Running through this codelab shouldn't cost much, if anything at all. Be sure to to follow any instructions in the "Clean Up and Learn More" section, which advises you how to shut down resources so you don't incur billing beyond this tutorial. New users of Google Cloud are eligible for the $300USD Free Trial program.

Activate Cloud Shell

  1. From the Cloud Console, click Activate Cloud Shell.

activate cloud shell

If you've never started Cloud Shell before, you'll be presented with an intermediate screen (below the fold) describing what it is. If that's the case, click Continue (and you won't ever see it again). Here's what that one-time screen looks like:

cloud shell dialog window

It should only take a few moments to provision and connect to Cloud Shell.

cloud shell terminal

This virtual machine is loaded with all the development tools you'll need. It offers a persistent 5GB home directory and runs in Google Cloud, greatly enhancing network performance and authentication.

  1. Run the following command in Cloud Shell to confirm that you are using the correct project:

Once connected to Cloud Shell, you should see that you are already authenticated and that the project is already set to your project ID.

Run the following command to confirm that you are using the correct project.

gcloud config list project

If you want to use a different project than the one you had selected when you opened Cloud Shell, you can set a new one by running:

gcloud config set project <PROJECT-ID>;
  1. After Cloud Shell launches, you can use the command line to create a new Cloud SQL instance named my-instance, with Cloud SQL Insights enabled:
gcloud sql instances create my-instance --tier db-f1-micro --database-version=POSTGRES_12 --region=us-central --root-password=<PASSWORD> --insights-config-query-insights-enabled --insights-config-record-application-tags --insights-config-record-client-address

Here's a brief explanation of the flags and what they mean:

  • The --tier db-f1-micro flag is specifying a machine type with minimal resources, since this is for development purposes, and you don't need a lot of resources for the codelab. You can learn more about tiers here.
  • The --database-version=POSTGRES_12 flag creates an instance that will be PostgreSQL version 12.
  • The --region=us-central flag specifies the region where the instance will be created.
  • The --root-password=<PASSWORD> flag allows you to specify the password for the root postgres user. Be sure to replace <PASSWORD> with a password of your choice.
  • The --insights-config-query-insights-enabled flag enables Cloud SQL Insights on your instance.
  • The --insights-config-record-application-tags flag allows application tags to be recorded. You'll learn more about application tags in later sections.
  • The --insights-config-record-client-address flag allows client IP addresses to be recorded by Cloud SQL Insights.

You may be prompted to enable the API sqladmin.googleapis.com for your project. If you are prompted, select y to enable the API.

Creating the instance will take several minutes. Once this operation completes, your instance will be ready to use.

  1. Now create a database that you will use for the sample app:
gcloud sql databases create votesdb --instance my-instance

You can also access and configure the instance via the Cloud Console.

  1. Get the instance connection name in the format PROJECT-ID:ZONE-ID:INSTANCE-ID by running the following command. You will use this later in configuring your Node.js app.
gcloud sql instances describe my-instance | grep connectionName

Service accounts are used to grant permissions to use different services within your GCP project. For this codelab, you need one in order to grant the Cloud SQL Proxy permission to connect to your Cloud SQL instance.

Create a service account in the Console

  1. Go to the IAM service accounts page and click the -PCvKR3aQ2zKaUcml8w9lW4JNlmYtN5-r2--mC6kMUp6HOXW8wT1wUvLoYEPU-aA-oGskT3XkAqfNwRAKkZkllwTe6ugdrUVFwaeKT0M9Y1RwHA8JPZeGmCWYBfr8d9TSycNMIRsLw button at the top of the page.
  2. Give your service account a unique name and ID and click CREATE.
  3. On the next page, click the drop-down for Select a role. Filter for "Cloud SQL" and select the Cloud SQL Client role. Click CONTINUE and then click DONE.
  4. After the service account has been created, click the three dots under Actions for your new service account and choose Manage keys. On the next page, select ADD KEY and then Create new key. JSON will be selected; keep that default, and click CREATE. This will download a .json private key file. Click CLOSE.
  5. In Cloud Shell, click the three dots for the More menu and choose Upload File. Browse to the .json file you downloaded on your local machine and select it. This will upload the .json file to your home directory in Cloud Shell.

You will use the Cloud SQL Proxy for communication between the application and the database instance.

  1. Download the Cloud SQL proxy. In Cloud Shell, you can run:
wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 -O cloud_sql_proxy && chmod +x cloud_sql_proxy
  1. To run the proxy, use the instance connection name you copied from the Cloud SQL instance details to replace <INSTANCE_CONNECTION_NAME>. For the credential file, enter the path to the file that you uploaded in the last step.
./cloud_sql_proxy -credential_file=/path/to/credential_file.json -instances=<INSTANCE_CONNECTION_NAME>=tcp:5432 &

If this is successful, you should see a few lines of output, ending with a Ready for new connections message.

  1. Clone the repo for the sample application, and install the packages necessary to run the app.
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples/

cd nodejs-docs-samples/cloud-sql/postgres/knex

npm install
  1. Set the following environment variables:
export CLOUD_SQL_CONNECTION_NAME='<PROJECT-ID>:<ZONE-ID>:<INSTANCE-ID>'
export DB_HOST='127.0.0.1:5432'
export DB_USER='postgres'
export DB_PASS='<PASSWORD>'
export DB_NAME='votesdb'
  1. Run createTable.js to create the database table that app requires and ensure that the database is properly configured and then start the sample app.
node createTable.js $DB_USER $DB_PASS $DB_NAME $CLOUD_SQL_CONNECTION_NAME votes $DB_HOST

npm start
  1. Click Web Preview web preview icon in Cloud Shell, then select Preview on port 8080.

Preview on port 8080 menu item

You should see the Tabs vs Spaces voting app as shown here in your browser:

Tabs vs Spaces voting app screenshot

  1. Click the buttons to make some votes and save some data in the database.

Since this sample application is very simple, you will add an additional page that displays all votes. The primary reason for doing this is so you have more data to look at when you use Cloud SQL Insights later.

  1. Enter Ctrl+c in your Cloud Shell to stop the sample app.
  2. In Cloud Shell, click the Open Editor button button to launch the Cloud Shell Editor.
  3. In the file explorer, find nodejs-docs-samples/cloud-sql/postgres/knex/server.js and click on it to load the server.js file in the editor.

Add the following code after where the getVotes function is defined:

/**
 * Retrieve all vote records from the database.
 *
 * @param {object} pool The Knex connection object.
 * @returns {Promise}
 */
const getAllVotes = async pool => {
  return await pool
    .select('candidate', 'time_cast')
    .from('votes')
    .orderBy('time_cast', 'desc');
};
  1. Add the following code for the '/getAllVotes' route below where the other routes are defined:
app.get('/getAllVotes', async (req, res) => {
  pool = pool || createPool();
  try {
    // Query all votes from the database.
    const votes = await getAllVotes(pool);

    res.render('allvotes.pug', {
      votes: votes,
    });
  } catch (err) {
    console.error(err);
    res
      .status(500)
      .send('Unable to load page; see logs for more details.')
      .end();
  }
});
  1. Create a new file in the nodejs-docs-samples/cloud-sql/postgres/knex/views directory named allvotes.pug. Paste in the following code:
doctype html
html(lang="en")
  head
    title Tabs VS Spaces

    link(rel="stylesheet", href="https://cdnjs.cloudflare.com/ajax/libs/materialize/1.0.0/css/materialize.min.css")
    link(rel="stylesheet", href="https://fonts.googleapis.com/icon?family=Material+Icons")
    script(src="https://cdnjs.cloudflare.com/ajax/libs/materialize/1.0.0/js/materialize.min.js")
  body

    nav(class="red lighten-1")
      div(class="nav-wrapper")
        a(href="#" class="brand-logo center") Tabs VS Spaces

    div(class="section")

      h4(class="header center") Recent Votes
      ul(class="container collection center")
        each vote in votes
          li(class="collection-item avatar")
            if vote.candidate.trim() === 'TABS'
              i(class="material-icons circle green") keyboard_tab
            else
              i(class="material-icons circle blue") space_bar
            span(class="title") A vote for <b>#{vote.candidate}</b>
            p was cast at #{vote.time_cast}.
  1. Click the Open Terminal button button to return to Cloud Shell and run:
npm start
  1. Open the app from Web Preview to make sure it's working. Add /getAllVotes on the URL in the browser to view the new page you added.

Now you'll install and enable SQL Commenter, an open-source library that enables ORMs to augment SQL statements with comments before execution. SQLcommenter supports several ORMs and frameworks, including the one the sample app uses: Knex.js. Cloud SQL Insights uses the information in these comments to give an application-centric view into database performance and identify which application code is causing problems. The performance overhead is expected to be small, and you can find more information about performance in the documentation.

  1. Enter Ctrl+c in your Cloud Shell to stop the sample app.
  2. Run the following command to install the packages that SQLcommenter needs:
  npm install @google-cloud/sqlcommenter-knex @opencensus/nodejs @opencensus/propagation-tracecontext @opentelemetry/api @opentelemetry/core --save
  1. In Cloud Shell, click the Open Editor button button to launch the Cloud Shell Editor.
  2. In the file explorer, find nodejs-docs-samples/cloud-sql/postgres/knex/server.js and click on it to load the server.js file in the editor.
  3. Find this code in the file:
const process = require('process');

Below it, add the following code:

const {wrapMainKnexAsMiddleware} = require('@google-cloud/sqlcommenter-knex');
  1. Find this code in the file:
// Set Content-Type for all responses for these routes.
app.use((req, res, next) => {
  res.set('Content-Type', 'text/html');
  next();
});

Below it, add the following code:

app.use(wrapMainKnexAsMiddleware(Knex, {
    traceparent: true,
    tracestate: true,
    route: true,
    db_driver: true
}));

Once this is done, your code should look something like this:

...
// Require process, so we can mock environment variables.
const process = require('process');

const {wrapMainKnexAsMiddleware} = require('@google-cloud/sqlcommenter-knex');
const express = require('express');
const bodyParser = require('body-parser');
const Knex = require('knex');

const app = express();
app.set('view engine', 'pug');
app.enable('trust proxy');

// Automatically parse request body as form data.
app.use(bodyParser.urlencoded({extended: false}));
app.use(bodyParser.json());

// Set Content-Type for all responses for these routes.
app.use((req, res, next) => {
  res.set('Content-Type', 'text/html');
  next();
});

app.use(wrapMainKnexAsMiddleware(Knex, {
    traceparent: true,
    tracestate: true,
    route: true,
    db_driver: true
}));
...
  1. Click the Open Terminal button button to return to Cloud Shell and run:
npm start
  1. In the Tabs vs Spaces application, click the buttons to cast some more votes to add more data to the database.

The Query Insights dashboard helps you troubleshoot Cloud SQL queries to look for performance issues. To access Insights, select Query insights in the left navigation for your Cloud SQL instance.

Database load - all queries graph

The top-level Query Insights dashboard shows the Database load - all queries graph.

All Queries graph

The graph contains information for CPU Capacity, CPU and CPU wait, IO Wait, and Lock Wait. You can learn more about what these metrics mean, where metrics are stored, and see some examples of what this graph looks like for problematic queries in the documentation. In the case of this sample application the database query load is low, so there are not any large spikes on the graph.

Which queries are responsible for the most load?

Below the graph, you will find the QUERIES table that contains the normalized queries for the time range you selected. The queries in the table are sorted by the total execution time.

Top Queries table

You can click into an individual query to view detailed information about the query, such as database load for this specific query, query latency, query plan samples, and top users. If an application is built using an ORM, as is the case for the sample application, you may not know which part of the application is responsible for which query. The Top Tags section can help you figure that out.

Where is the query load originating in the application?

Toggle from the QUERIES table to the TAGS table to see a list of queries tagged by business logic, giving you a more application centric view.

Top Tags table

In the TAGS table, you can see the database load broken out by which route generated the load. In the screenshot above, you can see that the '/getAllVotes' route has a higher average execution time and has more rows returned on average. While the execution time we see in the table is not problematic in this case, let's click the row for '/getAllVotes' anyway to look at the data in more detail.

Why are queries running slowly?

Click on the dot in the Query plan samples graph to see a query plan.

Sample query plans

The query plans show how PostgreSQL executes a query under the covers, making it easier to determine if there are operations that result in slowness.

Which application code is contributing to slowness?

Cloud SQL Insights also has in-context visualization of end-to-end tracing, which can be helpful for doing further investigation into what parts of an application are generating slow queries.

Click the END TO END tab to view an in-context trace.

End to end trace

You learned how to use Cloud SQL Insights to monitor and investigate query performance with a Node.js app and a Cloud SQL PostgreSQL database!

Cleaning Up

If you don't want to keep your Cloud SQL instance running, you can delete it now.

gcloud sql instances delete my-instance

Learn More