PipelineConfig
LogConfig
Variable
| Field | Type | Label | Description |
|---|
| id | string | | |
| label | string | | |
| description | string | | |
| paths | string | repeated | |
DataRate
| Field | Type | Label | Description |
|---|
| goodput_expression | string | | |
| overhead_expression | string | | |
| type | DataRateType | optional | |
DecoratedText
| Field | Type | Label | Description |
|---|
| text | string | | |
| color | string | optional | |
Gauge
| Field | Type | Label | Description |
|---|
| expression | string | | |
KpiMetric
Kpis
Kpis.VariablesEntry
| Field | Type | Label | Description |
|---|
| key | string | | |
| value | string | | |
MultipleValues
MultipleValuesItem
| Field | Type | Label | Description |
|---|
| expression | string | | |
| label | string | | |
| description | string | optional | |
| color | string | optional | |
MultipleValuesOverTime
MultipleValuesOverTimeItem
| Field | Type | Label | Description |
|---|
| expression | string | | |
| label | string | | |
| description | string | optional | |
| color | string | optional | |
Value
| Field | Type | Label | Description |
|---|
| expression | string | | |
| unit | string | optional | |
ValueOverTime
| Field | Type | Label | Description |
|---|
| expression | string | | |
| unit | string | optional | |
| min_expression | string | optional | |
| max_expression | string | optional | |
| avg_expression | string | optional | |
ValueOverTimeComparison
| Field | Type | Label | Description |
|---|
| value1_expression | string | | |
| value2_expression | string | | |
| unit | string | optional | |
| value1_text | string | optional | |
| value2_text | string | optional | |
| value1_min_expression | string | optional | |
| value2_min_expression | string | optional | |
| value1_max_expression | string | optional | |
| value2_max_expression | string | optional | |
| value1_avg_expression | string | optional | |
| value2_avg_expression | string | optional | |
ValueToText
ValueToText.MappingEntry
ValueToTextCondition
| Field | Type | Label | Description |
|---|
| expression | string | | |
| text | string | | |
| color | string | optional | |
ValueToTextConditions
DataRateType
| Name | Number | Description |
|---|
| TOTAL | 0 | |
| RATE | 1 | |
MultipleValuesOverTimeGraphType
| Name | Number | Description |
|---|
| AREA_STACK | 0 | |
| LINE | 1 | |
DisplayCoordinates
| Field | Type | Label | Description |
|---|
| x | int32 | | |
| y | int32 | | |
Meta.ComponentDisplayCoordinatesEntry
Meta.ComponentDisplayOrderEntry
| Field | Type | Label | Description |
|---|
| key | string | | |
| value | int32 | | |
InterfaceInfo
Information about a network interface.
| Field | Type | Label | Description |
|---|
| is_up | bool | | |
| mtu | uint32 | | |
| ips | string | repeated | |
| mac_address | string | | |
InterfaceInfoWrapper
Wrapper for optional InterfaceInfo to support null values in maps.
ListRequest
Request the current list of interfaces.
ListResponse
Response containing the current list of interfaces
ListResponse.InterfacesEntry
LogFilters
Set or change the log filters.
RegisterRequest
Request to register to receive pushed updates about interfaces.
Request
Request message that can contain different types of requests.
Response
Response message indicating success or failure of an operation.
| Field | Type | Label | Description |
|---|
| simple | SimpleResponse | | Simple success/failure response |
| list | ListResponse | | Response containing the list of interfaces |
SetOptionRequest
Request to set various options for the network monitor.
SimpleResponse
Simple response for operations that just need success/failure
| Field | Type | Label | Description |
|---|
| success | bool | | |
| message | string | | |
StartRequest
Request to start the network monitor.
Update
Update message containing interface information.
| Field | Type | Label | Description |
|---|
| interfaces | Update.InterfacesEntry | repeated | Map of interface names to their information. If an interface has no info payload, it means it was removed. |
Update.InterfacesEntry
WireMessage
An encapsulation of the various messages sent over the wire.
LossTrackerReceiver
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| sampling_interval_ms | uint32 | optional | |
LossTrackerSender
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
RlncEncoder
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| symbols | int32 | | |
| repair | int32 | | |
CPUConfig
| Field | Type | Label | Description |
|---|
| pin | Pin | | |
Config
Pipeline configuration.
| Field | Type | Label | Description |
|---|
| pipeline | Config.PipelineEntry | repeated | The components of the pipeline. |
| shm_config | ShmConfig | optional | Configuration for the shared memory file where the pipelines metrics are stored. |
| log_filters | LogFilter | repeated | Filters for log messages. |
| shm_log_filters | ShmLogFilter | repeated | Filters for log messages in shared memory. |
| lifecycle_handler | LifecycleHandler | optional | Lifecycle handler for the pipeline. |
| cpu_config | CPUConfig | optional | CPU configuration for the pipeline. |
Config.PipelineEntry
Deduplicator
| Field | Type | Label | Description |
|---|
| ignore_fields | string | repeated | Fields to ignore when deduplicating log messages. Note, the timestamp field is always ignored. |
| timeout_ms | uint32 | optional | Timeout in milliseconds. |
LogActions
| Field | Type | Label | Description |
|---|
| actions | string | repeated | |
LogFilter
File log filter for log messages.
| Field | Type | Label | Description |
|---|
| level | LogLevel | | |
| actions | LogActions | | |
| path_filter | string | optional | Path filter to log. |
| file | string | optional | File to store log in. |
| mode | LogMode | optional | Mode to log in. |
| deduplicator | Deduplicator | | |
Pin
| Field | Type | Label | Description |
|---|
| performance_mode | bool | optional | The CPU core to run the pipeline on. |
| core | uint32 | optional | |
ShmConfig
Dump metrics of the pipelines into the shared memory file.
| Field | Type | Label | Description |
|---|
| file_path | string | | The path of the shared memory file |
| bytes | int32 | | The size of the shared memory file in bytes |
| interval_ms | int32 | | Interval in milliseconds between writing metrics to the shared memory file. |
ShmLogFilter
Shared memory log filter for log messages.
| Field | Type | Label | Description |
|---|
| level | LogLevel | | |
| actions | LogActions | | |
| path_filter | string | optional | Path filter to log. |
| file | string | | The path of the shared memory file |
| bytes | int32 | | The size of the shared memory file in bytes |
| unlink_at_exit | bool | optional | Determines whether the file should be unlinked when the pipeline exits. |
LogLevel
Log levels used for filtering log messages.
| Name | Number | Description |
|---|
| STATE | 0 | |
| DEBUG | 1 | |
| INFO | 2 | |
| WARN | 3 | |
| ERROR | 4 | |
| FATAL | 5 | |
LogMode
| Name | Number | Description |
|---|
| APPEND | 0 | Append to the file. |
| TRUNCATE | 1 | Truncate the file. |
Splitter
| Field | Type | Label | Description |
|---|
| input | string | | |
| outputs | string | repeated | |
BoringSSLDecrypt
| Field | Type | Label | Description |
|---|
| output | string | | |
| total_packets | uint32 | | |
| interval | uint32 | | |
| min_packet_size | uint32 | optional | |
| max_packet_size | uint32 | optional | |
| seed | uint32 | optional | |
Tap
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| interface_name | string | | |
| ip | string | | |
| netmask | string | optional | |
| is_default_route | bool | optional | |
| mtu | uint32 | optional | |
DelayConstant
| Field | Type | Label | Description |
|---|
| flows | EmulationFlow | repeated | |
| delay | uint32 | | |
| jitter | uint32 | optional | |
| allow_reordering | bool | optional | |
| seed | int32 | optional | |
BoringSSLPoly1305Checker
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| shared_secret | string | | |
FixedReplication
Raft stream extension for fixed replication repair mode.
Raft
| Field | Type | Label | Description |
|---|
| streams | RaftStream | repeated | |
| carriers | RaftCarrier | repeated | |
| max_packet_bytes | uint32 | optional | |
RaftCarrier
Raft carrier responsible for transporting data from the streams
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| carrier_handle | uint32 | | |
| bandwidth_priority | uint32 | optional | |
| max_bandwidth_mbps | uint32 | optional | |
| auto_bandwidth_estimation | bool | optional | |
RaftRealtimeStream
RaftRealtimeStreamExtension
RaftStream
Raft stream representing incoming data streams to be transmitted.
RaftTransitStream
| Field | Type | Label | Description |
|---|
| bonding_delay | uint32 | | |
ReedSolomonEncoder
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| symbols | int32 | | |
| repair | int32 | | |
VideoTrafficSource
| Field | Type | Label | Description |
|---|
| output | string | | |
| fps | uint32 | | |
| p_frames | uint32 | | |
| total_packets | uint32 | | |
| min_packet_size | uint32 | optional | |
| max_packet_size | uint32 | optional | |
| seed | uint32 | optional | |
DelayDynamic
| Field | Type | Label | Description |
|---|
| flows | EmulationFlow | repeated | |
| phases | DelayPhase | repeated | |
| allow_reordering | bool | optional | |
| seed | int32 | optional | |
DelayPhase
| Field | Type | Label | Description |
|---|
| duration | uint32 | | |
| delay | uint32 | | |
| jitter | uint32 | optional | |
FlowCombiner
| Field | Type | Label | Description |
|---|
| inputs | string | repeated | |
| output | string | | |
PeerWriter
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| remote_address | string | | |
Parity2dEncoder
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| columns | int32 | | |
| rows | int32 | | |
Component
A component within the pipeline.
RelyDecoder
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| timeout | int32 | | |
| release_in_order | bool | | |
RelayConfiguration
RelayConfiguration.EndpointsEntry
RelayConfiguration.RoutesEntry
RelayEndpoint
| Field | Type | Label | Description |
|---|
| pipeline | string | | |
| carriers | string | repeated | |
RelayRoute
| Field | Type | Label | Description |
|---|
| endpoints | string | repeated | |
| conmment | string | optional | |
BandwidthLimitConstant
| Field | Type | Label | Description |
|---|
| flows | EmulationFlow | repeated | |
| bandwidth_limit_mbit | double | | |
| max_queue_size | uint32 | optional | |
TagDemux
TagDemux.TaggedOutput
| Field | Type | Label | Description |
|---|
| name | string | | |
| tag | int32 | | |
Tcp
| Field | Type | Label | Description |
|---|
| input | string | optional | |
| output | string | optional | |
| listen_address | string | optional | |
| remote_address | string | optional | |
| application_facing | bool | | |
Tun
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| interface_name | string | | |
| ip | string | | |
| netmask | string | optional | |
| is_default_route | bool | optional | |
| generic_offload | bool | optional | |
| mtu | uint32 | optional | |
FlowFilter
| Field | Type | Label | Description |
|---|
| input | string | | |
| match_output | string | | |
| mismatch_output | string | | |
| filters | FlowFilterFilter | repeated | |
FlowFilterCondition
Possible filter conditions currently only IPv4 is supported.
| Field | Type | Label | Description |
|---|
| layer3_protocol | FlowFilterLayer3ProtocolCondition | | |
| layer3_source_ip | string | | |
| layer3_destination_ip | string | | |
| layer4_source_port | uint32 | | |
| layer4_destination_port | uint32 | | |
FlowFilterFilter
A set of filter conditions that need to match
FlowFilterLayer3ProtocolCondition
Possible transport protocols to match on
| Name | Number | Description |
|---|
| TCP | 0 | |
| UDP | 1 | |
LatencyTrackerReceiver
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| sampling_interval_ms | uint32 | optional | |
| latency_budget | int32 | optional | |
BandwidthLimitDynamic
BandwidthLimitPhase
| Field | Type | Label | Description |
|---|
| duration | uint32 | | |
| bandwidth_limit_mbit | double | | |
NotificationInjector
Command
Command to be executed.
| Field | Type | Label | Description |
|---|
| cmd | string | | Command to execute. |
| cwd | string | optional | Current working directory for the command. |
| policy | CommandExecutionPolicy | | Policy for executing the command. |
| timeout | uint32 | optional | Timeout for command execution in milliseconds. If not specified will default to 10 sec. |
| env | Environment | optional | Environment variables for the command. |
Environment
Environment variables.
| Field | Type | Label | Description |
|---|
| vars | Environment.VarsEntry | repeated | Mapping of environment variable names to their values. |
Environment.VarsEntry
| Field | Type | Label | Description |
|---|
| key | string | | |
| value | string | | |
LifecycleHandler
Handler for lifecycle events.
| Field | Type | Label | Description |
|---|
| env | Environment | optional | Global environment variables for lifecycle events. |
| on_setup | Command | repeated | Commands to execute during setup. |
| pre_start | Command | repeated | Commands to execute before starting the pipeline. |
| post_start | Command | repeated | Commands to execute after starting the pipeline. |
| pre_stop | Command | repeated | Commands to execute before stopping the pipeline. |
| post_stop | Command | repeated | Commands to execute after stopping the pipeline. |
CommandExecutionPolicy
Policies for executing commands.
| Name | Number | Description |
|---|
| STOP_ON_ERROR | 0 | Stop the pipeline if the command fails. |
| CONTINUE_ON_ERROR | 1 | Continue executing the pipeline if the command fails. |
| RUN_IN_BACKGROUND | 2 | Run the command in the background. If you use this policy in a post_stop command, the process will be killed immediately after launch |
Defragmentizer
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
PeerRouter
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
ClientIDWriter
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| client_id | uint32 | | |
BandwidthTracker
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| window_ms | uint32 | optional | |
| buckets | uint32 | optional | |
SimulatedNetwork
| Field | Type | Label | Description |
|---|
| input | string | optional | |
| output | string | optional | |
| mtu | int32 | optional | |
| network_name | string | | |
| receivers | string | repeated | |
EmulationFlow
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
TrafficSink
| Field | Type | Label | Description |
|---|
| input | string | | |
| mtu | int32 | | |
| latency_budget | uint32 | optional | |
| timeout_ms | uint32 | optional | |
ConstantAuthSign
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| constant | uint64 | | |
SessionReader
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
Gate
Observer
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
ReedSolomonDecoder
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
Parity2dDecoder
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
LossDynamic
LossPhase
| Field | Type | Label | Description |
|---|
| duration | uint32 | | |
| loss_probability | double | | |
Fragmentizer
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| fragment_size | uint32 | optional | |
RelyEncoder
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| timeout | int32 | | |
| max_payloads | int32 | | |
| repair_time_window | int32 | | |
| repair_target_rate | double | | |
SessionWriter
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
BoringSSLEncrypt
UdpRemote
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | optional | |
| mtu | int32 | optional | |
| interface | string | optional | |
| backend | UdpBackend | optional | |
UdpBackend
| Name | Number | Description |
|---|
| GENERIC | 0 | |
| LINUX_NO_GRO | 1 | |
| LINUX | 2 | |
LossConstant
| Field | Type | Label | Description |
|---|
| flows | EmulationFlow | repeated | |
| loss_probability | double | | |
| seed | int32 | optional | |
SporadicTrafficSource
| Field | Type | Label | Description |
|---|
| output | string | | |
| total_packets | uint32 | | |
| min_packets | uint32 | | |
| max_packets | uint32 | | |
| min_idle | uint32 | | |
| max_idle | uint32 | | |
| min_packet_size | uint32 | optional | |
| max_packet_size | uint32 | optional | |
| seed | uint32 | optional | |
BoringSSLPoly1305Signer
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| shared_secret | string | | |
LossGilbertElliot
| Field | Type | Label | Description |
|---|
| flows | EmulationFlow | repeated | |
| good_loss_probability | double | | |
| bad_loss_probability | double | | |
| good_to_bad_probability | double | | |
| bad_to_good_probability | double | | |
| seed | int32 | optional | |
TraceTrafficSource
| Field | Type | Label | Description |
|---|
| output | string | | |
| trace_file | string | | |
| loops | uint32 | optional | |
| loop_delay | uint32 | optional | |
| seed | uint32 | optional | |
RelayNetworkLookup
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
RlncDecoder
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
ConstantAuthVerify
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| constant | uint64 | | |
Bomb
| Field | Type | Label | Description |
|---|
| delay | uint32 | | |
| poison | Poison | | |
Poison
| Name | Number | Description |
|---|
| NONE | 0 | |
| VERIFY_FAIL | 1 | |
| ASSERT_FAIL | 2 | |
| THROW_EXCEPTION | 3 | |
| LOG_FATAL | 4 | |
UdpLocal
| Field | Type | Label | Description |
|---|
| input | string | optional | |
| output | string | | |
| mtu | int32 | optional | |
| address | string | | |
| interface | string | optional | |
| backend | UdpBackend | optional | |
ClientIDReader
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| client_id | uint32 | | |
Aes128GcmSha256
| Field | Type | Label | Description |
|---|
| key | string | | |
Aes256GcmSha384
| Field | Type | Label | Description |
|---|
| key | string | | |
Chacha20Poly1305Sha256
| Field | Type | Label | Description |
|---|
| key | string | | |
UnixSocket
UnixSocketClientOptions
| Field | Type | Label | Description |
|---|
| server_address | string | | |
| bind_address | int32 | | |
UnixSocketServerOptions
| Field | Type | Label | Description |
|---|
| listen_address | string | | |
BandwidthTrafficSource
| Field | Type | Label | Description |
|---|
| output | string | | |
| bandwidth_mbit | double | | |
| duration_ms | uint32 | | |
| min_packet_size | uint32 | optional | |
| max_packet_size | uint32 | optional | |
| seed | uint32 | optional | |
LatencyTrackerSender
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
UdpMulticastListener
| Field | Type | Label | Description |
|---|
| output | string | | |
| multicast_group | string | | |
| interface | string | | |
| local_address | string | | |
| mtu | int32 | optional | |
UdpMulticastSender
| Field | Type | Label | Description |
|---|
| multicast_ttl | uint32 | optional | |
| local_loopback | bool | optional | |
| input | string | | |
| interface | string | | |
| local_address | string | | |
| mtu | int32 | optional | |
RelayRoutingFabric
RelayRoutingFabric.RouteEntry
| Field | Type | Label | Description |
|---|
| client_id | uint32 | | |
| route | string | | |
RelayRoutingFabricType
RtpObserver
| Field | Type | Label | Description |
|---|
| input | string | | |
| output | string | | |
| force_offset | int32 | optional | |
TagMux
| Field | Type | Label | Description |
|---|
| name | string | | |
| tag | int32 | | |
Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|---|
| double | | double | double | float | float64 | double | float | Float |
| float | | float | float | float | float32 | float | float | Float |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |