szaszm commented on a change in pull request #1127:
URL: https://github.com/apache/nifi-minifi-cpp/pull/1127#discussion_r672308980
##########
File path: examples/README.md
##########
@@ -12,6 +12,130 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-# Apache NiFi - MiNiFi - C++ Examples
+# Apache NiFi - MiNiFi - C++ Examples
-- [Site-2-Site Bi-directional Configuration](BidirectionalSiteToSite/README.md)
\ No newline at end of file
+The following examples show simple flow configurations for several common use
cases. Use the path of these yaml files as the flow configuration set in the
`nifi.flow.configuration.file` property of `conf/minifi.properties` file or
replace the default `conf/config.yml` file to try them out.
+
+- [Filesystem Operations](#filesystem-operations)
+ - [Getting File Data and Putting It in an Output
Directory](#getting-file-data-and-putting-it-in-an-output-directory)
+ - [Tailing a Single File](#tailing-a-single-file)
+- [Windows Specific Processors](#windows-specific-processors)
+ - [Consuming Windows Event Logs](#consuming-windows-event-logs)
+ - [Reading System Performance Data](#reading-system-performance-data)
+- [HTTP Operations](#http-operations)
+ - [HTTP POST Invocation](#http-post-invocation)
+- [Site to Site Operations](#site-to-site-operations)
+ - [Transfer Data to Remote Nifi
Instance](#transfer-data-to-remote-nifi-instance)
+ - [Site-2-Site Bi-directional
Configuration](#site-2-site-bi-directional-configuration)
+- [Kafka Operations](#kafka-operations)
+ - [Publish Message to Kafka Broker](#publish-message-to-kafka-broker)
+ - [Publish Message to Kafka Broker Through
SSL](#publish-message-to-kafka-broker-through-ssl)
+ - [Consume Messages from Kafka](#consume-messages-from-kafka)
+- [Public Cloud Operations](#public-cloud-operations)
+ - [Upload Blob to Azure Storage](#upload-blob-to-azure-storage)
+ - [Put Object in AWS S3 Bucket](#put-object-in-aws-s3-bucket)
+ - [List and Fetch Content from AWS S3
Bucket](#list-and-fetch-content-from-aws-s3-bucket)
+- [SQL Operations](#sql-operations)
+ - [Query Database Table](#query-database-table)
+- [System Log Operations](#system-log-operations)
+ - [Consume Systemd-Journald System Journal
Messages](#consume-systemd-journald-system-journal-messages)
+
+## Filesystem Operations
+
+### Getting File Data and Putting It in an Output Directory
+
+Using the [getfile_putfile_config.yml](getfile_putfile_config.yml) flow
configuration MiNiFi gets all files of minimum 1MB size from the
`/tmp/getfile_dir` directory and puts them in the `/tmp/out_dir` output
directory.
+
+The flow: GetFile ➔ success ➔ PutFile
+
+### Tailing a Single File
+
+Using the [tailfile_config.yml](tailfile_config.yml) flow configuration MiNiFi
tails a single file `/tmp/test_file.log` and creates flowfiles from every
single line, then logs the flowfile attributes.
+
+The flow: TailFile ➔ success ➔ LogAttribute
+
+## Windows Specific Processors
+
+### Consuming Windows Event Logs
+
+Using the [cwel_config.yml](cwel_config.yml) flow configuration MiNiFi queries
all Windows system events and puts them to the `C:\temp\` directory in
flattened JSON format.
+
+The flow: ConsumeWindowsEventLog ➔ PutFile
+
+## Linux Specific Processors
+
+### Consume Systemd-Journald System Journal Messages
+
+Using the [consumejournald_config.yml](consumejournald_config.yml) flow
configuration MiNiFi reads systemd-journald journal messages and logs them on
`info` level.
+
+The flow: ConsumeJournald ➔ LogAttribute
+
+### Reading System Performance Data
+
+Using the [pdh_config.yml](pdh_config.yml) flow configuration MiNiFi reads CPU
and Disk performance data through Windows' Performance Data Helper (PDH)
component and puts the data to the `C:\temp\` directory in a compact JSON
format.
+
+The flow: PerformanceDataMonitor ➔ PutFile
+
Review comment:
Could you move this up to the Windows-specific section? It's now under
Linux-specific processors.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
