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

Add a proper supported API for obtaining node info programmatically #480

Open
jsdw opened this issue Jun 13, 2022 · 1 comment
Open

Add a proper supported API for obtaining node info programmatically #480

jsdw opened this issue Jun 13, 2022 · 1 comment
Labels
solution-engineer This issue is a good candidate for a solutions engineer

Comments

@jsdw
Copy link
Collaborator

jsdw commented Jun 13, 2022

I'm wondering how hard it would be to add a proper "API" to telemetry to expose the sort of information requested in #479. The reason being that the data sent to the UI is deliberately fairly minimal/compact (what the UI needs and no more), and also is not an interface we promise to support/not break.

Also, for the benefit of our future selves, having a clear split between "this is what we are sending to populate the UI" and "this is the more nicely structured and actually supported interface for obtaining node information programmatically" would be really valuable.

This API might be some sort of HTTP RESTful thing, or it might be something like JSONRPC over a websocket/http channel.

Let's gather up some of the information that is desirable to access programmatically here, so we can come up with an API to provide it.

@jsdw jsdw added the solution-engineer This issue is a good candidate for a solutions engineer label Jan 29, 2025
@jsdw
Copy link
Collaborator Author

jsdw commented Jan 29, 2025

I added the solution-engineer label, though note that this issue isn't as well fleshed out as some.

I think a good starting point here would be to create a prototype/experiment branch where there is eg a JSON-RPC API (use jsonrpsee's server for this) that exposes/streams certain data as it comes in.

Once we have this working we can evaluate it and iterate slowly from there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
solution-engineer This issue is a good candidate for a solutions engineer
Projects
None yet
Development

No branches or pull requests

1 participant