Apache NiFi MiNiFi is an Apache NiFi project, designed to collect data at its source. MiNiFi was developed with the following objectives in mind:
MiNiFi Java Agent is supported on the following operating systems:
You can download the MiNiFi Java Agent and the MiNiFi Toolkit from the MiNiFi download page.
You have several options for installing and starting MiNiFi.
To install MiNiFi:
You can also install MiNiFi as a service:
bin/minifi.sh install
Note: You can also specify a custom name for your MiNiFi installation, by specifying that name during your install command. For example, to install MiNiFi as a service and named dataflow, enter:
bin/minifi.sh install dataflow
Once you have downloaded and installed MiNiFi, you need to start MiNiFi. You can start NiFi in the foreground, background, or as a service.
To launch MiNiFi in the foreground:
bin/minifi.sh run
To launch MiNiFi in the background:
bin/minifi.sh start
To launch MiNiFi as a service:
sudo service minifi start
For Windows users, navigate to the folder where MiNiFi was installed. Navigate to the /bin
subdirectory and double-click the run-minifi.bat file.
This launches MiNiFi and leaves it running in the foreground. To shut down NiFi, select the window that was launched and hold the Ctrl key while pressing C.
When you are working with a MiNiFi dataflow, you should design it, add any additional configuration your environment or use case requires, and then deploy your dataflow. MiNiFi is not designed to accommodate substantial mid-dataflow configuration.
You can use the MiNiFi Toolkit, located in your MiNiFi installation directory, and any NiFi instance to set up the dataflow you want MiNiFi to run:
config.sh transform input_file output_file
minifi/conf
.Note: You can use one template at a time, per MiNiFi instance.
Result: Once you have your config.yml file in the minifi/conf
directory, launch that instance of MiNiFi and your dataflow begins automatically.
If you have a C2 server running, you can expose the whole config.yml for the agent to download. As the agent is heartbeating via the C2 protocol, changes in flow version will trigger automatic config updates.
c2.enable=true c2.config.directory=./conf c2.runtime.manifest.identifier=minifi c2.runtime.type=minifi-java c2.rest.url=http://localhost:10090/c2/config/heartbeat c2.rest.url.ack=http://localhost:10090/c2/config/acknowledge c2.agent.heartbeat.period=5000 #(Optional) c2.rest.callTimeout=10 sec #(Optional) c2.agent.identifier=123-456-789 c2.agent.class=agentClassName
nifi.minifi.notifier.ingestors=org.apache.nifi.minifi.bootstrap.configuration.ingestors.FileChangeIngestor nifi.minifi.notifier.ingestors.file.config.path=./conf/config-new.yml nifi.minifi.notifier.ingestors.file.polling.period.seconds=5
Note: Flow definitions are class based. Each class has one flow defined for it. As a result, all the agents belonging to the same class will get the flow at update.
Note: Compression can be turned on for C2 requests by setting c2.request.compression=gzip
. Compression is turned off by default when the parameter is omitted, or when c2.request.compression=none
is given. It can be beneficial to turn compression on to prevent network saturation.
To load a new dataflow for a MiNiFi instance to run:
minifi/conf
with the new file.Heartbeat provides status(agent, flowm device) and operational capabilities to C2 server(s)
The agent manifest is the descriptor of the available extensions. The size of the heartbeat might increase depending on the added extensions.
With the c2.full.heartbeat
parameter you can control whether to always include the manifest in the heartbeat or not.
The agentInfo.agentManifestHash
node can be used to detect in the C2 server whether the manifest changed compared to the previous heartbeat.
If change is detected, a full heartbeat can be retrieved by sending a DESCRIBE MANIFEST Operation in the requestedOperations
node of the C2 Heartbeat response.
For more details about the C2 protocol please visit Apache NiFi - MiNiFi C2 wiki page.
MiNiFi is able to use the following processors out of the box:
MiNiFi is able to use the StandardSSLContextService out of the box.
If you want to create a dataflow with a processor not shipped with MiNiFi, you can do so by following these steps:
lib
directory.Note: The following processors are also a part of the default distribution but require adding a NAR for a Controller Service not packaged by default. The processors are grouped by the NAR that is required.
You can secure your MiNiFi dataflow using keystore or trust store SSL protocols, however, this information is not automatically generated. You will need to generate your security configuration information yourself.
To run a MiNiFi dataflow securely:
minifi/conf
and rename config.yml.Security Properties: keystore: keystore type: keystore password: key password: truststore: truststore type: truststore password: ssl protocol: TLS Sensitive Props: key: algorithm: NIFI_PBKDF2_AES_GCM_256
You can also perform some management tasks using MiNiFi.
You can use the minifi.sh flowStatus
option to monitor a range of aspects of your MiNiFi operational and dataflow status. You can use the flowStatus
option to get information about dataflow component health and functionality, a MiNiFi instance, or system diagnostics.
FlowStatus accepts the following flags and options:
processor
health
bulletins
status
connection
health
stats
remoteProcessGroup
health
bulletins
status
authorizationIssues
inputPorts
controllerServices
health
bulletins
provenancereporting
health
bulletins
instance
health
bulletins
status
systemdiagnostics
heap
processorstats
contentrepositoryusage
flowfilerepositoryusage
garbagecollection
For example, this query gets the health, stats, and bulletins for the TailFile processor:
minifi.sh flowStatus processor:TailFile:health,stats,bulletins
Note: Currently, the script only accepts one high level option at a time.
Note: Any connections, remote process groups or processors names that contain “:”, “;” or “,” will cause parsing errors when querying.
For details on the flowStatus
option, see the “FlowStatus Query Option” section of the Administration Guide.
You can stop MiNiFi at any time.
Stopping MiNiFi:
bin/minifi.sh stop
Stopping MiNiFi as a service:
sudo service minifi stop