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

com.influxdata.telegraf.Telegraf1.4.0

Overview
Properties
Methods
Classes

open module com.influxdata.telegraf.Telegraf

Definitions for a Telegraf configuration.

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

This API nests data formats as a child object of plugins. For instance, here is an example of a socket listener which uses the json data format:

import "package://pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf@<version>#/plugins/parsers/JsonInputDataFormat.pkl"

inputs {
  socket_listener {
    new {
      service_address = "tcp://:8085"
      data_format = new JsonInputDataFormat {
        json_query = "foo.bar"
        tag_keys {
          "my-tag-1"
          "my-tag-2"
        }
        json_name_key = "my_measurement"
        json_time_key = "time"
      }
    }
  }
}

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

agent: AgentConfig?Source

Telegraf has a few options you can configure under the agent section of the config.
link

outputs: Outputs?Source

Output plugins write metrics to a location.

Outputs commonly write to databases, network services, and messaging systems.
link

inputs: Inputs?Source

Input plugins gather and create metrics.

They support both polling and event driven operation.
link

processors: Processors?Source

Processor plugins process metrics as they pass through and immediately emit results based on the values they process.

For example, this could be printing all metrics or adding a tag to all metrics that pass through.
link

global_tags: Mapping<String, String>?Source

All metrics being gathered on this host will be tagged with the tags specified here.

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

open class

Outputs Source
link

open class

Inputs Source
link

open class

Processors Source
link

open class

AgentConfig Source