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

com.influxdata.telegraf.plugins.outputs.OpenTelemetryOutput1.4.0

Overview
Properties
Methods
Classes

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

Sends metrics to OpenTelemetry servers and agents via gRPC.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf@1.4.0#/plugins/outputs/OpenTelemetryOutput.pkl
Pkl version:: 0.24.0 or higher
Source code:: OpenTelemetryOutput.pkl
Known subtypes:
Known usages:: Outputs
All versions:: 1.4.0, 1.3.0, 1.2.1, 1.2.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

service_address: String?Source

The endpoint to which the metrics will be sent.

Default: "localhost:4317"
link

timeout: Duration?Source

The timeout for the connection.

Default: 5.s
link

tls_ca: String?Source

Optional TLS Config. All variables should specify full path to the file. Root certificates for verifying server certificates encoded in PEM format.
link

tls_cert: String?Source

Path to the TLS certificate for the client encoded in PEM format. May contain intermediate certificates.
link

tls_key: String?Source

Path to the TLS private key for the client encoded in PEM format.
link

tls_server_name: String?Source

Send the specified TLS server name via SNI.
link

insecure_skip_verify: Boolean?Source

Insecure option to skip TLS server cert verification.

Warning: it is insecure to enable this option. If enabled, crypto/tls accepts any certificate presented by the server and any host name in that certificate.

Default: false
link

coralogix: Coralogix?Source

Send data to a Coralogix server.
link

compression: ("none"|"gzip")?Source

Set the compression method used to send data.

Default: "none"
link

attributes: Mapping<String, String>?Source

Additional OpenTelemetry resource attributes
link

headers: Mapping<String, String>?Source

Additional gRPC request metadata headers

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

Classes

link

class

Coralogix Source