|author||Marc Parisi <firstname.lastname@example.org>||Fri Nov 24 20:50:04 2017 -0500|
|committer||Aldrin Piri <email@example.com>||Mon Nov 27 10:19:14 2017 -0500|
MINIFICPP-319: Resolve missing licenses This closes #205. Signed-off-by: Aldrin Piri <firstname.lastname@example.org>
MiNiFi is a child project effort of Apache NiFi. This repository is for a native implementation in C++.
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 are comprised of:
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.
NOTE if Lua support is enabled, then a C++ compiler with support for c++-14 must be used. If using GCC, version 6.x or greater is recommended.
** NOTE: IF ROCKSDB IS NOT INSTALLED, IT WILL BE BUILT FROM THE THIRD PARTY DIRECTORY UNLESS YOU SPECIFY -DDISABLE_ROCKSDB=true WITH CMAKE ***
The needed dependencies can be installed with the following commands for:
Yum based Linux Distributions
NOTE if a newer compiler is required, such as when Lua support is enabled, it is recommended to use a newer compiler using a devtools-* package from the Software Collections (SCL).
# ~/Development/code/apache/nifi-minifi-cpp on git:master $ yum install cmake \ gcc gcc-c++ \ libcurl-devel \ rocksdb-devel rocksdb \ libuuid libuuid-devel \ boost-devel \ openssl-devel \ bzip2-devel \ xz-devel \ doxygen $ # (Optional) for building Python support $ yum install python34-devel $ # (Optional) for building Lua support $ yum install lua-devel $ # (Optional) for building USB Camera support $ yum install libusb-devel libpng-devel $ # (Optional) for building docker image $ yum install docker $ # (Optional) for system integration tests $ yum install docker python-virtualenv # If building with GPS support $ yum install gpsd-devel $ # (Optional) for PacketCapture Processor $ yum install libpcap-devel
Aptitude based Linux Distributions
# ~/Development/code/apache/nifi-minifi-cpp on git:master $ apt-get install cmake \ gcc g++ \ libcurl-dev \ librocksdb-dev librocksdb4.1 \ uuid-dev uuid \ libboost-all-dev libssl-dev \ libbz2-dev liblzma-dev \ doxygen $ # (Optional) for building Python support $ apt-get install libpython3-dev $ # (Optional) for building Lua support $ apt-get install liblua5.1-0-dev $ # (Optional) for building USB Camera support $ apt-get install libusb-1.0.0-0-dev libpng12-dev $ # (Optional) for building docker image $ apt-get install docker.io $ # (Optional) for system integration tests $ apt-get install docker.io python-virtualenv # If building with GPS support $ apt-get install libgps-dev $ # (Optional) for PacketCapture Processor $ apt-get 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 \ rocksdb \ ossp-uuid \ boost \ openssl \ python \ lua \ xz \ bzip2 \ doxygen $ 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
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
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
To build with GPS support perform a ‘cmake -DBUILD_GPS=ON ..’ to generate the project files
# ~/Development/code/apache/nifi-minifi-cpp on git:master $ cmake -DBUILD_GPS=ON .. ... -- 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 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.1.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.1.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.3.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.3.0-bin.tar.gz Docker Command: 'docker build --build-arg UID=1000 --build-arg GID=1000 --build-arg MINIFI_VERSION=0.3.0 --build-arg MINIFI_PACKAGE=nifi-minifi-cpp-0.3.0-bin.tar.gz -t apacheminificpp:0.3.0 .' Sending build context to Docker daemon 777.2 kB Step 1 : FROM alpine:3.5 ---> 88e169ea8f46 Step 2 : MAINTAINER Apache NiFi <email@example.com> ... Step 15 : CMD $MINIFI_HOME/bin/minifi.sh run ---> Using cache ---> c390063d9bd1 Successfully built c390063d9bd1 Built target docker
~/Development/code/apache/nifi-minifi-cpp/build $ make docker-verify
Remove the build directory created above.
# ~/Development/code/apache/nifi-minifi-cpp on git:master $ rm -rf ./build
The ‘conf’ directory in the root contains a template config.yml document.
This is compatible with the format used with the Java MiNiFi application. Currently, a subset of the configuration is supported and MiNiFi C++ is currently compatible with version 1 of the MiNiFi YAML schema. Additional information on the YAML format for the config.yml and schema versioning can be found in the MiNiFi System Administrator Guide.
Additionally, users can utilize the MiNiFi Toolkit Converter (version 0.0.1 - schema version 1) to aid in creating a flow configuration from a generated template exported from a NiFi instance. The MiNiFi Toolkit Converter tool can be downloaded from http://nifi.apache.org/minifi/download.html under the
MiNiFi Toolkit Binaries section. Information on its usage is available at https://nifi.apache.org/minifi/minifi-toolkit.html.
Flow Controller: id: 471deef6-2a6e-4a7d-912a-81cc17e3a205 name: MiNiFi Flow Processors: - name: GetFile id: 471deef6-2a6e-4a7d-912a-81cc17e3a206 class: org.apache.nifi.processors.standard.GetFile max concurrent tasks: 1 scheduling strategy: TIMER_DRIVEN scheduling period: 1 sec penalization period: 30 sec yield period: 1 sec run duration nanos: 0 auto-terminated relationships list: Properties: Input Directory: /tmp/getfile Keep Source File: true Connections: - name: TransferFilesToRPG id: 471deef6-2a6e-4a7d-912a-81cc17e3a207 source name: GetFile source id: 471deef6-2a6e-4a7d-912a-81cc17e3a206 source relationship name: success destination id: 471deef6-2a6e-4a7d-912a-81cc17e3a204 max work queue size: 0 max work queue data size: 1 MB flowfile expiration: 60 sec Remote Processing Groups: - name: NiFi Flow id: 471deef6-2a6e-4a7d-912a-81cc17e3a208 url: http://localhost:8080/nifi timeout: 30 secs yield period: 10 sec Input Ports: - id: 471deef6-2a6e-4a7d-912a-81cc17e3a204 name: From Node A max concurrent tasks: 1 Properties:
in minifi.properties enable tls ssl nifi.remote.input.secure=true if you want to enable client certificate base authorization nifi.security.need.ClientAuth=true setup the client certificate and private key PEM files nifi.security.client.certificate=./conf/client.pem nifi.security.client.private.key=./conf/client.pem setup the client private key passphrase file nifi.security.client.pass.phrase=./conf/password setup the client CA certificate file nifi.security.client.ca.certificate=./conf/nifi-cert.pem if you do not want to enable client certificate base authorization nifi.security.need.ClientAuth=false
To enable HTTPSiteToSite you must set the following flag to true
For more more insight into the API used within the C2 agent, please visit: https://cwiki.apache.org/confluence/display/MINIFI/C2+Design+Proposal
in minifi.properties #Disable/Enable C2 nifi.c2.enable=true #specify metrics classes nifi.flow.metrics.classes=DeviceInformation,SystemInformation,ProcessMetrics #specify C2 protocol c2.agent.protocol.class=RESTSender #control c2 heartbeat interval in millisecocnds c2.agent.heartbeat.period=3000 # enable reporter classes c2.agent.heartbeat.reporter.class=RESTReciver
Each of the repositories can be configured to be volatile ( state kept in memory and flushed upon restart ) or persistent. Currently, the flow file and provenance repositories can persist to RocksDB. The content repository will persist to the local file system if a volatile repo is not configured.
To configure the repositories:
in minifi.properties # For Volatile Repositories: nifi.flowfile.repository.class.name=VolatileFlowFileRepository nifi.provenance.repository.class.name=VolatileProvenanceRepository nifi.content.repository.class.name=VolatileContentRepository # configuration options # maximum number of entries to keep in memory nifi.volatile.repository.options.flowfile.max.count=10000 # maximum number of bytes to keep in memory, also limited by option above nifi.volatile.repository.options.flowfile.max.bytes=1M # maximum number of entries to keep in memory nifi.volatile.repository.options.provenance.max.count=10000 # maximum number of bytes to keep in memory, also limited by option above nifi.volatile.repository.options.provenance.max.bytes=1M # maximum number of entries to keep in memory nifi.volatile.repository.options.content.max.count=100000 # maximum number of bytes to keep in memory, also limited by option above nifi.volatile.repository.options.content.max.bytes=1M # limits locking for the content repository nifi.volatile.repository.options.content.minimal.locking=true # For NO-OP Repositories: nifi.flowfile.repository.class.name=NoOpRepository nifi.provenance.repository.class.name=NoOpRepository
Systems that have limited memory must be cognizant of the options above. Limiting the max count for the number of entries limits memory consumption but also limits the number of events that can be stored. If you are limiting the amount of volatile content you are configuring, you may have excessive session rollback due to invalid stream errors that occur when a claim cannot be found.
The content repository has a default option for “minimal.locking” set to true. This will attempt to use lock free structures. This may or may not be optimal as this requires additional additional searching of the underlying vector. This may be optimal for cases where max.count is not excessively high. In cases where object permanence is low within the repositories, minimal locking will result in better performance. If there are many processors and/or timing is such that the content repository fills up quickly, performance may be reduced. In all cases a locking cache is used to avoid the worst case complexity of O(n) for the content repository; however, this caching is more heavily used when “minimal.locking” is set to false.
Add Provenance Reporting to config.yml Provenance Reporting: scheduling strategy: TIMER_DRIVEN scheduling period: 1 sec url: http://localhost:8080/nifi port uuid: 471deef6-2a6e-4a7d-912a-81cc17e3a204 batch size: 100
Http Configuration Listener will pull flow file configuration from the remote command control server, validate and apply the new flow configuration in minifi.properties nifi.configuration.listener.type=http nifi.configuration.listener.http.url=https://localhost:8080 nifi.configuration.listener.pull.interval=1 sec if you want to enable client certificate nifi.https.need.ClientAuth=true nifi.https.client.certificate=./conf/client.pem nifi.https.client.private.key=./conf/client.key nifi.https.client.pass.phrase=./conf/password nifi.https.client.ca.certificate=./conf/nifi-cert.pem
Configure REST API user name and password nifi.rest.api.user.name=admin nifi.rest.api.password=password if you want to enable client certificate nifi.https.need.ClientAuth=true nifi.https.client.certificate=./conf/client.pem nifi.https.client.private.key=./conf/client.key nifi.https.client.pass.phrase=./conf/password nifi.https.client.ca.certificate=./conf/nifi-cert.pem
MiNiFi needs to generate many unique identifiers in the course of operations. There are a few different uid implementations available that can be configured in minifi-uid.properties.
Implementation for uid generation can be selected using the uid.implementation property values:
If minifi_uuid is selected MiNiFi will use a custom uid algorthim consisting of first N bits device identifier, second M bits as bottom portion of a timestamp where N + M = 64, the last 64 bits is an atomic incrementor.
This is faster than the random uuid generator and encodes the device id and a timestamp into every value, making tracing of flowfiles, etc easier.
It does require more configuration. uid.minifi.device.segment.bits is used to specify how many bits at the beginning to reserve for the device identifier. It also puts a limit on how many distinct devices can be used. With the default of 16 bits, there are a maximum of 65,535 unique device identifiers that can be used. The 48 bit timestamp won‘t repeat for almost 9,000 years. With 24 bits for the device identifier, there are a maximum of 16,777,215 unique device identifiers and the 40 bit timestamp won’t repeat for about 35 years.
Additionally, a unique hexadecimal uid.minifi.device.segment should be assigned to each MiNiFi instance.
If you need to reference a controller service in your config.yml file, use the following template. In the example, below, ControllerServiceClass is the name of the class defining the controller Service. ControllerService1 is linked to ControllerService2, and requires the latter to be started for ControllerService1 to start.
Controller Services: - name: ControllerService1 id: 2438e3c8-015a-1000-79ca-83af40ec1974 class: ControllerServiceClass Properties: Property one: value Linked Services: - value: ControllerService2 - name: ControllerService2 id: 2438e3c8-015a-1000-79ca-83af40ec1992 class: ControllerServiceClass Properties:
After completing a build, the application can be run by issuing the following from :
$ ./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.
MiNiFi can then be stopped by issuing:
$ ./bin/minifi.sh stop
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]
Please see Extensions.md on how to build and run conditionally built dependencies and extensions.
See https://nifi.apache.org/minifi for the latest documentation.
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. Additionally, all new files must include a copy of the Apache License Header.
MiNiFi C++ contains a dynamic loading mechanism that loads arbitrary objects. To maintain consistency of development amongst the NiFi ecosystem, it is called a class loader. If you are contributing a custom Processor or Controller Service, the mechanism to register your class into the default class loader is a pragma definition named:
To use this include REGISTER_RESOURCE(YourClassName); in your header file. The default class loader will make instnaces of YourClassName available for inclusion.
Once you have completed your changes, including source code and tests, you can verify that you follow the Google style guide by running the following command: $ make linter. This will provide output for all source files.
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
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.