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

:telemetry public API in :membrane_core #905

Open
1 of 4 tasks
Tracked by #875
FelonEkonom opened this issue Nov 6, 2024 · 0 comments
Open
1 of 4 tasks
Tracked by #875

:telemetry public API in :membrane_core #905

FelonEkonom opened this issue Nov 6, 2024 · 0 comments
Assignees

Comments

@FelonEkonom
Copy link
Member

FelonEkonom commented Nov 6, 2024

The goal is to have a public API describing

  • when membrane_core emits :telemetry events
  • what are the types of these events
  • what metadata is passed to each event

:telemetry events should allow writing the plugs that might be used for e.g. aggregating metrics, spans or structurized logs

What needs to be done:

  • Take a look on how other open-source libraries or frameworks solve this problem (Phoenix, Ecto, Bandit, Finch, Oban etc.)
  • Propose what :telemetry events are reasonably to be emitted from membrane_core
  • What should be passed as the events metadata (proposition: pass there components state and create a public typespec describing the map that contains some fields from the state)
  • Wrap emitting :telemetry events into macro, that will or will not be resolved to the :telemetry.execute(...), depending on config value (already partially/mostly done on the current master)
@FelonEkonom FelonEkonom changed the title Public :telemetry API in :membrane_core :telemetry public API in :membrane_core Nov 6, 2024
@FelonEkonom FelonEkonom moved this to Todo in Smackore Nov 6, 2024
@FelonEkonom FelonEkonom mentioned this issue Oct 29, 2024
10 tasks
@FelonEkonom FelonEkonom moved this from Todo to In Progress in Smackore Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

No branches or pull requests

2 participants