mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-04-01 07:11:04 +00:00
dabee00127
* docs: add initial notes on stats * feat: initial refactor of stats to metrics * feat: add support for placeholder metrics This is helpful for tracking metrics prior to knowing the remote peers id * fix: add metrics tests and fix issues * fix: always clear the dial timeout timer * docs: add metrics to api doc * chore: apply suggestions from code review Co-Authored-By: Vasco Santos <vasco.santos@moxy.studio> * docs: update metrics docs * fix: call metrics.onDisconnect * docs(config): add example headers so they appear in the TOC * docs(config): add metrics configuration * docs(relay): fix relay configuration docs
128 lines
3.8 KiB
JavaScript
128 lines
3.8 KiB
JavaScript
'use strict'
|
|
/* eslint-env mocha */
|
|
|
|
const chai = require('chai')
|
|
chai.use(require('dirty-chai'))
|
|
chai.use(require('chai-as-promised'))
|
|
const { expect } = chai
|
|
const sinon = require('sinon')
|
|
|
|
const { randomBytes } = require('libp2p-crypto')
|
|
const pipe = require('it-pipe')
|
|
const concat = require('it-concat')
|
|
const delay = require('delay')
|
|
|
|
const { createPeer } = require('../utils/creators/peer')
|
|
const baseOptions = require('../utils/base-options')
|
|
|
|
describe('libp2p.metrics', () => {
|
|
let libp2p
|
|
|
|
afterEach(async () => {
|
|
libp2p && await libp2p.stop()
|
|
})
|
|
|
|
it('should disable metrics by default', async () => {
|
|
[libp2p] = await createPeer({
|
|
config: {
|
|
modules: baseOptions.modules
|
|
}
|
|
})
|
|
|
|
expect(libp2p.metrics).to.not.exist()
|
|
})
|
|
|
|
it('should start/stop metrics on startup/shutdown when enabled', async () => {
|
|
const config = { ...baseOptions }
|
|
config.metrics = {
|
|
enabled: true
|
|
}
|
|
;[libp2p] = await createPeer({ started: false, config })
|
|
|
|
expect(libp2p.metrics).to.exist()
|
|
sinon.spy(libp2p.metrics, 'start')
|
|
sinon.spy(libp2p.metrics, 'stop')
|
|
|
|
await libp2p.start()
|
|
expect(libp2p.metrics.start).to.have.property('callCount', 1)
|
|
|
|
await libp2p.stop()
|
|
expect(libp2p.metrics.stop).to.have.property('callCount', 1)
|
|
})
|
|
|
|
it('should record metrics on connections and streams when enabled', async () => {
|
|
const config = { ...baseOptions }
|
|
config.metrics = {
|
|
enabled: true,
|
|
computeThrottleMaxQueueSize: 1, // compute after every message
|
|
movingAverageIntervals: [10]
|
|
}
|
|
let remoteLibp2p
|
|
;[libp2p, remoteLibp2p] = await createPeer({ number: 2, config })
|
|
|
|
remoteLibp2p.handle('/echo/1.0.0', ({ stream }) => pipe(stream, stream))
|
|
|
|
const connection = await libp2p.dial(remoteLibp2p.peerInfo)
|
|
const { stream } = await connection.newStream('/echo/1.0.0')
|
|
|
|
const bytes = randomBytes(512)
|
|
const result = await pipe(
|
|
[bytes],
|
|
stream,
|
|
concat
|
|
)
|
|
|
|
// Flush the call stack
|
|
await delay(0)
|
|
|
|
expect(result).to.have.length(bytes.length)
|
|
// Protocol stats should equal the echo size
|
|
const protocolStats = libp2p.metrics.forProtocol('/echo/1.0.0').toJSON()
|
|
expect(Number(protocolStats.dataReceived)).to.equal(bytes.length)
|
|
expect(Number(protocolStats.dataSent)).to.equal(bytes.length)
|
|
|
|
// A lot more traffic will be sent over the wire for the peer
|
|
const peerStats = libp2p.metrics.forPeer(connection.remotePeer).toJSON()
|
|
expect(Number(peerStats.dataReceived)).to.be.at.least(bytes.length)
|
|
await remoteLibp2p.stop()
|
|
})
|
|
|
|
it('should move disconnected peers to the old peers list', async () => {
|
|
const config = { ...baseOptions }
|
|
config.metrics = {
|
|
enabled: true,
|
|
computeThrottleMaxQueueSize: 1, // compute after every message
|
|
movingAverageIntervals: [10]
|
|
}
|
|
let remoteLibp2p
|
|
;[libp2p, remoteLibp2p] = await createPeer({ number: 2, config })
|
|
|
|
remoteLibp2p.handle('/echo/1.0.0', ({ stream }) => pipe(stream, stream))
|
|
|
|
const connection = await libp2p.dial(remoteLibp2p.peerInfo)
|
|
const { stream } = await connection.newStream('/echo/1.0.0')
|
|
|
|
const bytes = randomBytes(512)
|
|
await pipe(
|
|
[bytes],
|
|
stream,
|
|
concat
|
|
)
|
|
|
|
sinon.spy(libp2p.metrics, 'onPeerDisconnected')
|
|
await libp2p.hangUp(connection.remotePeer)
|
|
|
|
// Flush call stack
|
|
await delay(0)
|
|
|
|
expect(libp2p.metrics.onPeerDisconnected).to.have.property('callCount', 1)
|
|
expect(libp2p.metrics.peers).to.have.length(0)
|
|
|
|
// forPeer should still give us the old peer stats,
|
|
// even though its not in the active peer list
|
|
const peerStats = libp2p.metrics.forPeer(connection.remotePeer).toJSON()
|
|
expect(Number(peerStats.dataReceived)).to.be.at.least(bytes.length)
|
|
await remoteLibp2p.stop()
|
|
})
|
|
})
|