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

com.influxdata.telegraf.plugins.parsers.JsonInputDataFormat1.4.0

Overview
Properties
Methods

module com.influxdata.telegraf.plugins.parsers.JsonInputDataFormat extends com.influxdata.telegraf.plugins.parsers.InputDataFormat

The JSON data format parses a JSON object or an array of objects into metric fields.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf@1.4.0#/plugins/parsers/JsonInputDataFormat.pkl
Pkl version:: 0.25.0 or higher
Source code:: JsonInputDataFormat.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, 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

data_format: "json"Source
link

json_strict: Boolean?Source

When strict is true and a JSON array is being parsed, all objects within the array must be valid.

Default: true
link

json_query: String?Source

A GJSON path that specifies a specific chunk of JSON to be parsed.

If not specified, the whole document will be parsed.

GJSON query paths are described here: https://github.com/tidwall/gjson/tree/v1.3.0#path-syntax
link

tag_keys: Listing<String>?Source

An array of keys that should be added as tags.

Matching keys are no longer saved as fields. Supports wildcard glob matching.
link

json_string_fields: Listing<String>?Source

Array of glob pattern strings or booleans keys that should be added as string fields.
link

json_name_key: String?Source

The key to use as the measurement name.
link

json_time_key: String?Source

The key containing the time that should be used to create the metric.
link
json_time_format: ("unix"|"unix_ms"|"unix_us"|"unix_ns"|String)?Source

The time layout that should be used to interpret json_time_key.
The time must be "unix", "unix_ms", "unix_us", "unix_ns", or a time in the "reference time". To define a different format, arrange the values from the "reference time" in the example to match the format you will be using. For more information on the "reference time", visit https://golang.org/pkg/time/#Time.Format.

Examples:
```
json_time_format = "Mon Jan 2 15:04:05 -0700 MST 2006"
json_time_format = "2006-01-02T15:04:05Z07:00"
json_time_format = "01/02/2006 15:04:05"
json_time_format = "unix"
json_time_format = "unix_ms"
```
link
json_timezone: String?Source

Allows you to provide an override for timestamps that don't already include an offset, e.g., "04/06/2016 12:41:45".
Default: "" (renders UTC)

Options are as follows:
- "Local": interpret based on machine localtime
- "America/New_York": Unix TZ values like those found in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
- "UTC" (or blank/unspecified): will return timestamp in UTC

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