Query Sentry Data through ODBC in Node.js

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use node-odbc to execute SQL queries against Sentry data from Node.js.

Node.js is a JavaScript runtime environment that allows you to run JavaScript code outside of a browser. With the CData API Driver for ODBC, you can access live Sentry data from Node.js apps and scripts. In this article, we walk through installing node-odbc and the required tools to create a simple Node.js app with access to live Sentry data.

With built-in optimized data processing, the CData ODBC Driver offers unmatched performance for interacting with live Sentry data in Node.js. When you issue complex SQL queries from Node.js to Sentry, the driver pushes supported SQL operations, like filters and aggregations, directly to Sentry and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Sentry Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

Using API Key Authentication

Sentry uses token-based authentication. To obtain an Auth Token:

  1. Log in to your Sentry account at https://sentry.io
  2. Navigate to Settings > Auth Tokens
  3. Click "Create New Token"
  4. Select the required scopes and click "Create Token"
  5. Copy the generated token (it will only be shown once)

After obtaining your Auth Token, set the following connection properties:

  • AuthScheme: Set this to APIKey.
Set the following in the ProfileSettings connection property:
  • APIKey: Set this to your Sentry Auth Token.
  • OrganizationId: Set this to your Sentry organization slug or ID.

Example Connection String

Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";

Connecting to Sentry

Once the authentication is configured, you can connect to Sentry and query data from any of the available tables such as Organizations, Projects, Issues, and Events.

Building node-odbc

In order to connect to Sentry through the CData ODBC Driver, you need to build node-odbc manually (after installing the required tools).

Installing the Required Tools

The following commands install the tools required to build node-odbc (note the -g parameter, which installs the tools globally).

npm i -g windows-build-tools
npm i -g node-gyp

Building node-odbc

After installing the required tools, create a directory for the Node.js app and install odbc (which builds the binary for us to use in our Node.js script).

mkdir nodeodbc
cd nodeodbc
npm i -g node

Querying Sentry from Node.js

With the ODBC Driver installed, a DSN Configured, and node-odbc built, we are ready to query live Sentry data from a Node.js app. The sample code below connects to a specific DSN and queries the UserOrganizations table.

myscript.js

const odbc = require('odbc');

async function queryAPI() {
    const connection = await odbc.connect(`DSN=CData API Source`);
    const data = await connection.query('SELECT ,  FROM UserOrganizations');
    console.log(data);
}

queryAPI();

Once you write the app, use node to execute the script:

node myscript.js

Download a free, 30-day trial of the CData API Driver for ODBC and start working with your live Sentry data in Node.js. Reach out to our Support Team if you have any questions.

Ready to get started?

Connect to live data from Sentry with the API Driver

Connect to Sentry