Mirror of Apache Nifi Minifi CPP

Clone this repo:
  1. bfecf29 MINIFICPP-1541 Mock SQL driver dependant tests by Gabor Gyimesi · 34 hours ago main
  2. 186a5b1 MINIFICPP-1469 Ensure that the MSI installer always shows LICENSE by Martin Zink · 12 days ago
  3. 1f5d25e MINIFICPP-1610 fix PublishKafka::notifyStop + test by Marton Szasz · 11 days ago
  4. 236183c MINIFICPP-1609 Handle bash in the same way as patch by Ferenc Gerlits · 11 days ago
  5. 05e57c1 MINIFICPP-1425 upgrade compilers on linux and mac by Marton Szasz · 5 days ago

Apache NiFi - MiNiFi - C++ MiNiFi-CPP CI

MiNiFi is a child project effort of Apache NiFi. This repository is for a native implementation in C++.

Table of Contents

Features

Apache NiFi - MiNiFi C++ is a complementary data collection approach that supplements the core tenets of NiFi in dataflow management, focusing on the collection of data at the source of its creation. The C++ implementation is an additional implementation to the one in Java with the aim of an even smaller resource footprint.

Specific goals for MiNiFi comprise:

  • small and lightweight footprint
  • central management of agents
  • generation of data provenance
  • integration with NiFi for follow-on dataflow management and full chain of custody of information

Perspectives of the role of MiNiFi should be from the perspective of the agent acting immediately at, or directly adjacent to, source sensors, systems, or servers.

Expression Language

A subset of the Apache NiFi Expression Language is supported.

Processors

MiNiFi - C++ supports the following C++ processors:

The following table lists the base set of processors.

Extension SetProcessors
BaseAppendHostInfo
ExecuteProcess
ExtractText
GenerateFlowFile
GetFile
GetTCP
HashContent
ListenSyslog
LogAttribute
PutFile
RetryFlowFile
RouteOnAttribute
TailFile
UpdateAttribute

The next table outlines CMAKE flags that correspond with MiNiFi extensions. Extensions that are enabled by default ( such as CURL ), can be disabled with the respective CMAKE flag on the command line.

Through JNI extensions you can run NiFi processors using NARs. The JNI extension set allows you to run these Java processors. MiNiFi C++ will favor C++ implementations over Java implements. In the case where a processor is implemented in either language, the one in C++ will be selected; however, will remain transparent to the consumer.

Extension SetProcessorsCMAKE Flag
Archive ExtensionsApplyTemplate
CompressContent
ManipulateArchive
MergeContent
FocusArchiveEntry
UnfocusArchiveEntry
-DBUILD_LIBARCHIVE=ON
AWSAWSCredentialsService
PutS3Object
DeleteS3Object
FetchS3Object
ListS3
-DENABLE_AWS=ON
AzureAzureStorageCredentialsService
PutAzureBlobStorage
-DENABLE_AZURE=ON
CivetWebListenHTTP-DDISABLE_CIVET=ON
CURLInvokeHTTP-DDISABLE_CURL=ON
GPSGetGPS-DENABLE_GPS=ON
KafkaPublishKafka-DENABLE_LIBRDKAFKA=ON
JNINiFi Processors-DENABLE_JNI=ON
MQTTConsumeMQTT
PublishMQTT
-DENABLE_MQTT=ON
OPCFetchOPCProcessor-DENABLE_OPC=ON
OpenCVCaptureRTSPFrame-DENABLE_OPENCV=ON
OpenWSMANSourceInitiatedSubscriptionListener-DENABLE_OPENWSMAN=ON
PCAPCapturePacket-DENABLE_PCAP=ON
PDH (Windows only)PerformanceDataMonitor-DENABLE_PDH=ON
ScriptingExecuteScript
Custom Python Processors
-DDISABLE_SCRIPTING=ON
SensorsGetEnvironmentalSensors
GetMovementSensors
-DENABLE_SENSORS=ON
SFTPFetchSFTP
ListSFTP
PutSFTP
-DENABLE_SFTP=ON
SQLExecuteSQL
PutSQL
QueryDatabaseTable
-DENABLE_SQL=ON
SystemdConsumeJournald-DENABLE_SYSTEMD=ON
TensorflowTFApplyGraph
TFConvertImageToTensor
TFExtractTopLabels
-DENABLE_TENSORFLOW=ON
USB CameraGetUSBCamera-DENABLE_USB_CAMERA=ON
Windows Event Log (Windows only)CollectorInitiatedSubscription
ConsumeWindowsEventLog
TailEventLog
-DENABLE_WEL=ON

