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

com.influxdata.telegraf.plugins.outputs.HttpOutput1.6.0

Overview
Properties
Methods

module com.influxdata.telegraf.plugins.outputs.HttpOutput extends com.influxdata.telegraf.plugins.outputs.Output

The HTTP output plugin writes metrics to a HTTP endpoint.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf@1.6.0#/plugins/outputs/HttpOutput.pkl
Source code:: HttpOutput.pkl
Known subtypes in package:
Known usages in package:
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

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

url: String?Source

The address to send metrics to.
link

timeout: Duration?Source

Timeout for HTTP message.

Default: 5.s
link

method: "POST"|"PUT"|"PATCH"Source

HTTP method.
link

username: String?Source

HTTP Basic Auth credentials.
link

password: String?Source
link

client_id: String?Source

OAuth2 Client Credentials Grant
link

client_secret: String?Source
link

token_url: String?Source
link

audience: String?Source
link

scopes: Listing<String>?Source
link

google_application_credentials: String?Source

Goole API Auth
link

use_system_proxy: Boolean?Source

HTTP Proxy support
link

http_proxy_url: String?Source
link

tls_ca: String?Source

Optional TLS Config.
link

tls_cert: String?Source
link

tls_key: String?Source
link

insecure_skip_verify: Boolean?Source

Use TLS but skip chain & host verification.

Default: false
link

cookie_auth_url: String?Source

Optional Cookie authentication
link

cookie_auth_method: String?Source
link

cookie_auth_username: String?Source
link

cookie_auth_password: String?Source
link

cookie_auth_headers: String?Source
link

cookie_auth_body: String?Source
link

cookie_auth_renewal: Duration?Source

Cookie auth renewal interval.

E.g. "5m" If not set or set to "0", cookie will not be renewed.
link

data_format: OutputDataFormat?Source

Data format to output.

Each data format has its own unique set of configuration options, read more about them here: https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
link

use_batch_format: Boolean?Source

Use batch serialization format (default) instead of line based format.

Default: true Batch format is more efficient and should be used unless line based format is really needed.
link

content_encoding: String?Source

HTTP Content-Encoding for write request body.

Can be set to "gzip" to compress body or "identity" to apply no encoding.
link

max_idle_conn: UInt?Source

Maximum number of idle (keep-alive) connections across all hosts.

Zero means no limit.
link

max_idle_conn_per_host: UInt?Source

The maximum idle (keep-alive) connections to keep per-host.

If zero, default(2) will be is used.
link

idle_conn_timeout: UInt?Source

Maximum amount of time before idle connection is closed.

Zero means no limit.
link

region: String?Source

Amazon Region
link

aws_service: String?Source

Amazon Credentials

Amazon Credentials are not built unless the following aws_service setting is set to a non-empty string. It may need to match the name of the service output to as well
link
access_key: String?Source

Credentials configuration.
Credentials are loaded in the following order
1. Web identity provider credentials via STS if role_arn and web_identity_token_file are specified
2. Assumed credentials via STS if role_arn is specified
3. explicit credentials from 'access_key' and 'secret_key'
4. shared profile from 'profile'
5. environment variables
6. shared credentials file
7. EC2 Instance Profile
link

secret_key: String?Source
link

token: String?Source
link

role_arn: String?Source
link

web_identity_token_file: String?Source
link

role_session_name: String?Source
link

profile: String?Source
link

shared_credential_file: String?Source
link

non_retryable_statuscodes: List<UInt>?Source

Optional list of statuscodes (<200 or >300) upon which requests should not be retried.
link

headers: Mapping<String, String>?Source

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