This repository has been archived by the owner on Aug 23, 2019. It is now read-only.
observe traffic and expose statistics #243
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ const dirtyChai = require('dirty-chai') | |
| const expect = chai.expect | ||
| chai.use(dirtyChai) | ||
| const parallel = require('async/parallel') | ||
| const map = require('async/map') | ||
| const TCP = require('libp2p-tcp') | ||
| const multiplex = require('libp2p-multiplex') | ||
| const pull = require('pull-stream') | ||
|
|
@@ -18,131 +19,188 @@ const tryEcho = utils.tryEcho | |
| const Switch = require('../src') | ||
|
|
||
| describe('Stats', () => { | ||
| const setup = (cb) => { | ||
| createInfos(2, (err, infos) => { | ||
| expect(err).to.not.exist() | ||
|
|
||
| const options = { | ||
| stats: { | ||
| computeThrottleTimeout: 100 | ||
| } | ||
| } | ||
|
|
||
| const peerA = infos[0] | ||
| const peerB = infos[1] | ||
|
|
||
| peerA.multiaddrs.add('/ip4/127.0.0.1/tcp/9001') | ||
| peerB.multiaddrs.add('/ip4/127.0.0.1/tcp/9002') | ||
|
|
||
| const switchA = new Switch(peerA, new PeerBook(), options) | ||
| const switchB = new Switch(peerB, new PeerBook(), options) | ||
|
|
||
| switchA.transport.add('tcp', new TCP()) | ||
| switchB.transport.add('tcp', new TCP()) | ||
|
|
||
| switchA.connection.crypto(secio.tag, secio.encrypt) | ||
| switchB.connection.crypto(secio.tag, secio.encrypt) | ||
|
|
||
| switchA.connection.addStreamMuxer(multiplex) | ||
| switchB.connection.addStreamMuxer(multiplex) | ||
|
|
||
| parallel([ | ||
| (cb) => switchA.transport.listen('tcp', {}, null, cb), | ||
| (cb) => switchB.transport.listen('tcp', {}, null, cb) | ||
| ], (err) => { | ||
| if (err) { | ||
| cb(err) | ||
| return | ||
| } | ||
| const echo = (protocol, conn) => pull(conn, conn) | ||
| switchB.handle('/echo/1.0.0', echo) | ||
| switchA.handle('/echo/1.0.0', echo) | ||
|
|
||
| parallel([ | ||
| (cb) => { | ||
| switchA.dial(switchB._peerInfo, '/echo/1.0.0', (err, conn) => { | ||
| expect(err).to.not.exist() | ||
| tryEcho(conn, cb) | ||
| }) | ||
| }, | ||
| (cb) => { | ||
| switchB.dial(switchA._peerInfo, '/echo/1.0.0', (err, conn) => { | ||
| expect(err).to.not.exist() | ||
| tryEcho(conn, cb) | ||
| }) | ||
| } | ||
| ], (err) => { | ||
| if (err) { | ||
| cb(err) | ||
| return | ||
| } | ||
|
|
||
| // wait until stats are processed | ||
| setTimeout(() => cb(null, [switchA, switchB]), 500) | ||
| }) | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
| const teardown = (switches, cb) => { | ||
| map(switches, (swtch, cb) => swtch.stop(cb), cb) | ||
| } | ||
|
|
||
| it('both nodes have some global stats', (done) => { | ||
| setup((err, switches) => { | ||
| expect(err).to.not.exist() | ||
|
|
||
| switches.forEach((swtch) => { | ||
| let snapshot = swtch.stats.global.snapshot | ||
| expect(snapshot.dataReceived.toFixed()).to.equal('51') | ||
| expect(snapshot.dataSent.toFixed()).to.equal('49') | ||
| }) | ||
|
|
||
| teardown(switches, done) | ||
| }) | ||
| }) | ||
|
|
||
| it('both nodes know the transports', (done) => { | ||
| setup((err, switches) => { | ||
| expect(err).to.not.exist() | ||
| const expectedTransports = [ | ||
| '/mplex/6.7.0', | ||
| '/secio/1.0.0' | ||
| ] | ||
|
|
||
| switches.forEach( | ||
| (swtch) => expect(swtch.stats.transports().sort()).to.deep.equal(expectedTransports)) | ||
| teardown(switches, done) | ||
| }) | ||
| }) | ||
|
|
||
| it('both nodes know the protocols', (done) => { | ||
| setup((err, switches) => { | ||
| expect(err).to.not.exist() | ||
| const expectedProtocols = [ | ||
| '/echo/1.0.0', | ||
| '/mplex/6.7.0' | ||
| ] | ||
|
|
||
| switches.forEach((swtch) => { | ||
| expect(swtch.stats.protocols().sort()).to.deep.equal(expectedProtocols) | ||
| }) | ||
|
|
||
| teardown(switches, done) | ||
| }) | ||
| }) | ||
|
|
||
| it('both nodes know about each other', (done) => { | ||
| setup((err, switches) => { | ||
| expect(err).to.not.exist() | ||
| switches.forEach( | ||
| (swtch, index) => { | ||
| const otherSwitch = selectOther(switches, index) | ||
| expect(swtch.stats.peers().sort()).to.deep.equal([otherSwitch._peerInfo.id.toB58String()]) | ||
| }) | ||
| teardown(switches, done) | ||
| }) | ||
| }) | ||
|
|
||
| it('both have transport-specific stats', (done) => { | ||
| setup((err, switches) => { | ||
| expect(err).to.not.exist() | ||
| switches.forEach((swtch) => { | ||
| let snapshot = swtch.stats.forTransport('/secio/1.0.0').snapshot | ||
| expect(snapshot.dataReceived.toFixed()).to.equal('92') | ||
| expect(snapshot.dataSent.toFixed()).to.equal('90') | ||
| }) | ||
| teardown(switches, done) | ||
| }) | ||
| }) | ||
|
|
||
| it('both have protocol-specific stats', (done) => { | ||
| setup((err, switches) => { | ||
| expect(err).to.not.exist() | ||
| switches.forEach((swtch) => { | ||
| let snapshot = swtch.stats.forProtocol('/echo/1.0.0').snapshot | ||
| expect(snapshot.dataReceived.toFixed()).to.equal('4') | ||
| expect(snapshot.dataSent.toFixed()).to.equal('8') | ||
| }) | ||
| teardown(switches, done) | ||
| }) | ||
| }) | ||
|
|
||
| it('both have peer-specific stats', (done) => { | ||
| setup((err, switches) => { | ||
| expect(err).to.not.exist() | ||
| switches.forEach((swtch, index) => { | ||
| const other = selectOther(switches, index) | ||
| let snapshot = swtch.stats.forPeer(other._peerInfo.id.toB58String()).snapshot | ||
| expect(snapshot.dataReceived.toFixed()).to.equal('51') | ||
| expect(snapshot.dataSent.toFixed()).to.equal('49') | ||
| }) | ||
| teardown(switches, done) | ||
| }) | ||
| }) | ||
|
|
||
| it('both have moving average stats for peer', (done) => { | ||
| setup((err, switches) => { | ||
| expect(err).to.not.exist() | ||
| switches.forEach((swtch, index) => { | ||
| const other = selectOther(switches, index) | ||
| let ma = swtch.stats.forPeer(other._peerInfo.id.toB58String()).movingAverages | ||
| const intervals = [60000, 300000, 900000] | ||
| intervals.forEach((interval) => { | ||
| const average = ma.dataReceived[interval].movingAverage() | ||
| console.log(average) | ||
| expect(average).to.be.above(0).below(1) | ||
| }) | ||
| }) | ||
| teardown(switches, done) | ||
| }) | ||
| }) | ||
| }) | ||
|
There was a problem hiding this comment. We need tests for:
There was a problem hiding this comment. @diasdavid Currently, peer disconnections imply losing the stats for that peer. There was a problem hiding this comment. Perhaps tracking the sessions and having them in a LRU cache? There was a problem hiding this comment. @diasdavid good call, but I'm not going to put all of the sessions there, only once a peer disconnects.. |
||
|
|
||
| function selectOther (array, index) { | ||
| const useIndex = (index + 1) % array.length | ||
| return array[useIndex] | ||
| } | ||
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.
This is gonna conflict if we run two test cases at the same time, is it possible to set the port to
0and then later get it (if you need it) instead? Think you're not actually using the port in the test, so should work fine to be set to0.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.
@victorbjelkholm good call, fixed!