Please see our Python guide on how to write Python processors and use them within MiNiFi C++.

Caveats

  • We follow semver with regards to API compatibility, but no ABI compatibility is provided. See semver's website for more information
  • Build and usage currently only supports Windows, Linux and OS X environments. MiNiFi C++ can be built and run through the Windows Subsystem for Linux but we provide no support for this platform.
  • Provenance events generation is supported and are persisted using RocksDB. Volatile repositories can be used on systems without persistent storage.
  • If MiNiFi C++ is built with the OPC-UA extension enabled, it bundles open62541, which is available under the Mozilla Public License Version 2.0, a Category B license under ASF 3rd party license policy.
  • If MiNiFi C++ packaged on Windows, the resulting MSI may not be publicly redistributed under the Apache license, because it contains Microsoft redistributable DLLs, which fall under Category X of the ASF 3rd party license policy.

System Requirements

To build

Utilities

  • CMake 3.16 or greater
  • gcc 8 or greater
  • bison 3.0.x+ (3.2 has been shown to fail builds)
  • flex 2.6 or greater
External Projects

The following utilities are needed to build external projects, when bundled versions of LibreSSL, cURL, or zlib are used:

  • patch
  • autoconf
  • automake
  • libtool

NOTE if Expression Language support is enabled, FlexLexer must be in the include path and the version must be compatible with the version of flex used when generating lexer sources. On Mac OS X and FreeBSD, make sure that the system version is overridden with the correct flex version, which may require merging your CPPFLAGS into CFLAGS and CXXFLAGS. Lexer source generation is automatically performed during CMake builds. To re-generate the sources, remove:

  • extensions/expression-language/Parser.cpp
  • extensions/expression-language/Parser.hpp
  • extensions/expression-language/Scanner.cpp
  • extensions/expression-language/location.hh
  • extensions/expression-language/position.hh
  • extensions/expression-language/stack.hh

and rebuild.

Libraries / Development Headers

  • libcurl-openssl (If not available or desired, NSS will be used)
  • libuuid and uuid-dev
  • openssl
  • Python 3 and development headers -- Required, unless Python support is disabled
  • Lua and development headers -- Optional, unless Lua support is enabled
  • libgps-dev -- Required if building libGPS support
  • Zlib headers

CentOS 7

Additional environmental preparations are required for CentOS 7 support. Before building, install and enable the devtoolset-10 SCL:

$ sudo yum install centos-release-scl
$ sudo yum install devtoolset-10
$ scl enable devtoolset-10 bash

Finally, it is required to add the -lrt compiler flag by using the -DCMAKE_CXX_FLAGS=-lrt flag when invoking cmake.

On all distributions please use -DUSE_SHARED_LIBS=OFF to statically link zlib, libcurl, and OpenSSL.

Windows

