Skip to content

tspannhw/edge2ai-workshop

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EDGE2AI CDF Workshop

Introduction

In this workshop, you will build a full OT to IT workflow for an IoT Predictive Maintenance use case. Below is the architecture diagram, showing all the components you will setup over the next 8 lab exercises. While the diagram divides the components according to their location (factory, regional or datacenter level) in this workshop all such components will reside in one single host.

iot

Troubleshooting

  • Everything is Case-Sensitive.

*MiNiFi Not Sending Messages *

  • Make sure you pick S2S not RAW in Cloud Connection to NiFi

  • Make sure No Spaces Before or After Destination ID, URL, Names, Topics, Brokers, Etc…​

  • Make sure No Spaces Anywhere

  • Everything is Case-Sensitive. It’s IoT, not iot.

  • Use User=Admin for CDSW and HUE

  • You must have HDFS User Created via HUE, Go there First

  • Check all your connections and spellings

  • Check /opt/cloudera/cem/minifi/logs/minifi-app.log if you can’t find an issue

CEM doesn’t pick up new NARs

  1. Delete the agent manifest manually using the EFM API:

  2. Verify each class has the same agent manifest ID:

    http://hostname:10080/efm/api/agent-classes
    [{"name":"iot1","agentManifests":["agent-manifest-id"]},{"name":"iot4","agentManifests":["agent-manifest-id"]}]
  3. Confirm the manifest doesn’t have the NAR you installed

    http://hostname:10080/efm/api/agent-manifests?class=iot4
    [{"identifier":"agent-manifest-id","agentType":"minifi-java","version":"1","buildInfo":{"timestamp":1556628651811,"compiler":"JDK 8"},"bundles":[{"group":"default","artifact":"system","version":"unversioned","componentManifest":{"controllerServices":[],"processors":
  4. Call the API endpoint:

    http://hostname:10080/efm/swagger/
  5. Hit the DELETE - Delete the agent manifest specified by id button, and in the id field, enter `agent-manifest-id

Labs summary:
  • Lab 1 - On the Apache NiFi, run a simulator to send IoT sensors data to the MQTT broker.

  • Lab 3 - Create the MiNiFi flow on the Edge Flow Manager and publish it for the MiNiFi agent to start sending data to the NiFi cluster.

  • Lab 4 - On Schema Registry, register the schema describing the data generated by the IoT sensors.

  • Lab 5 - On the NiFi cluster, prepare the data and send it to the Kafka cluster.

  • Lab 6 - On the Streams Messaging Manager (SMM) Web UI, monitor the Kafka cluster and confirm data is being ingested correctly.

  • Lab 7 - Use the Edge Flow Manager to update existing edge flows and perform additional processing on the edge

  • Lab 8 - Use NiFi to process each record, calling the Model endpoint and save results to Kudu.

Pre-requisites
  • Laptop with a supported OS (Windows 7 not supported).

  • A modern browser like Google Chrome or Firefox (IE not supported).

Connecting to your cluster

You should have 2 addresses for you one-node cluster: the public DNS name and the public IP address. With those addresses you can test the following connectivity to your cluster:

  1. Ensure you can SSH into the cluster (using either the DNS name or IP address)

  2. Ensure you can connect to the following service using your browser:

    Service URL Credentials

    Cloudera Manager

    http://<public_dns>:7180/

    admin/admin

    Edge Flow Manager

    http://<public_dns>:10080/efm/ui/

    NiFi

    http://<public_dns>:8080/nifi/

    NiFi Registry

    http://<public_dns>:18080/nifi-registry/

    Schema Registry

    http://<public_dns>:7788/

    SMM

    http://<public_dns>:9991/

    Hue

    http://<public_dns>:8888/

    CDSW

    http://cdsw.<public_IP>.nip.io/

    admin/supersecret1

  3. Login into Cloudera Manager and familiarize yourself with the services installed

  4. Login into Hue. As you are the first user to login into Hue, you are granted admin privileges. At this point, you won’t need to do anything on Hue, but by logging in, CDH has created your HDFS user and folder, which you will need for the next lab.

Below a screenshot of Chrome open with 8 tabs, one for each service.

browser

Lab 1 - Apache NiFi: setup machine sensors simulator

In this lab you will run a simple Python script that simulates IoT sensor data from some hypothetical machines, and send the data to a MQTT broker (mosquitto). The gateway host is connected to many and different type of sensors, but they generally all share the same transport protocol, "mqtt". You will go to Apache NiFi and add a Processor (ExecuteProcess) to the canvas. You will then right-click and set the properties shown below to run our Python simulate script.

Command: python

Command Arguments: /opt/demo/simulate.py

simulate1
simulate2

In the Scheduling Tab, set to Run Schedule: 1 sec

You could set that to 1 sec, 30 sec, 1 min.

runSimulator1or30

Include no extra spaces!

Tab: Settings

Automatically Terminate Relationships: [x] Success

Make sure you terminate so you can run.

nifiTerminateRelationships

You can then right click to Start this simulator runner. You can press stop after a few seconds and look at the provenance to see that it has run a number of times and produced results.

NiFiViewDataProvenance
NiFiDataProvenance

Lab 3 - Configuring Edge Flow Management

Cloudera Edge Flow Management gives you a visual overview of all MiNiFi agents in your environment, and allows you to update the flow configuration for each one, with versioning control thanks to the NiFi Registry integration. In this lab, you will create the MiNiFi flow and publish it for the MiNiFi agent to pick it up.

  1. Open the EFM Web UI at http://<public_dns>:10080/efm/ui/. Ensure you see your minifi agent’s heartbeat messages in the Events Monitor.

    cem heartbeats
efmEventDetails
efmSetCloudConfiguration
rpgCloudConfiguration
  1. You can then select the Flow Designer tab (flow designer icon). To build a dataflow, select the desired class (iot-1) from the table and click OPEN. Alternatively, you can double-click on the desired class.

  2. Add a ConsumeMQTT Processor to the canvas, by dragging the processor icon to the canvas, selecting the ConsumeMQTT processor type and clicking on the Add button. Once the processor is on the canvas, double-click it and configure it with below settings:

    Broker URI:     tcp://edge2ai-1.dim.local:1883
    Client ID:      minifi-iot
    Topic Filter:   iot/#
    Max Queue Size: 60
    add consumer mqtt
  3. Add a Remote Process Group (RPG) to the canvas and configure it as follows:

    URL: http://edge2ai-1.dim.local:8080/nifi
    add rpg
  4. At this point you need to connect the ConsumerMQTT processor to the RPG. For this, you first need to add an Input Port to the remote NiFi server. Open the NiFi Web UI at http://<public_dns>:8080/nifi/ and drag the Input Port to the canvas. Call it something like "from Gateway".

    add input port
  5. To terminate the NiFI Input Port let’s, for now, add a Funnel to the canvas…​

    add funnel
  6. …​ and setup a connection from the Input Port to it. To setup a connection, hover the mouse over the Input Port until an arrow symbol is shown in the center. Click on the arrow, drag it and drop it on the Funnel to connect the two elements.

    connecting
  7. Right-click on the Input Port and start it. Alternatively, click on the Input Port to select it and then press the start ("play") button on the Operate panel:

    operate panel
  8. You will need the ID of the Input Port to complete the connection of the ConsumeMQTT processor to the RPG (NiFi). Double-click on the Input Port and copy its ID.

    input port id
  9. Back to the Flow Designer, connect the ConsumeMQTT processor to the RPG. The connection requires an ID and you can paste here the ID you copied from the Input Port.

    connect to rpg
  10. The Flow is now complete, but before publishing it, create the Bucket in the NiFi Registry so that all versions of your flows are stored for review and audit. Open the NiFi Registry at http://<public_dns>:18080/nifi-registry, click on the wrench/spanner icon (spanner icon) on the top-right corner on and create a bucket called IoT.

    create bucket
  11. You can now publish the flow for the MiNiFi agent to automatically pick up. Click Publish, add a descriptive comment for your changes and click Apply.

    publish flow
    cem first version
  12. Go back to the NiFi Registry Web UI and click on the NiFi Registry name, next to the Cloudera logo. If the flow publishing was successful, you should see the flow’s version details in the NiFi Registry.

    flow in nifi registry
NiFiSettingsSetNiFiRegistry
  1. At this point, you can test the edge flow up until NiFi. Start the NiFi (ExecuteProcess) simulator again and confirm you can see the messages queued in NiFi.

    queued events
  2. You can stop the simulator (Stop the NiFi processor) once you confirm that the flow is working correctly.

Lab 4 - Registering our schema in Schema Registry

The data produced by the temperature sensors is described by the schema in file sensor.avsc. In this lab we will register this schema in Schema Registry so that our flows in NiFi can refer to schema using an unified service. This will also allow us to evolve the schema in the future, if needed, keeping older versions under version control, so that existing flows and flowfiles will continue to work.

  1. Go the following URL, which contains the schema definition we’ll use for this lab. Select all contents of the page and copy it.

  2. In the Schema Registry Web UI, click the + sign to register a new schema.

  3. Click on a blank area in the Schema Text field and paste the contents you copied.

  4. Complete the schema creation by filling the following properties:

    Name:          SensorReading
    Description:   Schema for the data generated by the IoT sensors
    Type:          Avro schema provider
    Schema Group:  Kafka
    Compatibility: Backward
    Evolve:        checked
    register schema
  5. Save the schema

Lab 5 - Configuring the NiFi flow and pushing data to Kafka

In this lab, you will create a NiFi flow to receive the data from all gateways and push it to Kafka.

Creating a Process Group

Before we start building our flow, let’s create a Process Group to help organizing the flows in the NiFi canvas and also to enable flow version control.

  1. Open the NiFi Web UI, create a new Process Group and name it something like Process Sensor Data.

    create pgroup
  2. We want to be able to version control the flows we will add to the Process Group. In order to do that, we first need to connect NiFi to the NiFi Registry. On the NiFi global menu, click on "Controller Services", navigate to the "Registry Clients" tab and add a Registry client with the following URL:

    Name: NiFi Registry
    URL:  http://edge2ai-1.dim.local:18080
    global controller settings
    add registry client
  3. On the NiFi Registry Web UI, add another bucket for storing the Sensor flow we’re about to build'. Call it SensorFlows:

    sensor flows bucket
  4. Back on the NiFi Web UI, to enable version control for the Process Group, right-click on it and select Version > Start version control and enter the details below. Once you complete, a version control tick will appear on the Process Group, indicating that version control is now enabled for it.

    Registry:  NiFi Registry
    Bucket:    SensorFlows
    Flow Name: SensorProcessGroup
  5. Let’s also enable processors in this Process Group to use schemas stored in Schema Registry. Right-click on the Process Group, select Configure and navigate to the Controller Services tab. Click the + icon and add a HortonworksSchemaRegistry service. After the service is added, click on the service’s cog icon (cog icon), go to the Properties tab and configure it with the following Schema Registry URL and click Apply.

    URL: http://edge2ai-1.dim.local:7788/api/v1
    added hwx sr service
  6. Click on the lightning bolt icon (enable icon) to enable the HortonworksSchemaRegistry Controller Service.

  7. Still on the Controller Services screen, let’s add two additional services to handle the reading and writing of JSON records. Click on the plus button button and add the following two services:

    • JsonTreeReader, with the following properties:

      Schema Access Strategy: Use 'Schema Name' Property
      Schema Registry:        HortonworksSchemaRegistry
      Schema Name:            ${schema.name} -> already set by default!
    • JsonRecordSetWriter, with the following properties:

      Schema Write Strategy:  HWX Schema Reference Attributes
      Schema Access Strategy: Inherit Record Schema
      Schema Registry:        HortonworksSchemaRegistry
  8. Enable the JsonTreeReader and the JsonRecordSetWriter Controller Services you just created, by clicking on their respective lightning bolt icons (enable icon).

    controller services

Creating the flow

  1. Double-click on the newly created process group to expand it.

  2. Inside the process group, add a new Input Port and name it "Sensor Data"

  3. We need to tell NiFi which schema should be used to read and write the Sensor data. For this we’ll use an UpdateAttribute processor to add an attribute to the FlowFile indicating the schema name.

    Add an UpdateAttribute processor by dragging the processor icon to the canvas:

    add updateattribute
  4. Double-click the UpdateAttribute processor and configure it as follows:

    1. In the SETTINGS tab:

      Name: Set Schema Name
    2. In the PROPERTIES tab:

      • Click on the plus button button and add the following property:

        Property Name:  schema.name
        Property Value: SensorReading
    3. Click Apply

  5. Connect the Sensor Data input port to the Set Schema Name processor.

  6. Add a PublishKafkaRecord_2.0 processor and configure it as follows:

    SETTINGS tab:

    Name:                                  Publish to Kafka topic: iot

    PROPERTIES tab:

    Kafka Brokers:                         edge2ai-1.dim.local:9092
    Topic Name:                            iot
    Record Reader:                         JsonTreeReader
    Record Writer:                         JsonRecordSetWriter
    Use Transactions:                      false
    Attributes to Send as Headers (Regex): schema.*
    Note
    Make sure you use the PublishKafkaRecord_2.0 processor and not the PublishKafka_2.0 one
  7. While still in the PROPERTIES tab of the PublishKafkaRecord_2.0 processor, click on the plus button button and add the following property:

    Property Name:  client.id
    Property Value: nifi-sensor-data

    Later, this will help us clearly identify who is producing data into the Kafka topic.

  8. Connect the Set Schema Name processor to the Publish to Kafka topic: iot processor.

  9. Add a new Funnel to the canvas and connect the PublishKafkaRecord processor to it. When the "Create connection" dialog appears, select "failure" and click Add.

    add kafka failure connection
  10. Double-click on the Publish to Kafka topic: iot processor, go to the SETTINGS tab, check the "success" relationship in the AUTOMATICALLY TERMINATED RELATIONSHIPS section. Click Apply.

    terminate publishkafka relationship
  11. Start the input port and the two processors. Your canvas should now look like the one below:

    publishKafka flow
  12. The only thing that remains to be configured now is to finally connect the "from Gateway" Input Port to the flow in the "Processor Sensor Data" group. To do that, first go back to the root canvas by clicking on the NiFi Flow link on the status bar.

    breadcrumbs
  13. Connect the Input Port to the Process Sensor Data Process Group by dragging the destination of the current connection from the funnel to the Process Group. When prompted, ensure the "To input" fields is set to the Sensor data Input Port.

    connect input
    to input
  14. Refresh the screen (Ctrl+R on Linux/Windows; Cmd+R on Mac) and you should see that the records that were queued on the "from Gateway" Input Port disappeared. They flowed into the Process Sensor Data flow. If you expand the Process Group you should see that those records were processed by the PublishKafkaRecord processor and there should be no records queued on the "failure" output queue.

    kafka success

    At this point, the messages are already in the Kafka topic. You can add more processors as needed to process, split, duplicate or re-route your FlowFiles to all other destinations and processors.

  15. To complete this Lab, let’s commit and version the work we’ve just done. Go back to the NiFi root canvas, clicking on the "Nifi Flow" breadcrumb. Right-click on the Process Sensor Data Process Group and select Version > Commit local changes. Enter a descriptive comment and save.

Lab 6 - Use SMM to confirm that the data is flowing correctly

Now that our NiFi flow is pushing data to Kafka, it would be good to have a confirmation that everything is running as expected. In this lab you will use Streams Messaging Manager (SMM) to check and monitor Kafka.

  1. Start the (NiFi ExecuteProcess) simulator again and confirm you can see the messages queued in NiFi. Leave it running.

  2. Go to the Stream Messaging Manager (SMM) Web UI and familiarize yourself with the options there. Notice the filters (blue boxes) at the top of the screen.

    smm
  3. Click on the Producers filter and select only the nifi-sensor-data producer. This will hide all the irrelevant topics and show only the ones that producer is writing to.

  4. If you filter by Topic instead and select the iot topic, you’ll be able to see all the producers and consumers that are writing to and reading from it, respectively. Since we haven’t implemented any consumers yet, the consumer list should be empty.

  5. Click on the topic to explore its details. You can see more details, metrics and the break down per partition. Click on one of the partitions and you’ll see additional information and which producers and consumers interact with that partition.

    producers
  6. Click on the EXPLORE link to visualize the data in a particular partition. Confirm that there’s data in the Kafka topic and it looks like the JSON produced by the sensor simulator.

    explore partition
  7. Check the data from the partition. You’ll notice something odd. These are readings from temperature sensors and we don’t expect any of the sensors to measure temperatures greater than 150 degrees in the conditions they are used. It seems, though, that sensor_0 and sensor_1 are intermittently producing noise and some of the measurements have very high values for these measurements.

    troubled sensors
  8. Stop the simulator with CTRL-C.

  9. In the next Lab we’ll eliminate with these problematic measurements to avoid problems later in our data flow.

Lab 7 - Update the edge flows to perform additional processing on the data

In the previous lab we noticed that some of the sensors were sending erroneous measurements intermittently. If we let these measurements to be processed by our data flow we might have problems with the quality of our flow output and we want to avoid that.

We could use our Process Sensor Data flow in NiFi to filter out those problematic measurements. However, if their volume is large we could be wasting network bandwidth and causing additional overhead in NiFi to process the bogus data. What we’d like to do instead is to push additional logic to the edge to identify and filter those problems in place and avoiding sending them to NiFi in the first place.

We’ve noticed that the problem always happen with the temperatures in measurements sensor_0 and sensor_1, only. If any of these two temperatures are greater than 500 we must discard the entire sensor reading. If both of these temperatures are in the normal range (< 500) we can guarantee that all temperatures reported are correct and can be sent to NiFi.

  1. Go to the CEM Web UI and add a new processor to the canvas. In the Filter box of the dialog that appears, type "JsonPath". Select the EvaluateJSONPath processor and click Add.

  2. Double-click on the new processor and configure it with the following properties:

    Processor Name: Extract sensor_0 and sensor1 values
    Destination:    flowfile-attribute
    EvaluateJsonPath
  3. Click on the Add Property button and enter the following properties:

    Property Name Property Value

    sensor_0

    $.sensor_0

    sensor_1

    $.sensor_1

    extract attributes
  4. Click Apply to save the processor configuration.

  5. Drag one more new processor to the canvas. In the Filter box of the dialog that appears, type "Route". Select the RouteOnAttribute processor and click Add.

    route on attribute
  6. Double-click on the new processor and configure it with the following properties:

    Processor Name: Filter Errors
    Route Strategy: Route to Property name
  7. Click on the Add Property button and enter the following properties:

    Property Name Property Value

    error

    ${sensor_0:ge(500):or(${sensor_1:ge(500)})}

    route on attribute config
  8. Click Apply to save the processor configuration.

  9. Reconnect the ConsumeMQTT processor to the Extract sensor_0 and sensor1 values processor:

    1. Click on the existing connection between ConsumeMQTT and the RPG to select it.

    2. Drag the destination end of the connection to the Extract sensor_0 and sensor1 values processor.

      reconnect consume mqtt
  10. Connect the Extract sensor_0 and sensor1 values to the Filter errors processor. When the Create Connection dialog appear, select "matched" and click Create.

    width-800
    create connection
  11. Double-click the Extract sensor_0 and sensor1 values and check the following values in the AUTOMATICALLY TERMINATED RELATIONSHIPS section and click Apply:

    • failure

    • unmatched

    • sensor_0

    • sensor_1

    terminations
  12. Before creating the last connection, you will need (again) the ID of the NiFi Input Port. Go to the NiFi Web UI , double-click on the "from Gateway" Input Port and copy its ID.

    input port id
  13. Back on the CEM Web UI, connect the Filter errors processor to the RPG:

    connect filter ro rpg
  14. In the Create Connection dialog, check the "unmatched" checkbox and enter the copied input port ID, and click on Create:

    create last connection
  15. To ignore the errors, double-click on the Filter errors processor, check the error checkbox under the AUTOMATICALLY TERMINATED RELATIONSHIPS section and click Apply:

    terminate errors
  16. Finally, click on ACTIONS > Publish…​ on the CEM canvas, enter a descriptive comment like "Added filtering of erroneous readings" and click Publish.

  17. Start the simulator again.

  18. Go to the NiFi Web UI and confirm that the data is flowing without errors within the Process Sensor Data process group. Refresh a few times and check that the numbers are changing.

  19. Use the EXPLORE feature on the SMM Web UI to confirm that the bogus readings have been filtered out.

  20. Stop the simulator once you have verified the data.

Lab 8 - Use NiFi to call the CDSW model endpoint and save to Kudu

In this lab, you will use NiFi to consume the Kafka messages containing the IoT data we ingested in the previous lab, call a CDSW model API endpoint to predict whether the machine where the readings came from is likely to break or not.

In preparation for the workshop we trained and deployed a Machine Learning model on the Cloudera Data Science Workbench (CDSW) running on your cluster. The model API can take a feature vector with the reading for the 12 temperature readings provided by the sensor and predict, based on that vector, if the machine is likely to break or not.

Add new Controller Services

When the sensor data was sent to Kafka using the PublishKafkaRecord processor, we chose to attach the schema information in the header of Kafka messages. Now, instead of hard-coding which schema we should use to read the message, we can leverage that metadata to dynamically load the correct schema for each message.

To do this, though, we need to configure a different JsonTreeReader that will use the schema properties in the header, instead of the ${schema.name} attribute, as we did before.

We’ll also add a new RestLookupService controller service to perform the calls to the CDSW model API endpoint.

  1. If you’re not in the Process Sensor Data process group, double-click on it to expand it. On the Operate panel (left-hand side), click on the cog icon (cog icon) to access the Process Sensor Data process group’s configuration page.

    operate panel cog
  2. Click on the plus button (plus button), add a new JsonTreeReader, configure it as shown below and click Apply when you’re done:

    On the SETTINGS tab:

    Name: JsonTreeReader - With schema identifier

    On the PROPERTIES tab:

    Schema Access Strategy: HWX Schema Reference Attributes
    Schema Registry:        HortonworksSchemaRegistry
  3. Click on the lightning bolt icon (enable icon) to enable the JsonTreeReader - With schema identifier controller service.

  4. Click again on the plus button (plus button), add a RestLookupService controller service, configure it as shown below and click Apply when you’re done:

    On the PROPERTIES tab:

    URL:           http://cdsw.<YOUR_CLUSTER_PUBLIC_IP>.nip.io/api/altus-ds-1/models/call-model
    Record Reader: JsonTreeReader
    Record Path:   /response
    Note
    <YOUR_CLUSTER_PUBLIC_IP> above must be replaced with your cluster’s public IP, not DNS name. The final URL should look something like this: http://cdsw.12.34.56.78.nip.io/api/altus-ds-1/models/call-model
  5. Click on the lightning bolt icon (enable icon) to enable the RestLookupService controller service.

    additional controller services
  6. Close the Process Sensor Data Configuration page.

Create the flow

We’ll now create the flow to read the sensor data from Kafka, execute a model prediction for each of them and write the results to Kudu. At the end of this section you flow should look like the one below:

from kafka to kudu flow

ConsumeKafkaRecord_2_0 processor

  1. We’ll add a new flow to the same canvas we were using before (inside the Process Sensor Data Process Group). Click on an empty area of the canvas and drag it to the side to give you more space to add new processors.

  2. Add a ConsumeKafkaRecord_2_0 processor to the canvas and configure it as shown below:

    SETTINGS tab:

    Name: Consume Kafka iot messages

    PROPERTIES tab:

    Kafka Brokers:                        edge2ai-1.dim.local:9092
    Topic Name(s):                        iot
    Topic Name Format:                    names
    Record Reader:                        JsonTreeReader - With schema identifier
    Record Writer:                        JsonRecordSetWriter
    Honor Transactions:                   false
    Group ID:                             iot-sensor-consumer
    Offset Reset:                         latest
    Headers to Add as Attributes (Regex): schema.*
  3. Add a new Funnel to the canvas and connect the Consume Kafka iot messages to it. When prompted, check the parse.failure relationship for this connection:

    parse failure relationship

LookupRecord processor

  1. Add a LookupRecord processor to the canvas and configure it as shown below:

    SETTINGS tab:

    Name: Predict machine health

    PROPERTIES tab:

    Record Reader:          JsonTreeReader - With schema identifier
    Record Writer:          JsonRecordSetWriter
    Lookup Service:         RestLookupService
    Result RecordPath:      /response
    Routing Strategy:       Route to 'success'
    Record Result Contents: Insert Entire Record
  2. Add 3 more user-defined properties by clicking on the plus button (plus button) for each of them:

    mime.type:      toString('application/json', 'UTF-8')
    request.body:   concat('{"accessKey":"', '${cdsw.access.key}', '","request":{"feature":"', /sensor_0, ', ', /sensor_1, ', ', /sensor_2, ', ', /sensor_3, ', ', /sensor_4, ', ', /sensor_5, ', ', /sensor_6, ', ', /sensor_7, ', ', /sensor_8, ', ', /sensor_9, ', ', /sensor_10, ', ', /sensor_11, '"}}')
    request.method: toString('post', 'UTF-8')
  3. Click Apply to save the changes to the Predict machine health processor.

  4. Connect the Consume Kafka iot messages processor to the Predict machine health one. When prompted, check the success relationship for this connection.

  5. Connect the Predict machine health to the same Funnel you had created above. When prompted, check the failure relationship for this connection.

UpdateRecord processor

  1. Add a UpdateRecord processor to the canvas and configure it as shown below:

    SETTINGS tab:

    Name: Update health flag

    PROPERTIES tab:

    Record Reader:              JsonTreeReader - With schema identifier
    Record Writer:              JsonRecordSetWriter
    Replacement Value Strategy: Record Path Value
  2. Add one more user-defined propertie by clicking on the plus button (plus button):

    /is_healthy: /response/result
  3. Connect the Predict machine health processor to the Update health flag one. When prompted, check the success relationship for this connection.

  4. Connect the Update health flag to the same Funnel you had created above. When prompted, check the failure relationship for this connection.

PutKudu processor

  1. Add a PutKudu processor to the canvas and configure it as shown below:

    SETTINGS tab:

    Name: Write to Kudu

    PROPERTIES tab:

    Kudu Masters:     edge2ai-1.dim.local:7051
    Table Name:       impala::default.sensors
    Record Reader:    JsonTreeReader - With schema identifier
  2. Connect the Update health flag processor to the Write to Kudu one. When prompted, check the success relationship for this connection.

  3. Connect the Write to Kudu to the same Funnel you had created above. When prompted, check the failure relationship for this connection.

  4. Double-click on the Write to Kudu processor, go to the SETTINGS tab, check the "success" relationship in the AUTOMATICALLY TERMINATED RELATIONSHIPS section. Click Apply.

CDSW Access Key

When we added the Predict machine health above, you may have noticed that one of the properties (request.body) makes a reference to a variable called cdsw.access.key. This is an application key required to authenticate with the CDSW Model API when requesting predictions. So, we need to provide the key to the LookupRecord processor by setting a variable with its value.

  1. To get the Access Key, go to the CDSW Web UI and click on Models > Iot Prediction Model > Settings. Copy the Access Key.

    model access key
  2. Go back to the NiFi Web UI, right-click on an empty area of the Process Sensor Data canvas, and click on Variables.

  3. Click on the plus button (plus button) and add the following variable:

    Variable Name:  cdsw.access.key
    Variable Value: <key copied from CDSW>
    access key variable
  4. Click Apply

Create the Kudu table

  1. Go to the Hue Web UI and login. The first user to login to a Hue installation is automatically created and granted admin privileges in Hue.

  2. The Hue UI should open with the Impala Query Editor by default. If it doesn’t, you can always find it by clicking on Query button > Editor → Impala:

    impala editor
  3. First, create the Kudu table. Login into Hue, and in the Impala Query, run this statement:

    CREATE TABLE sensors
    (
     sensor_id INT,
     sensor_ts TIMESTAMP,
     sensor_0 DOUBLE,
     sensor_1 DOUBLE,
     sensor_2 DOUBLE,
     sensor_3 DOUBLE,
     sensor_4 DOUBLE,
     sensor_5 DOUBLE,
     sensor_6 DOUBLE,
     sensor_7 DOUBLE,
     sensor_8 DOUBLE,
     sensor_9 DOUBLE,
     sensor_10 DOUBLE,
     sensor_11 DOUBLE,
     is_healthy INT,
     PRIMARY KEY (sensor_ID, sensor_ts)
    )
    PARTITION BY HASH PARTITIONS 16
    STORED AS KUDU
    TBLPROPERTIES ('kudu.num_tablet_replicas' = '1');
    create table

Running the flow

We’re ready not to run and test our flow. Follow the steps below:

  1. Start all the processors in your flow.

  2. Refresh your NiFi page and you should see messages passing through your flow. The failure queues should have no records queued up.

    kudu success

CDSW Access Key

  1. To configure and run the Spark Streaming job, you will need a CDSW Access Key to connect to the model endpoint that has been deployed there. To get the Access Key, go to the CDSW Web UI and click on Models > Iot Prediction Model > Settings. Copy the Access Key.

    model access key

STEP 1: Configure CDSW

  1. Open CDSW Web UI and log in as admin, if you haven’t yet done so.

  2. Navigate to the CDSW Admin page to fine tune the environment:

    1. In the Engines tab, add in Engines Profiles a new engine (docker image) with 2 vCPUs and 4 GB RAM, while deleting the default engine.

    2. Check if the following variable already exists under Environmental Variables. If not, add it:

      HADOOP_CONF_DIR=/etc/hadoop/conf/
      engines

STEP 2: Create the project

  1. Return to the main page and click on New Project, using this GitHub project as the source: https://github.com/tspannhw/edge2ai-workshop

    create project
  2. Now that your project has been created, click on Open Workbench and start a Python3 session:

    open workbench
  3. Once the Engine is ready, run the following command to install some required libraries:

    !pip3 install --upgrade pip scikit-learn
  4. The project comes with a historical dataset. Copy this dataset into HDFS:

    !hdfs dfs -put -f data/historical_iot.txt /user/$HADOOP_USER_NAME
    session prep
  5. You’re now ready to run the Experiment to train the model on your historical data.

  6. You can stop the Engine at this point.

Lab 12 - CDSW: Deploy the model

STEP 1: Examine the program cdsw.iot_model.py

  1. Open the project you created in the previous lab and examine the file in the Workbench. This PySpark program uses the pickle.load mechanism to deploy models. The model is loaded from the iot_modelf.pkl file, which was saved in the previous lab from the experiment with the best predictive model.

    There program also contains the predict definition, which is the function that calls the model, passing the features as parameters, and will return a result variable.

  2. Before deploying the model, try it out in the Workbench: launch a Python3 engine and run the code in file cdsw.iot_model.py. Then call the predict() method from the prompt:

    predict({"feature": "0, 65, 0, 137, 21.95, 83, 19.42, 111, 9.4, 6, 3.43, 4"})
    predict
  3. The functions returns successfully, so we know we can now deploy the model. You can now stop the engine.

STEP 2: Deploy the model

  1. From the main page of your project, select the Models button. Select New Model and specify the following configuration:

    Name:          IoT Prediction Model
    Description:   IoT Prediction Model
    File:          cdsw.iot_model.py
    Function:      predict
    Example Input: {"feature": "0, 65, 0, 137, 21.95, 83, 19.42, 111, 9.4, 6, 3.43, 4"}
    Kernel:        Python 3
    Engine:        2 vCPU / 4 GB Memory
    Replicas:      1

    create model

  2. After all parameters are set, click on the Deploy Model button. Wait till the model is deployed. This can take several minutes.

STEP 3: Test the deployed model

  1. When your model status change to Deployed, click on the model name link to go to the Model’s Overview page. From the that page, click on the Test button to check if the model is working.

  2. The green circle with the success status indicates that our REST call to the model is working. The 1 in the response {"result": 1}, means that the machine from where these temperature readings were collected is unlikely to experience a failure.

    test model
  3. Now, lets change the input parameters and call the predict function again. Put the following values in the Input field:

    {
      "feature": "0, 95, 0, 88, 26.62, 75, 21.05, 115, 8.65, 5, 3.32, 3"
    }
  4. With these input parameters, the model returns 0, which means that the machine is likely to break.

Resources

Troubleshooting

*MiNiFi Not Sending Messages *

  • Make sure you pick S2S not RAW in Cloud Connection to NiFi

  • Make sure No Spaces Before or After Destination ID, URL, Names, Topics, Brokers, Etc…​

  • Make sure No Spaces Anywhere

  • Everything is Case-Sensitive. It’s IoT, not iot.

  • Use User=Admin for CDSW and HUE

  • You must have HDFS User Created via HUE, Go there First

  • Check all your connections and spellings

  • Check /opt/cloudera/cem/minifi/logs/minifi-app.log if you can’t find an issue

CEM doesn’t pick up new NARs

  1. Delete the agent manifest manually using the EFM API:

  2. Verify each class has the same agent manifest ID:

    http://hostname:10080/efm/api/agent-classes
    [{"name":"iot1","agentManifests":["agent-manifest-id"]},{"name":"iot4","agentManifests":["agent-manifest-id"]}]
  3. Confirm the manifest doesn’t have the NAR you installed

    http://hostname:10080/efm/api/agent-manifests?class=iot4
    [{"identifier":"agent-manifest-id","agentType":"minifi-java","version":"1","buildInfo":{"timestamp":1556628651811,"compiler":"JDK 8"},"bundles":[{"group":"default","artifact":"system","version":"unversioned","componentManifest":{"controllerServices":[],"processors":
  4. Call the API endpoint:

    http://hostname:10080/efm/swagger/
  5. Hit the DELETE - Delete the agent manifest specified by id button, and in the id field, enter agent-manifest-id


if you get transfer relationship not specified in java

just change the schema access strategy from inherited to from attribute in the json writter

this will change in NiFi 1.11

OR

workaround

add the new column in the schema

in HWX Schema Registry

if they add the new column in the Schema Registry it went through