Query Sentry Data as a MySQL Database in Node.js

You can use the SQL Gateway from the ODBC Driver for Sentry to query Sentry data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect 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.

• 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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Sentry data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Sentry from Node.js

The following example shows how to define a connection and execute queries to Sentry with the mysql module. You will need the following information:

• Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
• Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
• Database name: The DSN you configured for the MySQL remoting service.

Connect to Sentry data and start executing queries with the code below:

var mysql      = require('mysql');
var connection = mysql.createConnection({
  host     : 'localhost',
  database : 'CData API Sys',
  port	   : '3306',
  user     : 'mysql_user',
  password : 'test'
});
connection.connect();
connection.query('SELECT * FROM UserOrganizations', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();