Network

The network sink is a socket-based sink that facilitates sending byte data over the network via protocols such as UDP or TCP. It supports Helm-based auto-configuration.

JAVAYAML

NetworkStreamSinkConfigurator sinkConfig = new NetworkStreamSinkConfigurator()
   .withType(NetworkType.UDP)
   .withAddress("127.0.0.1:3000");

sink:
  network:
    type: udp
    address: 10.11.12.13:34567

Java dependency management

Add this declaration to your dependency management system to access the configuration DSL for this plugin in Java.

MavenGradle

<dependency>
    <groupId>org.voltdb</groupId>
    <artifactId>volt-stream-plugin-network-api</artifactId>
    <version>1.8.0</version>
</dependency>

implementation group: 'org.voltdb', name: 'volt-stream-plugin-network-api', version: '1.8.0'

Properties

type

Specifies the network protocol to use Required.

Type: object

Supported values: tcp, udp.

address

Sets the target address in the format host:port. Required.

Type: object

Fields of address:

address.host

Type: string

address.port

Type: number

address.hasBracketlessColons

Type: boolean

exceptionHandler

Allows a custom exception handler to process errors during execution. Type: object

JSON Schema

You can validate or explore the configuration using its JSON Schema.

Metrics

Network metrics

Metric enum: org.voltdb.stream.api.network.NetworkMetric

Prometheus name	Type	Description
voltsp_network_connections_total	gauge	Current number of active network connections.
voltsp_network_received_messages_total	gauge	Number of messages received by a source.
voltsp_network_sent_messages_total	gauge	Number of messages sent by a sink.
voltsp_network_received_bytes	counter	Number of bytes received by a network source.
voltsp_network_received_errors_total	counter	Number of errors while receiving network messages.
voltsp_network_sent_bytes	counter	Number of bytes sent by a network sink.
voltsp_network_sent_errors_total	counter	Number of errors while sending network messages.

Network tags

Tag enum: org.voltdb.stream.api.network.NetworkTag

Metrics reported by this component may include these tags. Not every metric includes every tag; tags are present only when they are relevant to the measurement.

Tag	Description
address	Network address associated with the connection.