Apache NiFi GetProcessGroupStatus
CertifiedGet the status of an Apache NiFi Process Group
Apache NiFi GetProcessGroupStatus
Get the status of an Apache NiFi Process Group
Fetches the current aggregate status and metrics (queued FlowFiles, queued bytes, and active threads) of a specified NiFi Process Group.
type: io.kestra.plugin.nifi.GetProcessGroupStatusExamples
Fetch the aggregate status of the root Process Group in NiFi
id: nifi_process_group_status
namespace: company.team
tasks:
- id: get_root_status
type: io.kestra.plugin.nifi.GetProcessGroupStatus
url: "https://localhost:8443"
username: "nifi-admin"
password: "{{ secret('NIFI_PASSWORD') }}"
sslVerify: false
processGroupId: "root"
Properties
processGroupId *string
The Process Group ID
The unique identifier of the NiFi Process Group to retrieve status for. Can be a specific Process Group UUID or 'root' for the root group.
url *string
The Apache NiFi base URL
The fully qualified URL pointing to your Apache NiFi cluster or instance (e.g., https://localhost: 8443 or http://localhost: 8080).
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150password string
The password for NiFi authentication
sslVerify booleanstring
trueWhether to verify SSL certificates
Set to false to disable SSL verification (e.g., for self-signed certificates).
username string
The username for NiFi authentication
Outputs
activeThreadCount integer
The number of active threads in the Process Group
Aggregate count of active threads executing tasks across all components in this Process Group.
queuedBytes integer
The total size of FlowFiles queued in the Process Group (in bytes)
Aggregate byte size of all FlowFiles currently queued across all queues within this Process Group.
queuedCount integer
The number of FlowFiles queued in the Process Group
Aggregate count of all FlowFiles currently queued across all queues within this Process Group.
