elastic-apm-node
Version:
The official Elastic APM agent for Node.js
435 lines (385 loc) • 10.4 kB
JavaScript
/*
* Copyright Elasticsearch B.V. and other contributors where applicable.
* Licensed under the BSD 2-Clause License; you may not use this file except in
* compliance with the BSD 2-Clause License.
*/
'use strict';
var breadthFilter = require('breadth-filter');
exports.metadata = truncMetadata;
exports.transaction = truncTransaction;
exports.span = truncSpan;
exports.error = truncError;
exports.metricset = truncMetricSet;
// Truncate the string `s` to a `max` maximum number of JavaScript characters.
//
// Note that JavaScript uses UCS-2 internally, so characters outside of the
// BMP are represented as surrogate pairs. These count as *two* characters.
// The result is that a string with surrogate pairs will appear to be truncated
// shorter than expected:
// unitrunc('aaaa', 4) // => 'aaaa'
// unitrunc('😂😂😂😂', 4) // => '😂😂'
//
// This will avoid truncating in the middle of a surrogate pair by truncating
// one character earlier. For example:
// unitrunc('foo😂bar', 4) // => 'foo'
function unitrunc(s, max) {
if (s.length > max) {
if (max <= 0) {
return '';
}
// If the last character is a "high" surrogate (D800–DBFF) per
// https://en.wikipedia.org/wiki/Universal_Character_Set_characters#Surrogates
// then we would truncate in the middle of a surrogate pair. Move back one
// char to have a clean(er) truncation.
const endChar = s.charCodeAt(max - 1);
if (endChar >= 0xd800 && endChar <= 0xdbff) {
return s.slice(0, max - 1);
} else {
return s.slice(0, max);
}
}
return s;
}
function truncMetadata(metadata, opts) {
return breadthFilter(metadata, {
onArray,
onObject,
onValue(value, key, path) {
if (typeof value !== 'string') {
return value;
}
let max = opts.truncateStringsAt;
switch (path[0]) {
case 'service':
switch (path[1]) {
case 'name':
case 'version':
case 'environment':
max = opts.truncateKeywordsAt;
break;
case 'agent':
case 'framework':
case 'language':
case 'runtime':
switch (path[2]) {
case 'name':
case 'version':
max = opts.truncateKeywordsAt;
break;
}
break;
}
break;
case 'process':
if (path[1] === 'title') {
max = opts.truncateKeywordsAt;
}
break;
case 'system':
switch (path[1]) {
case 'architecture':
case 'hostname':
case 'platform':
max = opts.truncateKeywordsAt;
break;
}
break;
case 'cloud':
switch (path[1]) {
case 'availability_zone':
case 'provider':
case 'region':
max = opts.truncateKeywordsAt;
break;
case 'account':
switch (path[2]) {
case 'id':
case 'name':
max = opts.truncateKeywordsAt;
break;
}
break;
case 'instance':
switch (path[2]) {
case 'id':
case 'name':
max = opts.truncateKeywordsAt;
break;
}
break;
case 'machine':
switch (path[2]) {
case 'type':
max = opts.truncateKeywordsAt;
break;
}
break;
case 'project':
switch (path[2]) {
case 'id':
case 'name':
max = opts.truncateKeywordsAt;
break;
}
}
break;
}
return unitrunc(value, max);
},
});
}
function truncTransaction(trans, opts) {
const result = breadthFilter(trans, {
onArray,
onObject: onObjectWithHeaders,
onValue(value, key, path) {
if (typeof value !== 'string') {
if (isHeader(path)) return String(value);
return value;
}
let max = opts.truncateStringsAt;
switch (path[0]) {
case 'name':
case 'type':
case 'result':
case 'id':
case 'trace_id':
case 'parent_id':
max = opts.truncateKeywordsAt;
break;
case 'context':
max = contextLength(path, opts);
break;
}
return unitrunc(value, max);
},
});
return Object.assign(
{
name: 'undefined',
type: 'undefined',
result: 'undefined',
},
result,
);
}
function truncSpan(span, opts) {
let result = breadthFilter(span, {
onArray,
onObject,
onValue(value, key, path) {
if (typeof value !== 'string') {
return value;
}
let max = opts.truncateStringsAt;
switch (path[0]) {
case 'name':
case 'type':
case 'id':
case 'trace_id':
case 'parent_id':
case 'transaction_id':
case 'subtype':
case 'action':
max = opts.truncateKeywordsAt;
break;
case 'context':
max = contextLength(path, opts);
break;
}
return unitrunc(value, max);
},
});
result = truncateCustomKeys(result, opts.truncateCustomKeysAt, [
'name',
'type',
'id',
'trace_id',
'parent_id',
'transaction_id',
'subtype',
'action',
'context',
]);
return Object.assign(
{
name: 'undefined',
type: 'undefined',
},
result,
);
}
function truncError(error, opts) {
return breadthFilter(error, {
onArray,
onObject: onObjectWithHeaders,
onValue(value, key, path) {
if (typeof value !== 'string') {
if (isHeader(path)) return String(value);
return value;
}
let max = opts.truncateStringsAt;
switch (path[0]) {
case 'id':
case 'trace_id':
case 'parent_id':
case 'transaction_id':
max = opts.truncateKeywordsAt;
break;
case 'context':
max = contextLength(path, opts);
break;
case 'log':
switch (path[1]) {
case 'level':
case 'logger_name':
case 'param_message':
max = opts.truncateKeywordsAt;
break;
case 'message':
if (opts.truncateErrorMessagesAt === undefined) {
max = opts.truncateLongFieldsAt;
} else if (opts.truncateErrorMessagesAt < 0) {
return value; // skip truncation
} else {
max = opts.truncateErrorMessagesAt;
}
break;
}
break;
case 'exception':
switch (path[1]) {
case 'type':
case 'code':
case 'module':
max = opts.truncateKeywordsAt;
break;
case 'message':
if (opts.truncateErrorMessagesAt === undefined) {
max = opts.truncateLongFieldsAt;
} else if (opts.truncateErrorMessagesAt < 0) {
return value; // skip truncation
} else {
max = opts.truncateErrorMessagesAt;
}
break;
}
break;
}
return unitrunc(value, max);
},
});
}
function truncMetricSet(metricset, opts) {
return breadthFilter(metricset, {
onArray,
onObject,
onValue(value, key, path) {
if (typeof value !== 'string') {
return value;
}
const max =
path[0] === 'tags' ? opts.truncateKeywordsAt : opts.truncateStringsAt;
return unitrunc(value, max);
},
});
}
function contextLength(path, opts) {
switch (path[1]) {
case 'db':
if (path[2] === 'statement') {
return opts.truncateLongFieldsAt;
}
break;
case 'message':
if (path[2] === 'body') {
return opts.truncateLongFieldsAt;
}
break;
case 'request':
switch (path[2]) {
case 'method':
case 'http_version':
return opts.truncateKeywordsAt;
case 'body':
return opts.truncateLongFieldsAt;
case 'url':
switch (path[3]) {
case 'protocol':
case 'hostname':
case 'port':
case 'pathname':
case 'search':
case 'hash':
case 'raw':
case 'full':
return opts.truncateKeywordsAt;
}
break;
}
break;
case 'user':
switch (path[2]) {
case 'id':
case 'email':
case 'username':
return opts.truncateKeywordsAt;
}
break;
case 'tags':
return opts.truncateKeywordsAt;
case 'destination':
switch (path[2]) {
case 'address':
return opts.truncateKeywordsAt;
case 'service':
switch (path[3]) {
case 'name':
case 'resource':
case 'type':
return opts.truncateKeywordsAt;
}
break;
}
break;
}
return opts.truncateStringsAt;
}
function isHeader(path) {
return (
path[0] === 'context' &&
(path[1] === 'request' || path[1] === 'response') &&
path[2] === 'headers' &&
path[3]
);
}
function onObjectWithHeaders(value, key, path, isNew) {
if (isHeader(path)) return String(value);
return onObject(value, key, path, isNew);
}
function onObject(value, key, path, isNew) {
return isNew ? {} : '[Circular]';
}
function onArray(value, key, path, isNew) {
return isNew ? [] : '[Circular]';
}
function truncateCustomKeys(value, max, keywords) {
if (typeof value !== 'object' || value === null) {
return value;
}
const result = value;
const keys = Object.keys(result);
const truncatedKeys = keys.map((k) => {
if (keywords.includes(k)) {
return k;
}
return unitrunc(k, max);
});
for (const [index, k] of keys.entries()) {
const value = result[k];
delete result[k];
const newKey = truncatedKeys[index];
result[newKey] = truncateCustomKeys(value, max, keywords);
}
return result;
}