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

com.influxdata.telegraf.plugins.outputs.PrometheusClientOutput1.5.0

Properties
Methods

open module com.influxdata.telegraf.plugins.outputs.PrometheusClientOutput extends com.influxdata.telegraf.plugins.outputs.Output

This plugin starts a Prometheus Client, it exposes all metrics on /metrics (default) to be polled by a Prometheus server.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf@1.5.0#/plugins/outputs/PrometheusClientOutput.pkl
Pkl version:: 0.25.0 or higher
Source code:: PrometheusClientOutput.pkl
Known subtypes:
Known usages:: Outputs
All versions:: 1.5.0, 1.4.0, 1.3.0, 1.2.1, 1.2.0, 1.1.1, 1.1.0, 1.0.1, 1.0.0

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

alias: String? (com.influxdata.telegraf.plugins.outputs.Output)

Name an instance of a plugin.
link

flush_interval: Duration? (com.influxdata.telegraf.plugins.outputs.Output)

The maximum time between flushes.

Use this setting to override the agent flush_interval on a per plugin basis.
link

flush_jitter: Duration? (com.influxdata.telegraf.plugins.outputs.Output)

The amount of time to jitter the flush interval.

Use this setting to override the agent flush_jitter on a per plugin basis.
link

metric_batch_size: Number? (com.influxdata.telegraf.plugins.outputs.Output)

The maximum number of metrics to send at once.

Use this setting to override the agent metric_batch_size on a per plugin basis.
link

metric_buffer_limit: Number? (com.influxdata.telegraf.plugins.outputs.Output)

The maximum number of unsent metrics to buffer.

Use this setting to override the agent metric_buffer_limit on a per plugin basis.
link

name_override: String? (com.influxdata.telegraf.plugins.outputs.Output)

Override the original name of the measurement.
link

name_prefix: String? (com.influxdata.telegraf.plugins.outputs.Output)

Specifies a prefix to attach to the measurement name.
link

name_suffix: String? (com.influxdata.telegraf.plugins.outputs.Output)

Specifies a suffix to attach to the measurement name.
link

listen: String?Source

Address to listen on.
link

metric_version: Int(isBetween(1,2))?Source

Metric version controls the mapping from Prometheus metrics into Telegraf metrics.

See "Metric Format Configuration" in plugins/inputs/prometheus/README.md for details. Defaults to 1.
link

basic_username: String?Source

Username for optional basic authentication.
link

basic_password: String?Source

Password for optional basic authentication.
link

ip_range: Listing<String>?Source

If set, the IP Ranges which are allowed to access metrics.

Defaults to no restrictions.
link

path: String?Source

Path to publish the metrics on.

Defaults to /metrics.
link

expiration_interval: Duration?Source

Expiration interval for each metric.

Set to 0 for no expiration. Defaults to 60 seconds.
link

collectors_exclude: Listing<("gocollector"|"process")>(isDistinct)?Source

Collectors to disable, valid entries are "gocollector" and "process".

Defaults to gocollector' and process' being enabled.
link

string_as_label: Boolean?Source

Send string metrics as Prometheus labels.

Defaults to true.
link

tls_cert: String?Source

Path to certificate for optional TLS.
link

tls_key: String?Source

Path to key for optional TLS.
link

tls_allowed_cacerts: Listing<String>?Source

Path to CA Certificate files to enable optional mTLS.
link

export_timestamp: Boolean?Source

Export metric collection time.

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