change mask default to false

Author: maryliag

packages/instrumentation-mysql2/README.md

@@ -48,7 +48,7 @@ You can set the following instrumentation options:
 | ------- | ---- | ----------- |
 | `responseHook` | `MySQL2InstrumentationExecutionResponseHook` (function) | Function for adding custom attributes from db response |
 | `addSqlCommenterCommentToQueries` | `boolean` | If true, adds [sqlcommenter](https://github.com/open-telemetry/opentelemetry-sqlcommenter) specification compliant comment to queries with tracing context (default false). _NOTE: A comment will not be added to queries that already contain `--` or `/* ... */` in them, even if these are not actually part of comments_ |
-| `maskStatement` | `boolean` | If true, masks the `db.statement` attribute in spans (default true) with the `maskStatementHook` |
+| `maskStatement` | `boolean` | If true, masks the `db.statement` attribute in spans (default false) with the `maskStatementHook` |
 | `maskStatementHook` | `MySQL2InstrumentationMaskStatementHook` (function) | Function for masking the `db.statement` attribute in spans  Default: `return query.replace(/\b\d+\b/g, '?').replac(/(["'])(?:(?=(\\?))\2.)*?\1/g, '?');`|
 
 

packages/instrumentation-mysql2/src/types.ts

@@ -33,7 +33,7 @@ export interface MySQL2InstrumentationConfig extends InstrumentationConfig {
   /**
    * If true, the query will be masked before setting it as a span attribute, using the {@link maskStatementHook}.
    *
-   * @default true
+   * @default false
    * @see maskStatementHook
    */
   maskStatement?: boolean;

packages/instrumentation-mysql2/src/utils.ts

@@ -109,7 +109,7 @@ export function getDbStatement(
   query: string | Query | QueryOptions,
   format?: formatType,
   values?: any[],
-  maskStatement = true,
+  maskStatement = false,
   maskStatementHook: MySQL2InstrumentationQueryMaskingHook = defaultMaskingHook
 ): string {
   const [querySql, queryValues] =

packages/instrumentation-mysql2/test/mysql.test.ts

@@ -156,9 +156,6 @@ describe('mysql2', () => {
       contextManager = new AsyncLocalStorageContextManager().enable();
       context.setGlobalContextManager(contextManager);
       instrumentation.setTracerProvider(provider);
-      instrumentation.setConfig({
-        maskStatement: false,
-      });
       instrumentation.enable();
       connection = createConnection({
         port,
@@ -1131,7 +1128,6 @@ describe('mysql2', () => {
             responseHook: (span, responseHookInfo) => {
               throw new Error('random failure!');
             },
-            maskStatement: false,
           };
           instrumentation.setConfig(config);
         });
@@ -1159,7 +1155,6 @@ describe('mysql2', () => {
                 JSON.stringify(responseHookInfo.queryResults)
               );
             },
-            maskStatement: false,
           };
           instrumentation.setConfig(config);
         });
@@ -1389,10 +1384,7 @@ describe('mysql2', () => {
           });
         });
       });
-      it('should not mask query if maskStatement is false', done => {
-        instrumentation.setConfig({
-          maskStatement: false,
-        });
+      it('should not mask query if maskStatement is false (default)', done => {
         const query = 'SELECT 1+1 as solution';
         const span = provider.getTracer('default').startSpan('test span');
         context.with(trace.setSpan(context.active(), span), () => {
@@ -1499,9 +1491,6 @@ describe('mysql2', () => {
       contextManager = new AsyncLocalStorageContextManager().enable();
       context.setGlobalContextManager(contextManager);
       instrumentation.setTracerProvider(provider);
-      instrumentation.setConfig({
-        maskStatement: false,
-      });
       instrumentation.enable();
       connection = await createConnection({
         port,