blob: 23a6b266c6927e06c6c30081eaded6a6599fda14 [file] [log] [blame]
/*!
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
import SwPlugin, { wrapEmit, wrapCallback } from '../core/SwPlugin';
import ContextManager from '../trace/context/ContextManager';
import { Component } from '../trace/Component';
import Tag from '../Tag';
import { SpanLayer } from '../proto/language-agent/Tracing_pb';
import PluginInstaller from '../core/PluginInstaller';
import agentConfig from '../config/AgentConfig';
class MySQLPlugin implements SwPlugin {
readonly module = 'mysql';
readonly versions = '*';
install(installer: PluginInstaller): void {
const Connection = installer.require?.('mysql/lib/Connection') ?? require('mysql/lib/Connection');
const _query = Connection.prototype.query;
Connection.prototype.query = function (sql: any, values: any, cb: any) {
let query: any;
const host = `${this.config.host}:${this.config.port}`;
const span = ContextManager.current.newExitSpan('mysql/query', Component.MYSQL);
span.start();
try {
span.component = Component.MYSQL;
span.layer = SpanLayer.DATABASE;
span.peer = host;
span.tag(Tag.dbType('Mysql'));
span.tag(Tag.dbInstance(`${this.config.database}`));
let _sql: any;
let _values: any;
let streaming: any;
if (typeof sql === 'function') {
sql = wrapCallback(span, sql, 0);
} else if (typeof sql === 'object') {
_sql = sql.sql;
if (typeof values === 'function') {
values = wrapCallback(span, values, 0);
_values = sql.values;
} else if (values !== undefined) {
_values = values;
if (typeof cb === 'function') {
cb = wrapCallback(span, cb, 0);
} else {
streaming = true;
}
} else {
streaming = true;
}
} else {
_sql = sql;
if (typeof values === 'function') {
values = wrapCallback(span, values, 0);
} else if (values !== undefined) {
_values = values;
if (typeof cb === 'function') {
cb = wrapCallback(span, cb, 0);
} else {
streaming = true;
}
} else {
streaming = true;
}
}
span.tag(Tag.dbStatement(`${_sql}`));
if (agentConfig.sqlTraceParameters && _values) {
let vals = _values.map((v: any) => (v === undefined ? 'undefined' : JSON.stringify(v))).join(', ');
if (vals.length > agentConfig.sqlParametersMaxLength)
vals = vals.slice(0, agentConfig.sqlParametersMaxLength) + ' ...';
span.tag(Tag.dbSqlParameters(`[${vals}]`));
}
query = _query.call(this, sql, values, cb);
if (streaming) wrapEmit(span, query, true, 'end');
} catch (e) {
span.error(e);
span.stop();
throw e;
}
span.async();
return query;
};
}
}
// noinspection JSUnusedGlobalSymbols
export default new MySQLPlugin();