Membrane Core v0.6.0 Membrane.Telemetry View Source
Defines basic telemetry event types used by Membrane's Core. Membrane uses Telemetry Package for instrumentation and does not store or save any measurements by itself.
It is user's responsibility to use some sort of metrics reporter
that will be attached to :telemetry package to consume and process generated measurements.
Instrumentation
Membrane.Telemetry publishes functions that return described below event names.
The following events are published by Membrane's Core with following measurement types and metadata:
[:membrane, :input_buffer, :size]- used byMembrane.Core.InputBufferto report current buffer's size inside functionsMembrane.Core.InputBuffer.store/3andMembrane.Core.InputBuffer.take_and_demand/4.- Measurement:
input_buffer_size_event_value_t/0 - Metadata:
%{}
- Measurement:
[:membrane, :link, :new]- used byMembrane.Core.Parent.ChildLifeController.LinkHandlerto report new link connection being initialized in pipeline.- Measurement:
new_link_event_value_t/0 - Metadata:
%{}
- Measurement:
Link to this section Summary
Types
- element_path - element's process path with pad's name that input buffer is attached to
- method - input buffer's function call name
- value - current buffer's size
- parent_path - process path of link's parent
- from - from element name
- to - to element name
- pad_from - from's pad name
- pad_to - to's pad name
Link to this section Types
Specs
event_name_t() :: [atom(), ...]
Specs
input_buffer_size_event_value_t() :: %{
element_path: String.t(),
method: String.t(),
value: integer()
}
- element_path - element's process path with pad's name that input buffer is attached to
- method - input buffer's function call name
- value - current buffer's size
Specs
new_link_event_value_t() :: %{
parent_path: String.t(),
from: String.t(),
to: String.t(),
pad_from: String.t(),
pad_to: String.t()
}
- parent_path - process path of link's parent
- from - from element name
- to - to element name
- pad_from - from's pad name
- pad_to - to's pad name
Link to this section Functions
Specs
input_buffer_size_event_name() :: event_name_t()
Specs
new_link_event_name() :: event_name_t()