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

com.influxdata.telegraf.plugins.inputs.PrometheusInput1.4.0

Properties
Methods

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

The prometheus input plugin gathers metrics from HTTP servers exposing metrics in Prometheus format.

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

urls: Listing<String>Source

An array of urls to scrape metrics from.
link

url_tag: String?Source

Tag name for the scrapped url.

Optional, default is "url".
link
metric_version: Int(isBetween(1, 2))?Source

Metric version controls the mapping from Prometheus metrics into Telegraf metrics.
When using the prometheus_client output, use the same value in both plugins to ensure metrics are round-tripped without modification.

Examples:
```
metric_version = 1 // deprecated in 1.13
metric_version = 2 // recommended version
```
link

kubernetes_services: Listing<String>?Source

An array of Kubernetes services to scrape metrics from.
link

kube_config: String?Source

Kubernetes config file to create client from.
link
monitor_kubernetes_pods: Boolean?Source

Scrape Kubernetes pods for the following prometheus annotations:
- prometheus.io/scrape: Enable scraping for this pod.
- prometheus.io/scheme: If the metrics endpoint is secured then you will need to set this to https and most likely set the tls config.
- prometheus.io/path: If the metrics path is not /metrics, define it with this annotation.
- prometheus.io/port: If port is not 9102 use this annotation.
link
pod_scrape_scope: ("cluster"|"node")?Source

Get the list of pods to scrape given the following scope.
Possible values:
- cluster: the kubernetes watch api (default, no need to specify)
- node: the local cadvisor api; for scalability. Note that the config node_ip or the environment variable NODE_IP must be set to the host IP.
link

node_ip: String(pod_scrape_scope == "node")?Source

Only for node scrape scope: node IP of the node that telegraf is running on.

Either this config or the environment variable NODE_IP must be set.
link

monitor_kubernetes_pods_namespace: String?Source

Restricts Kubernetes monitoring to a single namespace

Example: monitor_kubernetes_pods_namespace = "default"
link

kubernetes_field_selector: String?Source

Label selector to target pods which have the label.

Field selector to target pods, e.g., to scrape pods on a specific node: kubernetes_field_selector = "env=dev,app=nginx"
link

bearer_token: String?Source

Use bearer token for authorization (bearer_token takes priority).

Path to the bearer token file.
link

bearer_token_string: String?Source

Use bearer token for authorization (bearer_token takes priority).
link

username: String?Source

HTTP Basic Authentication username and password (bearer_token and bearer_token_string take priority).
link

password: String?Source
link

response_timeout: Duration?Source

Specify timeout duration for slower prometheus clients.

Default: 3.s
link

tls_ca: String?Source

Optional TLS CA.
link

tls_cert: String?Source

Optional TLS certificate.
link

tls_key: String?Source

Optional TLS private key.
link

insecure_skip_verify: Boolean?Source

Use TLS but skip chain & host verification.

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