View Source Module telemetry_registry
data-types
Data Types
a-name-type-applicationapplication-a
<a name="type-application">application()</a>
application() = atom()
event() = {telemetry:event_name(), module(), event_meta()}
event_definition() = #{event => telemetry:event_name(), description => event_description(), measurements => event_measurements(), metadata => event_metadata()}
event_description() = binary()
event_measurements() = binary()
event_meta() = #{description => event_description(), measurements => event_measurements(), metadata => event_metadata()} | #{}
event_metadata() = binary()
spannable_event() = {telemetry:prefix(), [atom()]}
| discover_all/0 | Discover all declared telemetry events in the application it is invoked from and all child applications. |
| discover_all/1 | Discover all declared telemetry events in the given application and its child applications. |
| list_events/0 | Returns a list of all registered events. |
| spannable_events/0 | Returns a list of spannable events. |
discover_all() -> ok
Discover all declared telemetry events in the application it is invoked from and all child applications. This would normally be invoked during application startup. ### discover_all/1 ###
discover_all(Applications::application() | [application()]) -> ok
Discover all declared telemetry events in the given application and its child applications. This is typically used in libraries leveraging ``` telemetry_registry ``` where it would be necessary for the user to define what the root application is, e.g. in tracing bridge libraries. ### list_events/0 ###
list_events() -> [event()]
Returns a list of all registered events. ### spannable_events/0 ###
spannable_events() -> [spannable_event()]
Returns a list of spannable events.