PutSplunkHTTP

PutSplunkHTTP 2.0.0

Bundle: org.apache.nifi | nifi-splunk-nar
Description: Sends flow file content to the specified Splunk server over HTTP or HTTPS. Supports HEC Index Acknowledgement.
Tags: http, logs, splunk
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Character Set
The name of the character set.

Display Name

Character Set

Description

The name of the character set.

API Name

character-set

Default Value

UTF-8

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Content Type
The media type of the event sent to Splunk. If not set, "mime.type" flow file attribute will be used. In case of neither of them is specified, this information will not be sent to the server.

Display Name

Content Type

Description

The media type of the event sent to Splunk. If not set, "mime.type" flow file attribute will be used. In case of neither of them is specified, this information will not be sent to the server.

API Name

content-type

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Host
Specify with the host query string parameter. Sets a default for all events when unspecified.

Display Name

Host

Description

Specify with the host query string parameter. Sets a default for all events when unspecified.

API Name

host

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Hostname
The ip address or hostname of the Splunk server.

Display Name

Hostname

Description

The ip address or hostname of the Splunk server.

API Name

Hostname

Default Value

localhost

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Index
Index name. Specify with the index query string parameter. Sets a default for all events when unspecified.

Display Name

Index

Description

Index name. Specify with the index query string parameter. Sets a default for all events when unspecified.

API Name

index

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Owner
The owner to pass to Splunk.

Display Name

Owner

Description

The owner to pass to Splunk.

API Name

Owner

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Password
The password to authenticate to Splunk.

Display Name

Password

Description

The password to authenticate to Splunk.

API Name

Password

Expression Language Scope

Not Supported

Sensitive

true

Required

false
HTTP Event Collector Port
The HTTP Event Collector HTTP Port Number.

Display Name

HTTP Event Collector Port

Description

The HTTP Event Collector HTTP Port Number.

API Name

Port

Default Value

8088

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Splunk Request Channel
Identifier of the used request channel.

Display Name

Splunk Request Channel

Description

Identifier of the used request channel.

API Name

request-channel

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Scheme
The scheme for connecting to Splunk.
Display Name

Scheme

Description

The scheme for connecting to Splunk.

API Name

Scheme

Default Value

https

Allowable Values
- https
- http
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Security Protocol
The security protocol to use for communicating with Splunk.
Display Name

Security Protocol

Description

The security protocol to use for communicating with Splunk.

API Name

Security Protocol

Default Value

TLSv1_2

Allowable Values
- TLSv1_2
- TLSv1_1
- TLSv1
- SSLv3
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Source
User-defined event source. Sets a default for all events when unspecified.

Display Name

Source

Description

User-defined event source. Sets a default for all events when unspecified.

API Name

source

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Source Type
User-defined event sourcetype. Sets a default for all events when unspecified.

Display Name

Source Type

Description

User-defined event sourcetype. Sets a default for all events when unspecified.

API Name

source-type

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
HTTP Event Collector Token
HTTP Event Collector token starting with the string Splunk. For example 'Splunk 1234578-abcd-1234-abcd-1234abcd'

Display Name

HTTP Event Collector Token

Description

HTTP Event Collector token starting with the string Splunk. For example 'Splunk 1234578-abcd-1234-abcd-1234abcd'

API Name

Token

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Username
The username to authenticate to Splunk.

Display Name

Username

Description

The username to authenticate to Splunk.

API Name

Username

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

System Resource Considerations

Resource	Description
MEMORY	An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.

Relationships

Name	Description
success	FlowFiles that are sent successfully to the destination are sent to this relationship.
failure	FlowFiles that failed to send to the destination are sent to this relationship.

Reads Attributes

Name	Description
mime.type	Uses as value for HTTP Content-Type header if set.

Writes Attributes

Name	Description
splunk.acknowledgement.id	The indexing acknowledgement id provided by Splunk.
splunk.responded.at	The time of the response of put request for Splunk.