Skip to content
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

Protocol documentation for SDK <> Viewer communication (allow others to support non-Apple platforms) #228

Open
tonyxiao opened this issue Dec 9, 2023 · 1 comment

Comments

@tonyxiao
Copy link

tonyxiao commented Dec 9, 2023

Pulse is amazing! But I'm out of luck if I'm working with Android, javascript or a backend programing language. If Pulse can document how its SDK and viewer communicates, I'd be happy to contribute something that allow people to view requests made in node.js in the Pulse viewer.

@kean
Copy link
Owner

kean commented Dec 26, 2023

Hey, @tonyxiao. Sorry, missed your message.

It could be a great exercise to try and document it. I consider the current protocol to still be in version 0.x (pre-production), and it's a bit overcomplicated, so before documenting it, it would be worth revising the current protocol.

Pulse SDK uses Bonjour for finding the macOS app. It then uses a basic binary protocol to communicate (see RemoteLogger-Protocol.swift). The messages are sent using JSON (NetworkLogger%2BEntities.swift).

If you are up to untangling it, I'll be happy to answer the questions. Alternatively, I would suggest waiting for protocol version 1.x. I'm open to suggestions on designing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants