QuerySplunkIndexingStatus

QuerySplunkIndexingStatus 2.0.0

Bundle: org.apache.nifi | nifi-splunk-nar
Description: Queries Splunk server in order to acquire the status of indexing acknowledgement.
Tags: acknowledgement, http, logs, splunk
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

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
Maximum Query Size
The maximum number of acknowledgement identifiers the outgoing query contains in one batch. It is recommended not to set it too low in order to reduce network communication.

Display Name

Maximum Query Size

Description

The maximum number of acknowledgement identifiers the outgoing query contains in one batch. It is recommended not to set it too low in order to reduce network communication.

API Name

max-query-size

Default Value

10000

Expression Language Scope

Not Supported

Sensitive

false

Required

true
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
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
Maximum Waiting Time
The maximum time the processor tries to acquire acknowledgement confirmation for an index, from the point of registration. After the given amount of time, the processor considers the index as not acknowledged and transfers the FlowFile to the "unacknowledged" relationship.

Display Name

Maximum Waiting Time

Description

The maximum time the processor tries to acquire acknowledgement confirmation for an index, from the point of registration. After the given amount of time, the processor considers the index as not acknowledged and transfers the FlowFile to the "unacknowledged" relationship.

API Name

ttl

Default Value

1 hour

Expression Language Scope

Not Supported

Sensitive

false

Required

true
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

Relationships

Name	Description
success	A FlowFile is transferred to this relationship when the acknowledgement was successful.
unacknowledged	A FlowFile is transferred to this relationship when the acknowledgement was not successful. This can happen when the acknowledgement did not happened within the time period set for Maximum Waiting Time. FlowFiles with acknowledgement id unknown for the Splunk server will be transferred to this relationship after the Maximum Waiting Time is reached.
undetermined	A FlowFile is transferred to this relationship when the acknowledgement state is not determined. FlowFiles transferred to this relationship might be penalized. This happens when Splunk returns with HTTP 200 but with false response for the acknowledgement id in the flow file attribute.
failure	A FlowFile is transferred to this relationship when the acknowledgement was not successful due to errors during the communication. FlowFiles are timing out or unknown by the Splunk server will transferred to "undetermined" relationship.

Reads 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.