Plugin Helper: Socket
The
socket
plugin helper creates various types of socket instances.Here is an example:
require 'fluent/plugin/output'
module Fluent::Plugin
class ExampleOutput < Output
Fluent::Plugin.register_output('example', self)
# 1. Load socket helper
helpers :socket
config_param :host, :string
config_param :port, :integer
# Omit `configure`, `shutdown` and other plugin APIs
def try_write(chunk)
# 2. Create socket
socket = socket_create(:tcp, @host, @port)
chunk.each do |time, record|
# 3. Write data to socket
socket.write(record.to_json)
end
ensure
# 4. Close socket
socket.close if socket
end
end
end
The
socket
plugin helper does not manage the lifecycle of the socket. User must close the socket when it is no longer needed.This method creates a socket instance with the given protocol type.
If the block is given, it will be invoked with the socket instance as a parameter, and the socket will automatically be closed when the block terminates.
proto
: protocol type. {:tcp
,:udp
,:tls
}host
: host name or IP addressport
: port numberkwargs
: extra options. For more details, see methods below.block
: customize socket
Code example:
# TCP
socket = socket_create(:tcp, 'example.com', 12340)
socket.write(data)
socket.close
# UDP
socket = socket_create(:udp, 'example.com', 12341)
socket.write(data)
socket.close
# TLS
socket = socket_create(:tls, 'example.com', 12342, insecure: true)
socket.write(data)
socket.close
# close socket automatically
socket_create(:udp, 'example.com', 12341) do |sock|
sock.write(data)
end
This method creates socket instance for TCP.
If the block is given, it will be invoked with the socket instance as a parameter, and the socket will automatically be closed when the block terminates.
host
: hostname or IP addressport
: port numberkwargs
: extra optionsresolve_name
: iftrue
, resolve the hostnamenonblock
: iftrue
, use non-blocking I/Olinger_timeout
: the timeout (seconds) to setSO_LINGER
recv_timeout
: the timeout (seconds) to setSO_RECVTIMEO
send_timeout
: the timeout (seconds) to setSO_SNDTIMEO
send_keepalive_packet
: iftrue
, enable TCP keep-alive viaSO_KEEPALIVE
connect_timeout
: the timeout for socket connect. When the connectiontimed out during establishment,Errno::ETIMEDOUT
is raised.
If you set
true
to send_keepalive_packet
, you also need to configure keep-alive related kernel parameters:net.ipv4.tcp_keepalive_intvl = 75
net.ipv4.tcp_keepalive_probes = 5
net.ipv4.tcp_keepalive_time = 7200
This parameter mitigates half-open connection issue with load balancers. Check also this issue for AWS NLB case.
This method creates socket instance for UDP.
If block is given, it will be invoked with the socket instance as a parameter, and socket will automatically be closed when the block terminates.
host
: host name or IP addressport
: port numberkwargs
: extra optionsresolve_name
: iftrue
, resolve the hostnameconnect
: iftrue
, connect to hostnonblock
: iftrue
, use non-blocking I/Olinger_timeout
: the timeout (seconds) to setSO_LINGER
recv_timeout
: the timeout (seconds) to setSO_RECVTIMEO
send_timeout
: the timeout (seconds) to setSO_SNDTIMEO
This method creates socket instance for TLS.
If block is given, it will be invoked with the socket instance as a parameter, and socket will automatically be closed when the block terminates.
host
: host name or IP addressport
: port numberkwargs
: extra optionsversion
: set TLS version:TLSv1_1
or:TLSv1_2
. (default::TLSv1_2
)ciphers
: set the list of available cipher suites. (default:"ALL:!aNULL:!eNULL:!SSLv2"
)insecure
: iftrue
, set TLS verify modeNONE
verify_fqdn
: iftrue
, validate the server certificate for the hostnamefqdn
: set FQDNenable_system_cert_store
: iftrue
, enable system default cert storeallow_self_signed_cert
: iftrue
, allow self-signed certificatecert_paths
: files contain PEM-encoded certificatesprivate_key_path
: set the client private key pathprivate_key_passphrase
: set the client private key passphrasecert_thumbprint
: set the certificate thumbprint for searching from Windows system certstorecert_logical_store_name
: set the certificate logical store name on Windows system certstorecert_use_enterprise_store
: iftrue
, enable to use certificate enterprise store on Windows system certstore- Support more parameters same as socket_create_tcp's
kwargs
If this article is incorrect or outdated, or omits critical information, please let us know. Fluentd is an open-source project under Cloud Native Computing Foundation (CNCF). All components are available under the Apache 2 License.
Last modified 2yr ago