Packages > pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf

com.influxdata.telegraf.plugins.inputs.SocketListenerInput1.2.1

Overview
Properties
Methods

open module com.influxdata.telegraf.plugins.inputs.SocketListenerInput extends com.influxdata.telegraf.plugins.inputs.Input

The Socket Listener is a service input plugin that listens for messages from streaming (tcp, unix) or datagram (udp, unixgram) protocols.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf@1.2.1#/plugins/inputs/SocketListenerInput.pkl
Pkl version:: 0.25.0 or higher
Source code:: SocketListenerInput.pkl
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

namepass: Listing<String>? (com.influxdata.telegraf.plugins.Plugin)

An array of glob pattern strings.

Only metrics whose measurement name matches a pattern in this list are emitted.
link

namedrop: Listing<String>? (com.influxdata.telegraf.plugins.Plugin)

The inverse of namepass.

If a match is found the metric is discarded. This is tested on metrics after they have passed the namepass test.
link

tagpass: Mapping<String, Listing<String>>? (com.influxdata.telegraf.plugins.Plugin)

A table mapping tag keys to arrays of glob pattern strings.

Only metrics that contain a tag key in the table and a tag value matching one of its patterns is emitted.
link

tagdrop: Mapping<String, Listing<String>>? (com.influxdata.telegraf.plugins.Plugin)

The inverse of tagpass.

If a match is found the metric is discarded. This is tested on metrics after they have passed the tagpass test.
link

fieldpass: Listing<String>? (com.influxdata.telegraf.plugins.Plugin)

An array of glob pattern strings.

Only fields whose field key matches a pattern in this list are emitted.
link

fielddrop: Listing<String>? (com.influxdata.telegraf.plugins.Plugin)

The inverse of fieldpass.

Fields with a field key matching one of the patterns will be discarded from the metric. This is tested on metrics after they have passed the fieldpass test.
link

taginclude: Listing<String>? (com.influxdata.telegraf.plugins.Plugin)

An array of glob pattern strings.

Only tags with a tag key matching one of the patterns are emitted. In contrast to tagpass, which will pass an entire metric based on its tag, taginclude removes all non matching tags from the metric. Any tag can be filtered including global tags and the agent host tag.
link

tagexclude: Listing<String>? (com.influxdata.telegraf.plugins.Plugin)

The inverse of taginclude.

Tags with a tag key matching one of the patterns will be discarded from the metric. Any tag can be filtered including global tags and the agent host tag
link

interval: Duration? (com.influxdata.telegraf.plugins.inputs.Input)

How often to gather this metric.

Normal plugins use a single global interval, but if one particular input should be run less or more often, you can configure that here.
link

name_override: String? (com.influxdata.telegraf.plugins.inputs.Input)

Override the base name of the measurement.

Default: name of the input
link

name_prefix: String? (com.influxdata.telegraf.plugins.inputs.Input)

Specifies a prefix to attach to the measurement name.
link

name_suffix: String? (com.influxdata.telegraf.plugins.inputs.Input)

Specifies a suffix to attach to the measurement name.
link

tags: Mapping<String, String>? (com.influxdata.telegraf.plugins.inputs.Input)

A map of tags to apply to a specific input’s measurements.

link

service_address: Uri Source

URL to listen on.

Examples:

service_address = "tcp://:8094"
service_address = "tcp://127.0.0.1:http"
service_address = "tcp4://:8094"
service_address = "tcp6://:8094"
service_address = "tcp6://[2001:db8::1]:8094"
service_address = "udp://:8094"
service_address = "udp4://:8094"
service_address = "udp6://:8094"
service_address = "unix:///tmp/telegraf.sock"
service_address = "unixgram:///tmp/telegraf.sock"

link
socket_mode: String?Source

Change the file mode bits on unix sockets.
These permissions may not be respected by some platforms. To safely restrict write permissions, it is best to place the socket into a directory that has previously been created with the desired permissions.

Example:
```
socket_mode = "777"
```
link

max_connections: UInt16?Source

Maximum number of concurrent connections.

Only applies to stream sockets (e.g. TCP). 0 (default) is unlimited.

Default: 1024
link

read_timeout: Duration?Source

Read timeout. Only applies to stream sockets (e.g. TCP). 0 (default) is unlimited.

Default: 30.s
link

tls_cert: String?Source

Optional TLS configuration.

Only applies to stream sockets (e.g. TCP).
link

tls_key: String?Source
link
tls_allowed_cacerts: Listing<String>?Source

Enables client authentication if set.
Example:
```
tls_allowed_cacerts { "/etc/telegraf/clientca.pem" }
```
link

read_buffer_size: DataSize?Source

Maximum socket buffer size (in bytes when no unit specified).

For stream sockets, once the buffer fills up, the sender will start backing up. For datagram sockets, once the buffer fills up, metrics will start dropping.

Default: OS default
link

keep_alive_period: Duration?Source

Period between keep alive probes.

Only applies to TCP sockets. 0 disables keep alive probes.

Default: OS configuration
link

data_format: InputDataFormat?Source

Data format to consume.

Each data format has its own unique set of configuration options, read more about them here: https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
link

content_encoding: ("gzip"|"identity")?Source

Content encoding for message payloads.

Can be set to "gzip" to or "identity" to apply no encoding.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```