Skip to content

Introduce maxBreadcrumbs, increase default (and max) limit to 100 #685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 12, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,11 @@ Those configuration options are documented below:
By default, Raven does not truncate messages. If you need to truncate
characters for whatever reason, you may set this to limit the length.

.. describe:: maxBreadcrumbs

By default, Raven captures as many as 100 breadcrumb entries. If you find this too noisy, you can reduce this
number by setting `maxBreadcrumbs`. Note that this number cannot be set higher than the default of 100.

.. describe:: transport

Override the default HTTP data transport handler.
Expand Down
4 changes: 2 additions & 2 deletions src/raven.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ function Raven() {
this._startTime = now();
this._wrappedBuiltIns = [];
this._breadcrumbs = [];
this._breadcrumbLimit = 20;
this._lastCapturedEvent = null;
this._keypressTimeout;
this._location = window.location;
Expand Down Expand Up @@ -137,6 +136,7 @@ Raven.prototype = {
this._globalOptions.ignoreUrls = this._globalOptions.ignoreUrls.length ? joinRegExp(this._globalOptions.ignoreUrls) : false;
this._globalOptions.whitelistUrls = this._globalOptions.whitelistUrls.length ? joinRegExp(this._globalOptions.whitelistUrls) : false;
this._globalOptions.includePaths = joinRegExp(this._globalOptions.includePaths);
this._globalOptions.maxBreadcrumbs = Math.max(0, Math.min(this._globalOptions.maxBreadcrumbs || 100, 100)); // default and hard limit is 100

this._globalKey = uri.user;
this._globalSecret = uri.pass && uri.pass.substr(1);
Expand Down Expand Up @@ -358,7 +358,7 @@ Raven.prototype = {
}, obj);

this._breadcrumbs.push(crumb);
if (this._breadcrumbs.length > this._breadcrumbLimit) {
if (this._breadcrumbs.length > this._globalOptions.maxBreadcrumbs) {
this._breadcrumbs.shift();
}
},
Expand Down
24 changes: 23 additions & 1 deletion test/raven.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -1578,6 +1578,28 @@ describe('Raven (public API)', function() {
assert.isFalse(TraceKit.collectWindowErrors);
});
});

describe('maxBreadcrumbs', function () {
it('should override the default', function () {
Raven.config(SENTRY_DSN, { maxBreadcrumbs: 50 });
assert.equal(Raven._globalOptions.maxBreadcrumbs, 50);
});

it('should not permit maxBreadcrumbs above 100', function () {
Raven.config(SENTRY_DSN, { maxBreadcrumbs: 200 });
assert.equal(Raven._globalOptions.maxBreadcrumbs, 100);
});

it('should not permit maxBreadcrumbs below 0', function () {
Raven.config(SENTRY_DSN, { maxBreadcrumbs: -1 });
assert.equal(Raven._globalOptions.maxBreadcrumbs, 0);
});

it('should set maxBreadcrumbs to the default if not provided', function () {
Raven.config(SENTRY_DSN);
assert.equal(Raven._globalOptions.maxBreadcrumbs, 100);
});
});
});

describe('.wrap', function() {
Expand Down Expand Up @@ -2063,7 +2085,7 @@ describe('Raven (public API)', function() {
});

it('should dequeue the oldest breadcrumb when over limit', function() {
Raven._breadcrumbLimit = 5;
Raven._globalOptions.maxBreadcrumbs = 5;
Raven._breadcrumbs = [
{ message: '1', timestamp: 0.1 },
{ message: '2', timestamp: 0.1 },
Expand Down