Build and Installation has been tested with Windows 10 using Visual Studio 2019. You can build and create an MSI via the CPACK command. This requires the installation of the WiX toolset (http://wixtoolset.org/). To do this, open up a prompt into your build directory and type ‘cpack’ . The CPACK command will automatically generate and provide you a path to the distributable msi file. See Windows.md for more details.

To run

Libraries

  • libuuid
  • librocksdb (built and statically linked)
  • libcurl-openssl (If not available or desired, NSS will be used)
  • libssl and libcrypto from libressl (built and statically linked)
  • libarchive (built and statically linked)
  • librdkafka (built and statically linked)
  • Python 3 -- Required, unless Python support is disabled
  • Lua -- Optional, unless Lua support is enabled
  • libusb -- Optional, unless USB Camera support is enabled
  • libpng -- Optional, unless USB Camera support is enabled
  • libpcap -- Optional, unless ENABLE_PCAP specified

The needed dependencies can be installed with the following commands for:

rpm-based Linux Distributions

NOTE it is recommended to use the newest compiler using the latest devtoolset-/gcc-toolset-/llvm-toolset-* packages from the Software Collections (SCL).

# ~/Development/code/apache/nifi-minifi-cpp on git:master
dnf install cmake \
  gcc gcc-c++ \
  git \
  bison \
  flex \
  patch \
  autoconf \
  automake \
  libtool \
  libuuid libuuid-devel \
  boost-devel \
  openssl-devel \
  bzip2-devel \
  xz-devel \
  doxygen \
  zlib-devel
# (Optional) for building Python support
dnf install python36-devel
# (Optional) for building Lua support
dnf install lua-devel
# (Optional) for building USB Camera support
dnf install libusb-devel libpng-devel
# (Optional) for building docker image
dnf install docker
# (Optional) for system integration tests
dnf install docker python-virtualenv
# If building with GPS support
dnf install gpsd-devel
# (Optional) for PacketCapture Processor
dnf install libpcap-devel
Aptitude based Linux Distributions
# ~/Development/code/apache/nifi-minifi-cpp on git:master
apt install cmake \
  gcc g++ \
  git \
  bison \
  flex \
  patch \
  ca-certificates \
  autoconf \
  automake \
  libtool \
  libcurl4-openssl-dev \
  uuid-dev uuid \
  libboost-all-dev libssl-dev \
  libbz2-dev liblzma-dev \
  doxygen \
  zlib1g-dev
# (Optional) for building Python support
apt install libpython3-dev
# (Optional) for building Lua support
apt install liblua5.1-0-dev
# (Optional) for building USB Camera support
apt install libusb-1.0.0-0-dev libpng12-dev
# (Optional) for building docker image
apt install docker.io
# (Optional) for system integration tests
apt install docker.io python-virtualenv
# (Optional) If building with GPS support
apt install libgps-dev
# (Optional) for PacketCapture Processor
apt install libpcap-dev
OS X Using Homebrew (with XCode Command Line Tools installed)
# ~/Development/code/apache/nifi-minifi-cpp on git:master
brew install cmake \
  flex \
  patch \
  autoconf \
  automake \
  libtool \
  ossp-uuid \
  boost \
  openssl \
  python \
  lua \
  xz \
  bzip2 \
  doxygen \
  zlib
brew install curl
brew link curl --force
# (Optional) for building USB Camera support
brew install libusb libpng
# (Optional) for building docker image/running system integration tests
# Install docker using instructions at https://docs.docker.com/docker-for-mac/install/
sudo pip install virtualenv
# If building with GPS support
brew install gpsd
# (Optional) for PacketCapture Processor
sudo brew install libpcap
# It is recommended that you install bison from source as HomeBrew now uses an incompatible version of Bison

Getting Started

Bootstrapping

  • MiNiFi C++ offers a bootstrap script in the root of our github repo that will boot strap the cmake and build process for you without the need to install dependencies yourself. To use this process, please run the command boostrap.sh from the root of the MiNiFi C++ source tree.

  • Per the table, below, you will be presented with a menu guided bootstrap process. You may enable and disable extensions ( further defined below ). Once you are finished selecting the features you wish to build, enter P to continue with the process. CMAKE dependencies will be resolved for your distro. You may enter command line options -n to force yes to all prompts ( including the package installation prompts ) and -b to automatically run make once the cmake process is complete. Alternatively, you may include the package argument to boostrap, -p, which will run make package.

  • If you provide -b or -p to bootstrap.sh, you do not need to follow the Building section, below. If you do not provide these arguments you may skip the cmake .. section from Building.

  • Using the Release build profile is recommended to reduce binary size. (~200 MB vs ~30 MB)

    # ~/Development/code/apache/nifi-minifi-cpp on git:master
    $ ./bootstrap.sh
    # CMAKE Build dir exists, should we overwrite your build directory before we begin?
      If you have already bootstrapped, bootstrapping again isn't necessary to run make [ Y/N ] Y
      *****************************************
       Select MiNiFi C++ Features to toggle.
      ****************************************
      A. Persistent Repositories .....Enabled
      B. libcurl features  ...........Enabled
      C. libarchive features  ........Enabled
      D. Execute Script support ......Enabled
      E. Expression Language support .Enabled
      F. Kafka support ...............Disabled
      G. PCAP support ................Disabled
      H. USB Camera support ..........Disabled
      I. GPS support .................Disabled
      J. TensorFlow Support ..........Disabled
      K. Bustache Support ............Disabled
      L. MQTT Support ................Disabled
      M. Python Support ..............Disabled
      N. COAP Support ................Enabled
      O. SFTP Support ................Disabled
      S. AWS Support .................Disabled
      T. OpenCV Support ..............Disabled
      U. OPC-UA Support ..............Disabled
      V. SQL Support .................Disabled
      W. Openwsman Support ...........Disabled
      X. Azure Support ...............Disabled
      Y. Systemd Support .............Enabled
      Z. NanoFi Support ..............Enabled
      ****************************************
                  Build Options.
      ****************************************
      1. Disable Tests ...............Disabled
      2. Enable all extensions
      3. Enable JNI Support ..........Disabled
      4. Use Shared Dependency Links .Enabled
      5. Build Profile ...............RelWithDebInfo Debug MinSizeRel Release
      6. Create ASAN build ...........Disabled
      7. Treat warnings as errors.....Disabled
      P. Continue with these options
      Q. Quit
      * Extension cannot be installed due to
        version of cmake or other software, or
        incompatibility with other extensions
    
      Enter choice [ A - Z or 1-7 ]
    
  • Boostrap now saves state between runs. State will automatically be saved. Provide -c or --clear to clear this state. The -i option provides a guided menu install with the ability to change advanced features.

Building

  • From your source checkout, create a directory to perform the build (e.g. build) and cd into that directory.

    # ~/Development/code/apache/nifi-minifi-cpp on git:master
    $ mkdir build
    # ~/Development/code/apache/nifi-minifi-cpp on git:master
    $ cd build
    
  • Perform a cmake .. to generate the project files

    # ~/Development/code/apache/nifi-minifi-cpp on git:master
    $ cmake ..
    ...
    -- Configuring done
    -- Generating done
    -- Build files have been written to: /Users/apiri/Development/code/apache/nifi-minifi-cpp/build
    
  • Perform a build

    # ~/Development/code/apache/nifi-minifi-cpp on git:master
    $ make -j$(nproc)
    Scanning dependencies of target gmock_main
    Scanning dependencies of target gmock
    Scanning dependencies of target minifi
    Scanning dependencies of target gtest
    Scanning dependencies of target yaml-cpp
    [  1%] Building CXX object thirdparty/yaml-cpp-yaml-cpp-0.5.3/test/gmock-1.7.0/gtest/CMakeFiles/gtest.dir/src/gtest-all.cc.o
    [  3%] Building CXX object thirdparty/yaml-cpp-yaml-cpp-0.5.3/test/gmock-1.7.0/CMakeFiles/gmock.dir/gtest/src/gtest-all.cc.o
    [  3%] Building CXX object thirdparty/yaml-cpp-yaml-cpp-0.5.3/test/gmock-1.7.0/CMakeFiles/gmock.dir/src/gmock-all.cc.o
    [  6%] Building CXX object thirdparty/yaml-cpp-yaml-cpp-0.5.3/test/gmock-1.7.0/CMakeFiles/gmock_main.dir/gtest/src/gtest-all.cc.o
    [  6%] Building CXX object thirdparty/yaml-cpp-yaml-cpp-0.5.3/test/gmock-1.7.0/CMakeFiles/gmock_main.dir/src/gmock-all.cc.o
    [  7%] Building CXX object libminifi/CMakeFiles/minifi.dir/src/Configure.cpp.o
    
    ...
    
    [ 97%] Linking CXX executable minifi
    [ 97%] Built target minifiexe
    [ 98%] Building CXX object thirdparty/yaml-cpp-yaml-cpp-0.5.3/test/CMakeFiles/run-tests.dir/node/node_test.cpp.o
    [100%] Linking CXX executable run-tests
    [100%] Built target run-tests
    
  • Create a binary assembly located in your build directory with suffix -bin.tar.gz

    ~/Development/code/apache/nifi-minifi-cpp/build
    $ make package
    Run CPack packaging tool for source...
    CPack: Create package using TGZ
    CPack: Install projects
    CPack: - Install directory: ~/Development/code/apache/nifi-minifi-cpp
    CPack: Create package
    CPack: - package: ~/Development/code/apache/nifi-minifi-cpp/build/nifi-minifi-cpp-0.11.0-bin.tar.gz generated.
    
  • Create a source assembly located in your build directory with suffix -source.tar.gz

    ~/Development/code/apache/nifi-minifi-cpp/build
    $ make package_source
    Run CPack packaging tool for source...
    CPack: Create package using TGZ
    CPack: Install projects
    CPack: - Install directory: ~/Development/code/apache/nifi-minifi-cpp
    CPack: Create package
    CPack: - package: ~/Development/code/apache/nifi-minifi-cpp/build/nifi-minifi-cpp-0.11.0-source.tar.gz generated.
    
  • (Optional) Create a Docker image from the resulting binary assembly output from “make package”.

~/Development/code/apache/nifi-minifi-cpp/build
$ make docker
NiFi-MiNiFi-CPP Version: 0.11.0
Current Working Directory: /Users/jdyer/Development/github/nifi-minifi-cpp/docker
CMake Source Directory: /Users/jdyer/Development/github/nifi-minifi-cpp
MiNiFi Package: nifi-minifi-cpp-0.11.0-bin.tar.gz
Docker Command: 'docker build --build-arg UID=1000 --build-arg GID=1000 --build-arg MINIFI_VERSION=0.11.0 --build-arg MINIFI_PACKAGE=nifi-minifi-cpp-0.11.0-bin.tar.gz -t apacheminificpp:0.11.0 .'
Sending build context to Docker daemon 777.2 kB
Step 1 : FROM alpine:3.5
 ---> 88e169ea8f46
Step 2 : MAINTAINER Apache NiFi <dev@nifi.apache.org>

...

Step 15 : CMD $MINIFI_HOME/bin/minifi.sh run
 ---> Using cache
 ---> c390063d9bd1
Successfully built c390063d9bd1
Built target docker
  • (Optional) Execute system integration tests using the docker image built locally on a docker daemon running locally.
~/Development/code/apache/nifi-minifi-cpp/build
$ make docker-verify

Building For Other Distros

If you have docker installed on your machine you can build for CentOS 7, Fedora 34, Ubuntu 18.04, Ubuntu 20.04, and Debian 10 via our make docker commands. The following table provides the command to build your distro and the output file in your build directory. Since the versions are limited ( except for Ubuntu ) we output the archive based on the distro's name.

DistrocommandOutput File
CentOS 7make centosnifi-minifi-cpp-centos-$VERSION-bin.tar.gz
Debian 10 (buster)make debiannifi-minifi-cpp-debian-$VERSION-bin.tar.gz
Fedora 34make fedoranifi-minifi-cpp-fedora-$VERSION-bin.tar.gz
Ubuntu 18.04 (bionic)make u18nifi-minifi-cpp-bionic-$VERSION-bin.tar.gz
Ubuntu 20.04 (focal)make u20nifi-minifi-cpp-focal-$VERSION-bin.tar.gz

Snapcraft

Snapcraft builds are supported. As per Snapcraft's official recommendations, we recommend using Ubuntu 16.04 as a build system when building the Snap. To build the snap, run

$ snapcraft

from the project directory. Further instructions are available in the Snapcraft documentation.

Installation

After building MiNiFi C++, extract the generated binary package ‘nifi-minifi-cpp-$VERSION-bin.tar.gz’ at your desired installation path.

$ MINIFI_PACKAGE="$(pwd)"/build/nifi-minifi-cpp-*-bin.tar.gz
$ pushd /opt
$ sudo tar xvzf "$MINIFI_PACKAGE"
$ cd nifi-minifi-cpp-*

Configuring

The ‘conf’ directory in the installation root contains a template config.yml document, minifi.properties, and minifi-log.properties. Please see our Configuration document for details on how to configure agents.

Running

After completing the installation, the application can be run by issuing the following command from the installation directory:

$ ./bin/minifi.sh start

By default, this will make use of a config.yml located in the conf directory. This configuration file location can be altered by adjusting the property nifi.flow.configuration.file in minifi.properties located in the conf directory.

Stopping

MiNiFi can then be stopped by issuing:

$ ./bin/minifi.sh stop

Installing as a service

MiNiFi can also be installed as a system service using minifi.sh with an optional “service name” (default: minifi)

$ ./bin/minifi.sh install [service name]

Deploying

MiNiFi C++ comes with a deployment script. This will build and package minifi. Additionally, a file named build_output will be created within the build directory that contains a manifest of build artifacts.

$ deploy.sh <build identifier>

The build identifier will be carried with the deployed binary for the configuration you specify. By default all extensions will be built.

On Windows it is suggested that MSI be used for installation.

Cleaning

Remove the build directory created above.

# ~/Development/code/apache/nifi-minifi-cpp on git:master
$ rm -rf ./build

Extensions

Please see Extensions.md on how to build and run conditionally built dependencies and extensions.

Security

For securing a MiNiFi agent's configuration files it comes with a tool called encrypt-config. Its documentation is available here.

Recommended Antivirus Exclusions

Antivirus software can take a long time to scan directories and the files within them. Additionally, if the antivirus software locks files or directories during a scan, those resources are unavailable to MiNiFi processes, causing latency or unavailability of these resources in a MiNiFi instance. To prevent these performance and reliability issues from occurring, it is highly recommended to configure your antivirus software to skip scans on the following MiNiFi C++ directories:

  • content_repository
  • flowfile_repository
  • provenance_repository

Operations

See our operations documentation for additional information on how to manage instances

Issue Tracking

See https://issues.apache.org/jira/projects/MINIFICPP/issues for the issue tracker.

Documentation

See https://nifi.apache.org/minifi for the latest documentation.

Examples

See our examples page for flow examples.

Contributing

We welcome all contributions to Apache MiNiFi. To make development easier, we've included the linter for the Google Style guide. Google provides an Eclipse formatter for their style guide. It is located here. New contributions are expected to follow the Google style guide when it is reasonable.

Shell script files shall follow the guidelines and best practices defined by the shellcheck analysis tool. New contributions are expected to pass the shellcheck analysis as part of the verification process. If a shellcheck requested change is unfeasable it shall be disabled on per-line basis and will be subjected to review. For more information on an issue please check the shellcheck wiki page.

Python script files shall follow the PEP8 guidelines and best practices. The project includes flake8 checks as part of the verification process, that is applied to all new contributions.

Additionally, all new files must include a copy of the Apache License Header.

For more details on how to contribute please see our Contribution Guide

License

Except as otherwise noted this software is licensed under the Apache License, Version 2.0

For additional information regarding the source of included projects and the corresponding licenses, you may visit the following website

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.