-
Notifications
You must be signed in to change notification settings - Fork 395
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Added instrumentation for ElasticSearch (#1785)
- Loading branch information
Showing
14 changed files
with
826 additions
and
116 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,144 @@ | ||
/* | ||
* Copyright 2023 New Relic Corporation. All rights reserved. | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
'use strict' | ||
const logger = require('../../logger').child({ component: 'ElasticSearch' }) | ||
|
||
/** | ||
* Instruments the `@elastic/elasticsearch` module. This function is | ||
* passed to `onRequire` when instantiating instrumentation. | ||
* | ||
* @param {object} _agent New Relic agent | ||
* @param {object} elastic resolved module | ||
* @param {string} _moduleName string representation of require/import path | ||
* @param {object} shim New Relic shim | ||
* @returns {void} | ||
*/ | ||
module.exports = function initialize(_agent, elastic, _moduleName, shim) { | ||
shim.setDatastore(shim.ELASTICSEARCH) | ||
shim.setParser(queryParser) | ||
|
||
shim.recordQuery(elastic.Transport.prototype, 'request', function wrapQuery(shim, _, __, args) { | ||
const ctx = this | ||
return { | ||
query: JSON.stringify(args?.[0]), | ||
promise: true, | ||
opaque: true, | ||
inContext: function inContext() { | ||
getConnection.call(ctx, shim) | ||
} | ||
} | ||
}) | ||
} | ||
|
||
/** | ||
* Parses the parameters sent to elasticsearch for collection, | ||
* method, and query | ||
* | ||
* @param {object} params Query object received by the datashim. | ||
* Required properties: path {string}, method {string}. | ||
* Optional properties: querystring {string}, body {object}, and | ||
* bulkBody {object} | ||
* @returns {object} consisting of collection {string}, operation {string}, | ||
* and query {string} | ||
*/ | ||
function queryParser(params) { | ||
params = JSON.parse(params) | ||
|
||
const { collection, operation } = parsePath(params.path, params.method) | ||
|
||
// the substance of the query may be in querystring or in body. | ||
let queryParam = {} | ||
if (typeof params.querystring === 'object' && Object.keys(params.querystring).length > 0) { | ||
queryParam = params.querystring | ||
} | ||
// let body or bulkBody override querystring, as some requests have both | ||
if (typeof params.body === 'object' && Object.keys(params.body).length > 0) { | ||
This comment has been minimized.
Sorry, something went wrong. |
||
queryParam = params.body | ||
} else if (typeof params.bulkBody === 'object' && Object.keys(params.bulkBody).length > 0) { | ||
queryParam = params.bulkBody | ||
} | ||
|
||
const query = JSON.stringify(queryParam) | ||
|
||
return { | ||
collection, | ||
operation, | ||
query | ||
} | ||
} | ||
|
||
/** | ||
* Convenience function for parsing the params.path sent to the queryParser | ||
* for normalized collection and operation | ||
* | ||
* @param {string} pathString params.path supplied to the query parser | ||
* @param {string} method http method called by @elastic/elasticsearch | ||
* @returns {object} consisting of collection {string} and operation {string} | ||
*/ | ||
function parsePath(pathString, method) { | ||
let collection | ||
let operation | ||
const defaultCollection = 'any' | ||
const actions = { | ||
GET: 'get', | ||
PUT: 'create', | ||
POST: 'create', | ||
DELETE: 'delete', | ||
HEAD: 'exists' | ||
} | ||
const suffix = actions[method] | ||
|
||
try { | ||
const path = pathString.split('/') | ||
if (method === 'PUT' && path.length === 2) { | ||
collection = path?.[1] || defaultCollection | ||
operation = `index.create` | ||
return { collection, operation } | ||
} | ||
path.forEach((segment, idx) => { | ||
const prev = idx - 1 | ||
let opname | ||
if (segment === '_search') { | ||
collection = path?.[prev] || defaultCollection | ||
operation = `search` | ||
} else if (segment[0] === '_') { | ||
opname = segment.substring(1) | ||
collection = path?.[prev] || defaultCollection | ||
operation = `${opname}.${suffix}` | ||
} | ||
}) | ||
if (!operation && !collection) { | ||
// likely creating an index--no underscore segments | ||
collection = path?.[1] || defaultCollection | ||
operation = `index.${suffix}` | ||
} | ||
} catch (e) { | ||
logger.warn('Failed to parse path for operation and collection. Using defaults') | ||
logger.warn(e) | ||
collection = defaultCollection | ||
operation = 'unknown' | ||
} | ||
|
||
return { collection, operation } | ||
} | ||
|
||
/** | ||
* Convenience function for deriving connection information from | ||
* elasticsearch | ||
* | ||
* @param {object} shim The New Relic datastore-shim | ||
* @returns {Function} captureInstanceAttributes method of shim | ||
*/ | ||
function getConnection(shim) { | ||
const connectionPool = this.connectionPool.connections[0] | ||
const host = connectionPool.url.host.split(':') | ||
const port = connectionPool.url.port || host?.[1] | ||
return shim.captureInstanceAttributes(host[0], port) | ||
} | ||
|
||
module.exports.queryParser = queryParser | ||
module.exports.parsePath = parsePath | ||
module.exports.getConnection = getConnection |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
/* | ||
* Copyright 2023 New Relic Corporation. All rights reserved. | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
'use strict' | ||
|
||
const tap = require('tap') | ||
const { parsePath, queryParser } = require('../../../lib/instrumentation/@elastic/elasticsearch') | ||
const methods = [ | ||
{ name: 'GET', expected: 'get' }, | ||
{ name: 'PUT', expected: 'create' }, | ||
{ name: 'POST', expected: 'create' }, | ||
{ name: 'DELETE', expected: 'delete' }, | ||
{ name: 'HEAD', expected: 'exists' } | ||
] | ||
|
||
tap.test('parsePath should behave as expected', (t) => { | ||
t.autoend() | ||
|
||
t.test('indices', function (t) { | ||
const path = '/indexName' | ||
methods.forEach((m) => { | ||
const { collection, operation } = parsePath(path, m.name) | ||
const expectedOp = `index.${m.expected}` | ||
t.equal(collection, 'indexName', `index should be 'indexName'`) | ||
t.equal(operation, expectedOp, 'operation should include index and method') | ||
}) | ||
t.end() | ||
}) | ||
t.test('search of one index', function (t) { | ||
const path = '/indexName/_search' | ||
methods.forEach((m) => { | ||
const { collection, operation } = parsePath(path, m.name) | ||
const expectedOp = `search` | ||
t.equal(collection, 'indexName', `index should be 'indexName'`) | ||
t.equal(operation, expectedOp, `operation should be 'search'`) | ||
}) | ||
t.end() | ||
}) | ||
t.test('search of all indices', function (t) { | ||
const path = '/_search/' | ||
methods.forEach((m) => { | ||
if (m.name === 'PUT') { | ||
// skip PUT | ||
return | ||
} | ||
const { collection, operation } = parsePath(path, m.name) | ||
const expectedOp = `search` | ||
t.equal(collection, 'any', 'index should be `any`') | ||
t.equal(operation, expectedOp, `operation should match ${expectedOp}`) | ||
}) | ||
t.end() | ||
}) | ||
t.test('doc', function (t) { | ||
const path = '/indexName/_doc/testKey' | ||
methods.forEach((m) => { | ||
const { collection, operation } = parsePath(path, m.name) | ||
const expectedOp = `doc.${m.expected}` | ||
t.equal(collection, 'indexName', `index should be 'indexName'`) | ||
t.equal(operation, expectedOp, `operation should match ${expectedOp}`) | ||
}) | ||
t.end() | ||
}) | ||
t.test('path is /', function (t) { | ||
const path = '/' | ||
methods.forEach((m) => { | ||
const { collection, operation } = parsePath(path, m.name) | ||
const expectedOp = `index.${m.expected}` | ||
t.equal(collection, 'any', 'index should be `any`') | ||
t.equal(operation, expectedOp, `operation should match ${expectedOp}`) | ||
}) | ||
t.end() | ||
}) | ||
t.test( | ||
'should provide sensible defaults when path is {} and parser encounters an error', | ||
function (t) { | ||
const path = {} | ||
methods.forEach((m) => { | ||
const { collection, operation } = parsePath(path, m.name) | ||
const expectedOp = `unknown` | ||
t.equal(collection, 'any', 'index should be `any`') | ||
t.equal(operation, expectedOp, `operation should match '${expectedOp}'`) | ||
}) | ||
t.end() | ||
} | ||
) | ||
}) | ||
|
||
tap.test('queryParser should behave as expected', (t) => { | ||
t.autoend() | ||
t.test('given a querystring, it should use that for query', (t) => { | ||
const params = JSON.stringify({ | ||
path: '/_search', | ||
method: 'GET', | ||
querystring: { q: 'searchterm' } | ||
}) | ||
const expected = { | ||
collection: 'any', | ||
operation: 'search', | ||
query: JSON.stringify({ q: 'searchterm' }) | ||
} | ||
const parseParams = queryParser(params) | ||
t.match(parseParams, expected, 'queryParser should handle query strings') | ||
t.end() | ||
}) | ||
t.test('given a body, it should use that for query', (t) => { | ||
const params = JSON.stringify({ | ||
path: '/_search', | ||
method: 'POST', | ||
body: { match: { body: 'document' } } | ||
}) | ||
const expected = { | ||
collection: 'any', | ||
operation: 'search', | ||
query: JSON.stringify({ match: { body: 'document' } }) | ||
} | ||
const parseParams = queryParser(params) | ||
t.match(parseParams, expected, 'queryParser should handle query body') | ||
t.end() | ||
}) | ||
t.test('given a bulkBody, it should use that for query', (t) => { | ||
const params = JSON.stringify({ | ||
path: '/_msearch', | ||
method: 'POST', | ||
bulkBody: [ | ||
{}, // cross-index searches have can have an empty metadata section | ||
{ query: { match: { body: 'sixth' } } }, | ||
{}, | ||
{ query: { match: { body: 'bulk' } } } | ||
] | ||
}) | ||
const expected = { | ||
collection: 'any', | ||
operation: 'msearch', | ||
query: JSON.stringify([ | ||
{}, // cross-index searches have can have an empty metadata section | ||
{ query: { match: { body: 'sixth' } } }, | ||
{}, | ||
{ query: { match: { body: 'bulk' } } } | ||
]) | ||
} | ||
const parseParams = queryParser(params) | ||
t.match(parseParams, expected, 'queryParser should handle query body') | ||
t.end() | ||
}) | ||
}) |
Oops, something went wrong.
This crashes with null body, need to add
(params.body && ...)
see #1809