Added instrumentation for Elasticsearch Node.js client #1266
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -1,29 +1,30 @@ | ||
| TAV: | ||
| - @elastic/elasticsearch | ||
| - apollo-server-express | ||
| - bluebird | ||
| - cassandra-driver | ||
| - elasticsearch | ||
| - express | ||
| - express-graphql | ||
| - express-queue | ||
| - fastify | ||
| - finalhandler | ||
| - generic-pool | ||
| - got | ||
| - graphql | ||
| - handlebars | ||
| - hapi | ||
| - ioredis | ||
| - jade | ||
| - knex | ||
| - koa-router | ||
| - mimic-response | ||
| - mongodb-core | ||
| - mysql | ||
| - mysql2 | ||
| - pg | ||
| - pug | ||
| - redis | ||
| - restify | ||
| - tedious | ||
| - ws | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,24 @@ | ||
| 'use strict' | ||
|
|
||
| const queryRegexp = /_((search|msearch)(\/template)?|count)$/ | ||
|
|
||
| exports.setDbContext = function (span, params) { | ||
| if (queryRegexp.test(params.path)) { | ||
| // The old client exposes body and query, the new client exposes body and querystring | ||
| const statement = Array.isArray(params.body) | ||
| ? params.body.map(JSON.stringify).join('\n') | ||
| : stringifyQuery(params).trim() | ||
|
|
||
| if (statement) { | ||
| span.setDbContext({ | ||
| type: 'elasticsearch', | ||
| statement | ||
| }) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| function stringifyQuery (params) { | ||
| const query = params.body || params.querystring || params.query | ||
| return typeof query === 'string' ? query : JSON.stringify(query) | ||
| } |
This file contains hidden or 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 hidden or 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,79 @@ | ||
| 'use strict' | ||
|
|
||
| const { setDbContext } = require('../../elasticsearch-shared') | ||
|
|
||
| module.exports = function (elasticsearch, agent, { version, enabled }) { | ||
| if (!enabled) return elasticsearch | ||
|
|
||
| function generateSpan (activeSpans, meta, params) { | ||
| const span = agent.startSpan(null, 'db.elasticsearch.request') | ||
| if (span === null) return null | ||
|
|
||
| const { request } = meta | ||
| span.name = `Elasticsearch: ${params.method} ${params.path}` | ||
|
|
||
| activeSpans.set(request.id, span) | ||
|
|
||
| return span | ||
| } | ||
|
|
||
| class ApmClient extends elasticsearch.Client { | ||
| constructor (opts) { | ||
| super(opts) | ||
|
|
||
| const activeSpans = new Map() | ||
|
Contributor
There was a problem hiding this comment. Using a map here might be a bit risky. If something interrupts the flow of the client and it fails to emit the next event in the sequence after the span has been added to the map it would result in a memory leak. Might want to consider using mapcap here, just to be safe. |
||
| let hasPrepareRequestEvent = false | ||
|
|
||
| this.on('prepare-request', (err, { meta, params }) => { | ||
| hasPrepareRequestEvent = true | ||
| if (err) { | ||
| return agent.captureError(err) | ||
| } | ||
|
|
||
| generateSpan(activeSpans, meta, params) | ||
| }) | ||
|
|
||
| this.on('request', (err, { meta }) => { | ||
|
Member
Author
There was a problem hiding this comment. In the
Contributor
There was a problem hiding this comment. I'd love the make the query more readable in the case of an array of queries. What I do with the old client is format it as NDJSON so that each query is on its own line. If we use the JSON that you formatted, it will be one long line containing all the queries... not really sure how to best do this 🤔
Member
Author
There was a problem hiding this comment. What you mean with "array of queries"?
Contributor
There was a problem hiding this comment. Example: const body = [
{},
{
query: {
query_string: {
query: 'pants'
}
}
}
]
client.msearch({ body }, function () {...})
Member
Author
There was a problem hiding this comment. In that case you will get a |
||
| const { request } = meta | ||
|
|
||
| if (err) { | ||
| const span = activeSpans.get(request.id) | ||
| agent.captureError(err) | ||
| if (span !== undefined) { | ||
| span.end() | ||
| activeSpans.delete(request.id) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| const span = hasPrepareRequestEvent === false | ||
| ? generateSpan(activeSpans, meta, request.params) | ||
| : activeSpans.get(request.id) | ||
|
|
||
| if (span) setDbContext(span, request.params) | ||
|
|
||
| // TODO: can we signal somehow that here | ||
| // we are starting the actual http request? | ||
| }) | ||
|
|
||
| this.on('response', (err, { meta }) => { | ||
| if (err) { | ||
| // TODO: rebuild error object to avoid serialization issues | ||
| agent.captureError(err, { custom: err.message }) | ||
| // agent.captureError(err, { labels: { meta: JSON.stringify(err.meta) } }) | ||
| // agent.captureError(err, { custom: JSON.parse(JSON.stringify(err.meta)) }) | ||
| // agent.captureError(err, { custom: err.meta.meta.connection }) | ||
| } | ||
|
|
||
| const { request } = meta | ||
| const span = activeSpans.get(request.id) | ||
| if (span !== undefined) { | ||
| span.end() | ||
| activeSpans.delete(request.id) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| return Object.assign(elasticsearch, { Client: ApmClient }) | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the diff... I only added this line, but sorted all entries alphabetically