feat: export metrics

[lightsofapollo]

Adds metrics for common error cases (timeoout, dtls handshake failure) and few success cases (stream open / stream close)

Closes: #64

[lightsofapollo]

@achingbrain David DiMaria pointed out to me that we already have this : https://github.com/libp2p/js-libp2p-interfaces/blob/master/packages/interface-mocks/src/metrics.ts . I believe sinon-ts was suggested in another comment but using the existing mock would definitely work. Do you have a preference?

[achingbrain]

They are intended to fulfil different roles - the classes in @libp2p/interface-mocks are functioning implementations of the various interfaces (e.g. they pass their associated interface tests), useful for when stubbing large amounts of functionality would make the test overly verbose or would introduce lots of redundant code.

Previously we had complicated dependency trees where libp2p components would depend on each other to test functionality which made releasing changes across multiple modules difficult, the collection of mocks was intended to alleviate some of that.

You'd use sinon-ts when you want to assert simple interactions with the other components, like a method being invoked with certain arguments being passed, etc which seemed like a better fit here.

[ddimaria]

@achingbrain This PR collects dialer events. I know we'll need to add listener ones when b2b is completed. Can you think of other relevant events to include? (tcp had a server status that isn't applicable here).

[BigLep]

@achingbrain : I want to get this one out of limbo. Can you please give any input?

[p-shahi]

@achingbrain @lightsofapollo What are the next steps to get this landed?

[ddimaria]

@achingbrain @lightsofapollo What are the next steps to get this landed?

@lightsofapollo it looks like there are conflicts that need to be resolved, and an issue with CI. I have an outstanding question to @achingbrain, though maybe @MarcoPolo can answer it?

[p-shahi]

I'll bring this up for discussion during the js-libp2p triage to determine next steps

[ddimaria]

I'll bring this up for discussion during the js-libp2p triage to determine next steps

@p-shahi were you able to determine the next steps?

[p-shahi]

I'll bring this up for discussion during the js-libp2p triage to determine next steps

@p-shahi were you able to determine the next steps?

Yes, @wemeetagain is assigned for review, so waiting on that.

[maschad]

LGTM

[maschad]

It seems the failing test has been resolved on the Browser-to-server PR , regardless there will be merge conflicts so let's wait till that is merged first given that's of a higher priority.

[wemeetagain]

Looks like these are the events that are tracked:
incoming_stream
stream_end
close
openError
unknownError

• Consider using either camel case OR underscore case.
• Consider tracking a new outgoing stream
• Consider tracking opening a peer connection

Recommendation of additional metrics by @wemeetagain

[achingbrain]

LGTM, just a few small nits

[maschad]

#150 has the necessary fixes to stop CI from failing, let's merge that first.

[github-actions]

🎉 This PR is included in version 1.2.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