This repository has been archived by the owner on Aug 4, 2023. It is now read-only.
feat: truncate payloads according to intake API limits #8
There are no files selected for viewing
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,130 @@ | ||
| 'use strict' | ||
|
|
||
| var truncate = require('unicode-byte-truncate') | ||
|
|
||
| exports.metadata = truncMetadata | ||
| exports.transaction = truncTransaction | ||
| exports.span = truncSpan | ||
| exports.error = truncError | ||
|
|
||
| function truncMetadata (metadata, opts) { | ||
| metadata.process.title = truncate(String(metadata.process.title), opts.truncateKeywordsAt) | ||
| } | ||
|
|
||
| function truncTransaction (trans, opts) { | ||
| trans.name = truncate(String(trans.name), opts.truncateKeywordsAt) | ||
| trans.type = truncate(String(trans.type), opts.truncateKeywordsAt) | ||
| trans.result = truncate(String(trans.result), opts.truncateKeywordsAt) | ||
|
|
||
| // Unless sampled, context will be null | ||
| if (trans.sampled) truncContext(trans.context, opts.truncateKeywordsAt) | ||
| } | ||
|
|
||
| function truncSpan (span, opts) { | ||
| span.name = truncate(String(span.name), opts.truncateKeywordsAt) | ||
| span.type = truncate(String(span.type), opts.truncateKeywordsAt) | ||
| if (span.stacktrace) span.stacktrace = truncFrames(span.stacktrace, opts.truncateSourceLinesAt) | ||
| } | ||
|
|
||
| function truncError (error, opts) { | ||
| if (error.log) { | ||
| if (error.log.level) { | ||
| error.log.level = truncate(String(error.log.level), opts.truncateKeywordsAt) | ||
| } | ||
| if (error.log.logger_name) { | ||
| error.log.logger_name = truncate(String(error.log.logger_name), opts.truncateKeywordsAt) | ||
| } | ||
| if (error.log.message && opts.truncateErrorMessagesAt >= 0) { | ||
| error.log.message = truncate(String(error.log.message), opts.truncateErrorMessagesAt) | ||
| } | ||
| if (error.log.param_message) { | ||
| error.log.param_message = truncate(String(error.log.param_message), opts.truncateKeywordsAt) | ||
| } | ||
| if (error.log.stacktrace) { | ||
| error.log.stacktrace = truncFrames(error.log.stacktrace, opts.truncateSourceLinesAt) | ||
| } | ||
| } | ||
|
|
||
| if (error.exception) { | ||
| if (error.exception.message && opts.truncateErrorMessagesAt >= 0) { | ||
| error.exception.message = truncate(String(error.exception.message), opts.truncateErrorMessagesAt) | ||
| } | ||
| if (error.exception.type) { | ||
| error.exception.type = truncate(String(error.exception.type), opts.truncateKeywordsAt) | ||
| } | ||
| if (error.exception.code) { | ||
| error.exception.code = truncate(String(error.exception.code), opts.truncateKeywordsAt) | ||
| } | ||
| if (error.exception.module) { | ||
| error.exception.module = truncate(String(error.exception.module), opts.truncateKeywordsAt) | ||
| } | ||
| if (error.exception.stacktrace) { | ||
| error.exception.stacktrace = truncFrames(error.exception.stacktrace, opts.truncateSourceLinesAt) | ||
| } | ||
| } | ||
|
|
||
| truncContext(error.context, opts.truncateKeywordsAt) | ||
| } | ||
|
|
||
| function truncContext (context, max) { | ||
| if (!context) return | ||
|
|
||
| if (context.request) { | ||
| if (context.request.method) { | ||
| context.request.method = truncate(String(context.request.method), max) | ||
| } | ||
| if (context.request.url) { | ||
| if (context.request.url.protocol) { | ||
| context.request.url.protocol = truncate(String(context.request.url.protocol), max) | ||
| } | ||
| if (context.request.url.hostname) { | ||
| context.request.url.hostname = truncate(String(context.request.url.hostname), max) | ||
| } | ||
| if (context.request.url.port) { | ||
| context.request.url.port = truncate(String(context.request.url.port), max) | ||
| } | ||
| if (context.request.url.pathname) { | ||
| context.request.url.pathname = truncate(String(context.request.url.pathname), max) | ||
| } | ||
| if (context.request.url.search) { | ||
| context.request.url.search = truncate(String(context.request.url.search), max) | ||
| } | ||
| if (context.request.url.hash) { | ||
| context.request.url.hash = truncate(String(context.request.url.hash), max) | ||
| } | ||
| if (context.request.url.raw) { | ||
| context.request.url.raw = truncate(String(context.request.url.raw), max) | ||
| } | ||
| if (context.request.url.full) { | ||
| context.request.url.full = truncate(String(context.request.url.full), max) | ||
| } | ||
| } | ||
| } | ||
| if (context.user) { | ||
| if (context.user.id) { | ||
| context.user.id = truncate(String(context.user.id), max) | ||
| } | ||
| if (context.user.email) { | ||
| context.user.email = truncate(String(context.user.email), max) | ||
| } | ||
| if (context.user.username) { | ||
| context.user.username = truncate(String(context.user.username), max) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| function truncFrames (frames, max) { | ||
| frames.forEach(function (frame, i) { | ||
| if (frame.pre_context) frame.pre_context = truncEach(frame.pre_context, max) | ||
| if (frame.context_line) frame.context_line = truncate(String(frame.context_line), max) | ||
| if (frame.post_context) frame.post_context = truncEach(frame.post_context, max) | ||
| }) | ||
|
|
||
| return frames | ||
| } | ||
|
|
||
| function truncEach (arr, len) { | ||
| return arr.map(function (str) { | ||
| return truncate(String(str), len) | ||
| }) | ||
| } |
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 |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| 'use strict' | ||
|
|
||
| const Client = require('../../') | ||
|
|
||
| const client = new Client({ | ||
| serverUrl: process.argv[2], | ||
|
|
||
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
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.
Should these not point to the sub-object, not the base object? ie:
obj.transaction?Also, is there a reason to else-if these? Are we unable to send different types at the same time?
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.
Oh you're right, it should be
truncate.error(obj.error, this._opts)etc. I'll make an update.The client is an object stream, so each write will be a single object containing either a transaction, a span, or an error. I could use a
switch(Object.keys(obj)[0]), but I felt that was less performant than 3 if-statements.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.
I can see a case for sending a span and error at the same time. You wrap an async call in a span from call to callback, and an error occurs, so you report the error and span when the callback is reached. 🤔
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.
Version 2 of the APM Server intake API currently doesn't support that an object contains more than a single root property - either
transaction,spanorerror.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.
Ah, that's fine then. Might be worth considering for @elastic/apm-server to support in the future though.