Skip to content

Commit d0ea87d

Browse files
committed
Consistent tag definition
1 parent ac1dabf commit d0ea87d

File tree

3 files changed

+36
-1
lines changed

3 files changed

+36
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ var client = new raven.Client('{{ SENTRY_DSN }}');
5151
client.captureMessage("Another message")
5252
```
5353

54-
**Adding extra info to messages**
54+
**Adding extra info an event**
5555
```javascript
5656
var raven = require('raven');
5757

@@ -60,6 +60,15 @@ var client = new raven.Client('{{ SENTRY_DSN }}');
6060
client.captureMessage("Another message", {extra: {'key': 'value'}})
6161
```
6262

63+
**Adding tags to an event**
64+
```javascript
65+
var raven = require('raven');
66+
67+
var client = new raven.Client('{{ SENTRY_DSN }}');
68+
69+
client.captureMessage("Another message", {tags: {'key': 'value'}})
70+
```
71+
6372
## Logging an error
6473
```javascript
6574
client.captureError(new Error('Broke!'));

lib/client.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ _.process = function process(kwargs) {
5555
if (typeof process.version !== undefined) {
5656
kwargs['extra']['node'] = process.version;
5757
}
58+
kwargs['tags'] = kwargs['tags'] || {};
5859
kwargs['logger'] = kwargs['logger'] || this.loggerName;
5960
kwargs['event_id'] = uuid().replace(/-/g, '');
6061
kwargs['timestamp'] = new Date().toISOString().split('.')[0];

test/raven.client.js

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -438,5 +438,30 @@ describe('raven.Client', function(){
438438
});
439439
client.process({message: 'test', extra: {key: 'value'}});
440440
});
441+
442+
it('should capture tags', function(done) {
443+
var scope = nock('https://app.getsentry.com')
444+
.filteringRequestBody(/.*/, '*')
445+
.post('/api/store/', '*')
446+
.reply(200, function(uri, body) {
447+
zlib.inflate(new Buffer(body, 'base64'), function(err, dec) {
448+
if (err) return done(err);
449+
var msg = JSON.parse(dec.toString());
450+
var tags = msg.tags;
451+
452+
tags.should.have.property('key');
453+
tags['key'].should.equal('value');
454+
455+
done();
456+
});
457+
return 'OK';
458+
});
459+
460+
client.on('logged', function(){
461+
scope.done();
462+
});
463+
client.process({message: 'test', tags: {key: 'value'}});
464+
});
465+
441466
});
442467

0 commit comments

Comments
 (0)