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

com.influxdata.telegraf.plugins.inputs.DockerInput1.8.0

Overview
Properties
Methods
Type Aliases

module com.influxdata.telegraf.plugins.inputs.DockerInput extends com.influxdata.telegraf.plugins.inputs.Input

The Docker input plugin uses the Docker Engine API to gather metrics on running Docker containers.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf@1.8.0#/plugins/inputs/DockerInput.pkl
Pkl version:: 0.25.0 or higher
Source code:: DockerInput.pkl
Known subtypes in package:
Known usages in package:
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

endpoint: String?Source

Endpoint, either tcp://<ip>:<port> for TCP, unix://<path> for socket or ENV for using environment variables (i.e., docker-machine)

Default: unix:///var/run/docker.sock
link

gather_services: Boolean?Source

Collect Swarm metrics (desired_replicas, running_replicas) Note: Configure this for one of the manager nodes in a Swarm cluster only as you will see duplicate metrics otherwise.

Default: false
link

source_tag: Boolean?Source

Use container ID hostname as source (trimmed to 12 characters)

Default: false
link

container_name_include: Listing<String>?Source

Containers to include, accepting wildcards; all if empty.

Default: []
link

container_name_exclude: Listing<String>?Source

Containers to exclude, accepting wildcards.

Default: []
link

container_state_include: Listing<ContainerState>?Source

Container states to include accepting wildcards.

Default: ["running"]
link

container_state_exclude: Listing<ContainerState>?Source

Container states to exclude accepting wildcards.

Default: []
link

storage_objects: Listing<StorageObject>?Source

Objects to include for disk usage query.

Default: []
link

timeout: Duration?Source

Timeout for docker list, info, and stats commands.

Default: 5.s
link

podman_cache_ttl: Duration?Source

Podman compatibility settings (auto-enabled when Podman detected). Cache TTL for accurate CPU percentage calculation. Should be higher than your collection interval for accurate measurements. Zero will keep cache entries forever (not recommended for dynamic environments).

Default: 60.s
link

perdevice_include: Listing<PerDeviceClass>?Source

Emit per-device metric for the given classes.

Default: ["cpu"]
link

total_include: Listing<PerDeviceClass>?Source

Which class metrics should be issued as 'total' values.

Default: ["cpu", "blkio", "network"]
link

docker_label_include: Listing<String>?Source

Container labels to include as tags accepting wildcards; all if empty.

Default: []
link

docker_label_exclude: Listing<String>?Source

Container labels to exclude as tags, accepting wildcards.

Default: []
link

tag_env: Listing<String>?Source

Which environment variables should we use as a tag

Default: []
link

tls_ca: String?Source

TLS CA cert.
link

tls_cert: String?Source

TLS client cert.
link

tls_key: String?Source

TLS client key.
link

insecure_skip_verify: Boolean?Source

Use TLS but skip chain & host verification.

Default: false

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)
```

Type Aliases

link

typealias

PerDeviceClass = "cpu"|"blkio"|"network"Source
link

typealias

ContainerState = "created"|"restarting"|"running"|"removing"|"paused"|"exited"|"dead"Source
link

typealias

StorageObject = "container"|"image"|"volume"Source