Rastrear consultas SQL com o X-Ray SDK para Node.js - AWS X-Ray
Incluir dados adicionais em subsegmentos SQL

Rastrear consultas SQL com o X-Ray SDK para Node.js

nota

Aviso de fim de suporte: em 25 de fevereiro de 2027, o AWS X-Ray descontinuará o suporte para os SDKs e o daemon do AWS X-Ray. Após 25 de fevereiro de 2027, você não receberá mais atualizações nem lançamentos. Para obter mais informações sobre a linha do tempo do suporte, consulte Linha do tempo de fim de suporte do SDK e do daemon do X-Ray. É recomendável migrar para o OpenTelemetry. Para obter mais informações sobre a migração para o OpenTelemetry, consulte Migrar da instrumentação do X-Ray para a instrumentação do OpenTelemetry.

Instrumente consultas do banco de dados SQL integrando o cliente SQL ao método de cliente correspondente do X-Ray SDK para Node.js.

  • PostgreSQL – AWSXRay.capturePostgres() 

    var AWSXRay = require('aws-xray-sdk');
var pg = AWSXRay.capturePostgres(require('pg'));
var client = new pg.Client();

  • MySQL – AWSXRay.captureMySQL() 

    var AWSXRay = require('aws-xray-sdk');
var mysql = AWSXRay.captureMySQL(require('mysql'));
...
var connection = mysql.createConnection(config);

Quando você usa um cliente instrumentado para fazer consultas SQL, o SDK de X-Ray para Node.js registra informações sobre a conexão e a consulta em um subsegmento.

Incluir dados adicionais em subsegmentos SQL

Você pode adicionar outras informações a subsegmentos gerados para consultas SQL, desde que sejam mapeados para um campo SQL na lista de permissões. Por exemplo, para registrar a sequência de consulta SQL limpa em um subsegmento, você pode adicioná-la diretamente ao objeto SQL do subsegmento.

exemplo Atribuir SQL a um subsegmento
    const queryString = 'SELECT * FROM MyTable';
connection.query(queryString, ...);

// Retrieve the most recently created subsegment
const subs = AWSXRay.getSegment().subsegments;

if (subs & & subs.length > 0) {
  var sqlSub = subs[subs.length - 1];
  sqlSub.sql.sanitized_query = queryString;
}

Para obter uma lista completa de campos SQL na lista de permissões, consulte Consultas SQL no Guia do desenvolvedor do AWS X-Ray.