![\"FIWARE](\"https://nexus.lab.fiware.org/static/badges/chapters/core.svg\")
\n![\"NGSI](\"https://img.shields.io/badge/NGSI-v2-5dc0cf.svg\"){kind=icon}
\n
This tutorial is an introduction to the FIWARE Cosmos Orion Spark Connector, which\nenables easier Big Data analysis over context, integrated with one of the most popular BigData platforms:\nApache Spark. Apache Spark is a framework and distributed processing engine for stateful\ncomputations over unbounded and bounded data streams. Spark has been designed to run in all common cluster environments,\nperform computations at in-memory speed and at any scale.
\nThe docker-compose files for this tutorial can be found on GitHub:
![\"GitHub\"](\"https://fiware.github.io/tutorials.Big-Data-Spark/icon/GitHub-Mark-32px.png\"){kind=icon}
https://github.com/FIWARE/tutorials.Big-Data-Spark
\n\n\"You have to find what sparks a light in you so that you in your own way can illuminate the world.\"
\n— Oprah Winfrey
\n
Smart solutions based on FIWARE are architecturally designed around microservices. They are therefore are designed to\nscale-up from simple applications (such as the Supermarket tutorial) through to city-wide installations base on a large\narray of IoT sensors and other context data providers.
\nThe massive amount of data involved eventually becomes too much for a single machine to analyse, process and store, and\ntherefore the work must be delegated to additional distributed services. These distributed systems form the basis of\nso-called Big Data Analysis. The distribution of tasks allows developers to be able to extract insights from huge\ndata sets which would be too complex to be dealt with using traditional methods. and uncover hidden patterns and\ncorrelations.
\nAs we have seen, context data is core to any Smart Solution, and the Context Broker is able to monitor changes of state\nand raise subscription events as the context changes. For smaller\ninstallations, each subscription event can be processed one-by-one by a single receiving endpoint, however as the system\ngrows, another technique will be required to avoid overwhelming the listener, potentially blocking resources and missing\nupdates.
\nApache Spark is an open-source distributed general-purpose cluster-computing framework. It provides an interface for\nprogramming entire clusters with implicit data parallelism and fault tolerance. The Cosmos Spark connector allows\ndevelopers write custom business logic to listen for context data subscription events and then process the flow of the\ncontext data. Spark is able to delegate these actions to other workers where they will be acted upon either in\nsequentially or in parallel as required. The data flow processing itself can be arbitrarily complex.
\nObviously, in reality, our existing Supermarket scenario is far too small to require the use of a Big Data solution, but\nwill serve as a basis for demonstrating the type of real-time processing which may be required in a larger solution\nwhich is processing a continuous stream of context-data events.
\nThis application builds on the components and dummy IoT devices created in\nprevious tutorials. It will make use of three FIWARE components - the\nOrion Context Broker, the\nIoT Agent for Ultralight 2.0, and the\nCosmos Orion Spark Connector for connecting Orion to an\nApache Spark cluster. The Spark cluster itself will\nconsist of a single Cluster Manager master to coordinate execution and some Worker Nodes worker to execute\nthe tasks.
\nBoth the Orion Context Broker and the IoT Agent rely on open source MongoDB technology to\nkeep persistence of the information they hold. We will also be using the dummy IoT devices created in the\nprevious tutorial.
\nTherefore the overall architecture will consist of the following elements:
\nThe overall architecture can be seen below:
\n![\"\"](\"https://fiware.github.io/tutorials.Big-Data-Spark/img/Tutorial%20FIWARE%20Spark.png\")
spark-master:\n image: bde2020/spark-master:2.4.5-hadoop2.7\n container_name: spark-master\n expose:\n - \"8080\"\n - \"9001\"\n ports:\n - \"8080:8080\"\n - \"7077:7077\"\n - \"9001:9001\"\n environment:\n - INIT_DAEMON_STEP=setup_spark\n - \"constraint:node==spark-master\"\nspark-worker-1:\n image: bde2020/spark-worker:2.4.5-hadoop2.7\n container_name: spark-worker-1\n depends_on:\n - spark-master\n ports:\n - \"8081:8081\"\n environment:\n - \"SPARK_MASTER=spark://spark-master:7077\"\n - \"constraint:node==spark-master\"\nThe spark-master container is listening on three ports:
8080 is exposed so we can see the web frontend of the Apache Spark-Master Dashboard.7070 is used for internal communications.The spark-worker-1 container is listening on one port:
9001 is exposed so that the installation can receive context data subscriptions.8081 is exposed so we can see the web frontend of the Apache Spark-Worker-1 Dashboard.To keep things simple, all components will be run using Docker. Docker is a container\ntechnology which allows to different components isolated into their respective environments.
\nDocker Compose is a tool for defining and running multi-container Docker applications. A series of\nYAML files are used to configure the\nrequired services for the application. This means all container services can be brought up in a single command. Docker\nCompose is installed by default as part of Docker for Windows and Docker for Mac, however Linux users will need to\nfollow the instructions found here
\nYou can check your current Docker and Docker Compose versions using the following commands:
\ndocker-compose -v\ndocker version\nPlease ensure that you are using Docker version 18.03 or higher and Docker Compose 1.21 or higher and upgrade if\nnecessary.
\nApache Maven is a software project management and comprehension tool. Based on\nthe concept of a project object model (POM), Maven can manage a project's build, reporting and documentation from a\ncentral piece of information. We will use Maven to define and download our dependencies and to build and package our\ncode into a JAR file.
\nWe will start up our services using a simple Bash script. Windows users should download cygwin\nto provide a command-line functionality similar to a Linux distribution on Windows.
\nBefore you start, you should ensure that you have obtained or built the necessary Docker images locally. Please clone\nthe repository and create the necessary images by running the commands shown below. Note that you might need to run some\nof the commands as a privileged user:
\ngit clone https://github.com/ging/fiware-cosmos-orion-spark-connector-tutorial.git\ncd fiware-cosmos-orion-spark-connector-tutorial\n./services create\nThis command will also import seed data from the previous tutorials and provision the dummy IoT sensors on startup.
\nTo start the system, run the following command:
\n./services start\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Real-time Processing and Big Data Analysis","slug":"real-time-processing-and-big-data-analysis"},{"content":"Architecture","slug":"architecture"},{"content":"Prerequisites","slug":"prerequisites"},{"content":"Start Up","slug":"start-up"}],"owner":"513743","collectionId":"c5e9ec44-1e49-4561-8b40-9c8636838f08","publishedId":"TVev6kks","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"233C68"},"publishDate":"2020-11-23T13:19:12.000Z"},"item":[{"name":"Receiving context data and performing operations","item":[{"name":"Orion - Subscribe to Context Changes","id":"0dc1fc51-4784-4d63-b669-92e0453d20a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"fiware-service","value":"openiot"},{"key":"fiware-servicepath","value":"/"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Notify Spark of all context changes\",\n \"subject\": {\n \"entities\": [\n {\n \"idPattern\": \".*\"\n }\n ]\n },\n \"notification\": {\n \"http\": {\n \"url\": \"http://spark-worker-1:9001\"\n }\n }\n}"},"url":"http://localhost:1026/v2/subscriptions/","description":":information_source: Note: If you want to clean up and start over again you can do so with the following command:
\n\n./services stop\n
Once a dynamic context system is up and running (we have deployed the Logger job in the Spark cluster), we need to\ninform Spark of changes in context.
This is done by making a POST request to the /v2/subscription endpoint of the Orion Context Broker.
The fiware-service and fiware-servicepath headers are used to filter the subscription to only listen to\nmeasurements from the attached IoT Sensors, since they had been provisioned using these settings
The notification url must match the one our Spark program is listening to.
The throttling value defines the rate that changes are sampled.
If a subscription has been created, we can check to see if it is firing by making a GET request to the\n/v2/subscriptions endpoint.
Within the notification section of the response, you can see several additional attributes which describe the health\nof the subscription
If the criteria of the subscription have been met, timesSent should be greater than 0. A zero value would indicate\nthat the subject of the subscription is incorrect or the subscription has created with the wrong fiware-service-path\nor fiware-service header
The lastNotification should be a recent timestamp - if this is not the case, then the devices are not regularly\nsending data. Remember to unlock the Smart Door and switch on the Smart Lamp
The lastSuccess should match the lastNotification date - if this is not the case then Cosmos is not receiving\nthe subscription properly. Check that the hostname and port are correct.
Finally, check that the status of the subscription is active - an expired subscription will not fire.
According to the Apache Spark documentation, Spark Streaming is an\nextension of the core Spark API that enables scalable, high-throughput, fault-tolerant stream processing of live data\nstreams. Data can be ingested from many sources like Kafka, Flume, Kinesis, or TCP sockets, and can be processed using\ncomplex algorithms expressed with high-level functions like map, reduce, join and window. Finally, processed data can be\npushed out to filesystems, databases, and live dashboards. In fact, you can apply Spark’s machine learning and graph\nprocessing algorithms on data streams.
\n![](\"https://spark.apache.org/docs/latest/img/streaming-arch.png\")
Internally, it works as follows. Spark Streaming receives live input data streams and divides the data into batches,\nwhich are then processed by the Spark engine to generate the final stream of results in batches.
\n![](\"https://spark.apache.org/docs/latest/img/streaming-flow.png\")
This means that to create a streaming data flow we must supply the following:
\nThe Cosmos Spark connector - orion.spark.connector-1.2.1.jar offers both Source and Sink operators. It\ntherefore only remains to write the necessary Scala code to connect the streaming dataflow pipeline operations together.\nThe processing code can be complied into a JAR file which can be uploaded to the spark cluster. Two examples will be\ndetailed below, all the source code for this tutorial can be found within the\ncosmos-examples\ndirectory.
Further Spark processing examples can be found on\nSpark Connector Examples.
\nAn existing pom.xml file has been created which holds the necessary prerequisites to build the examples JAR file
In order to use the Orion Spark Connector we first need to manually install the connector JAR as an artifact using\nMaven:
\ncd cosmos-examples\ncurl -LO https://github.com/ging/fiware-cosmos-orion-spark-connector/releases/download/FIWARE_7.9/orion.spark.connector-1.2.1.jar\nmvn install:install-file \\\n -Dfile=./orion.spark.connector-1.2.1.jar \\\n -DgroupId=org.fiware.cosmos \\\n -DartifactId=orion.spark.connector \\\n -Dversion=1.2.1 \\\n -Dpackaging=jar\nThereafter the source code can be compiled by running the mvn package command within the same directory\n(cosmos-examples):
mvn package\nA new JAR file called cosmos-examples-1.2.1.jar will be created within the cosmos-examples/target directory.
For the purpose of this tutorial, we must be monitoring a system in which the context is periodically being updated. The\ndummy IoT Sensors can be used to do this. Open the device monitor page at http://localhost:3000/device/monitor and\nunlock a Smart Door and switch on a Smart Lamp. This can be done by selecting an appropriate the command from\nthe drop down list and pressing the send button. The stream of measurements coming from the devices can then be seen\non the same page:
![](\"https://fiware.github.io/tutorials.Big-Data-Spark/img/door-open.gif\")
The first example makes use of the OrionReceiver operator in order to receive notifications from the Orion Context\nBroker. Specifically, the example counts the number notifications that each type of device sends in one minute. You can\nfind the source code of the example in\norg/fiware/cosmos/tutorial/Logger.scala
Restart the containers if necessary, then access the worker container:
\ndocker exec -it spark-worker-1 bin/bash\nAnd run the following command to run the generated JAR package in the Spark cluster:
\n/spark/bin/spark-submit \\\n--class org.fiware.cosmos.tutorial.Logger \\\n--master spark://spark-master:7077 \\\n--deploy-mode client /home/cosmos-examples/target/cosmos-examples-1.2.1.jar \\\n--conf \"spark.driver.extraJavaOptions=-Dlog4jspark.root.logger=WARN,console\"\nLeave the subscription running for one minute. Then, the output on the console on which you ran the Spark job will\nbe like the following:
\nSensor(Bell,3)\nSensor(Door,4)\nSensor(Lamp,7)\nSensor(Motion,6)\npackage org.fiware.cosmos.tutorial\n\nimport org.apache.spark.SparkConf\nimport org.apache.spark.streaming.{Seconds, StreamingContext}\nimport org.fiware.cosmos.orion.spark.connector.OrionReceiver\n\nobject Logger{\n\n def main(args: Array[String]): Unit = {\n\n val conf = new SparkConf().setAppName(\"Logger\")\n val ssc = new StreamingContext(conf, Seconds(60))\n // Create Orion Receiver. Receive notifications on port 9001\n val eventStream = ssc.receiverStream(new OrionReceiver(9001))\n\n // Process event stream\n val processedDataStream= eventStream\n .flatMap(event => event.entities)\n .map(ent => {\n new Sensor(ent.`type`)\n })\n .countByValue()\n .window(Seconds(60))\n\n processedDataStream.print()\n\n ssc.start()\n ssc.awaitTermination()\n }\n case class Sensor(device: String)\n}\nThe first lines of the program are aimed at importing the necessary dependencies, including the connector. The next step\nis to create an instance of the OrionReceiver using the class provided by the connector and to add it to the\nenvironment provided by Spark.
The OrionReceiver constructor accepts a port number (9001) as a parameter. This port is used to listen to the\nsubscription notifications coming from Orion and converted to a DataStream of NgsiEvent objects. The definition of\nthese objects can be found within the\nOrion-Spark Connector documentation.
The stream processing consists of five separate steps. The first step (flatMap()) is performed in order to put\ntogether the entity objects of all the NGSI Events received in a period of time. Thereafter the code iterates over them\n(with the map() operation) and extracts the desired attributes. In this case, we are interested in the sensor type\n(Door, Motion, Bell or Lamp).
Within each iteration, we create a custom object with the property we need: the sensor type. For this purpose, we can\ndefine a case class as shown:
case class Sensor(device: String)\nThereafter can count the created objects by the type of device (countByValue()) and perform operations such as\nwindow() on them.
After the processing, the results are output to the console:
\nprocessedDataStream.print()\nIf the previous example has not been run, a new subscription will need to be set up. A narrower subscription can be set\nup to only trigger a notification when a motion sensor detects movement.
\n\n\n","urlObject":{"protocol":"http","path":["v2","subscriptions",""],"host":["localhost:1026"],"query":[],"variable":[]}},"response":[],"_postman_id":"84d6c8a8-eefc-4c10-9f69-ca78a824b540"},{"name":"Orion - Check Subscription is working","id":"3a1094c5-debd-4dff-a962-8df426744d1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"fiware-service","value":"openiot"},{"key":"fiware-servicepath","value":"/"}],"url":"http://localhost:1026/v2/subscriptions/","description":"Note: If the previous subscription already exists, this step creating a second narrower Motion-only subscription\nis unnecessary. There is a filter within the business logic of the scala task itself.
\n
If a subscription has been created, you can check to see if it is firing by making a GET \nrequest to the /v2/subscriptions endpoint.
Within the notification section of the response, you can see several additional attributes which describe the health of the subscription
If the criteria of the subscription have been met, timesSent should be greater than 0.\nA zero value would indicate that the subject of the subscription is incorrect or the subscription \nhas created with the wrong fiware-service-path or fiware-service header
The lastNotification should be a recent timestamp - if this is not the case, then the devices\nare not regularly sending data. Remember to unlock the Smart Door and switch on the Smart Lamp
The lastSuccess should match the lastNotification date - if this is not the case \nthen Draco is not receiving the subscription properly. Check that the host name\nand port are correct.
Finally, check that the status of the subscription is active - an expired subscription\nwill not fire.
If a subscription has been created, you can check to see if it is firing by making a GET \nrequest to the /v2/subscriptions endpoint.
Within the notification section of the response, you can see several additional attributes which describe the health of the subscription
If the criteria of the subscription have been met, timesSent should be greater than 0.\nA zero value would indicate that the subject of the subscription is incorrect or the subscription \nhas created with the wrong fiware-service-path or fiware-service header
The lastNotification should be a recent timestamp - if this is not the case, then the devices\nare not regularly sending data. Remember to unlock the Smart Door and switch on the Smart Lamp
The lastSuccess should match the lastNotification date - if this is not the case \nthen Draco is not receiving the subscription properly. Check that the host name\nand port are correct.
Finally, check that the status of the subscription is active - an expired subscription\nwill not fire.
The second example switches on a lamp when its motion sensor detects movement.
\nThe dataflow stream uses the OrionReceiver operator in order to receive notifications and filters the input to only\nrespond to motion senseors and then uses the OrionSink to push processed context back to the Context Broker. You can\nfind the source code of the example in\norg/fiware/cosmos/tutorial/Feedback.scala
/spark/bin/spark-submit \\\n--class org.fiware.cosmos.tutorial.Feedback \\\n--master spark://spark-master:7077 \\\n--deploy-mode client /home/cosmos-examples/target/cosmos-examples-1.2.1.jar \\\n--conf \"spark.driver.extraJavaOptions=-Dlog4jspark.root.logger=WARN,console\"\nGo to http://localhost:3000/device/monitor
Within any Store, unlock the door and wait. Once the door opens and the Motion sensor is triggered, the lamp will switch\non directly
\npackage org.fiware.cosmos.tutorial\n\nimport org.apache.spark.SparkConf\nimport org.apache.spark.streaming.{Seconds, StreamingContext}\nimport org.fiware.cosmos.orion.spark.connector._\n\nobject Feedback {\n final val CONTENT_TYPE = ContentType.JSON\n final val METHOD = HTTPMethod.PATCH\n final val CONTENT = \"{\\n \\\"on\\\": {\\n \\\"type\\\" : \\\"command\\\",\\n \\\"value\\\" : \\\"\\\"\\n }\\n}\"\n final val HEADERS = Map(\"fiware-service\" -> \"openiot\",\"fiware-servicepath\" -> \"/\",\"Accept\" -> \"*/*\")\n\n def main(args: Array[String]): Unit = {\n\n val conf = new SparkConf().setAppName(\"Feedback\")\n val ssc = new StreamingContext(conf, Seconds(10))\n // Create Orion Receiver. Receive notifications on port 9001\n val eventStream = ssc.receiverStream(new OrionReceiver(9001))\n\n // Process event stream\n val processedDataStream = eventStream\n .flatMap(event => event.entities)\n .filter(entity=>(entity.attrs(\"count\").value == \"1\"))\n .map(entity=> new Sensor(entity.id))\n .window(Seconds(10))\n\n val sinkStream= processedDataStream.map(sensor => {\n val url=\"http://localhost:1026/v2/entities/Lamp:\"+sensor.id.takeRight(3)+\"/attrs\"\n OrionSinkObject(CONTENT,url,CONTENT_TYPE,METHOD,HEADERS)\n })\n // Add Orion Sink\n OrionSink.addSink( sinkStream )\n\n // print the results with a single thread, rather than in parallel\n processedDataStream.print()\n ssc.start()\n\n ssc.awaitTermination()\n }\n\n case class Sensor(id: String)\n}\nAs you can see, it is similar to the previous example. The main difference is that it writes the processed data back in\nthe Context Broker through the OrionSink.
The arguments of the OrionSinkObject are:
\"{\\n \\\"on\\\": {\\n \\\"type\\\" : \\\"command\\\",\\n \\\"value\\\" : \\\"\\\"\\n }\\n}\". We send 'on' command\"http://localhost:1026/v2/entities/Lamp:\"+node.id.takeRight(3)+\"/attrs\". TakeRight(3) gets the number of\nthe room, for example '001')ContentType.Plain.HTTPMethod.POST.Map(\"fiware-service\" -> \"openiot\",\"fiware-servicepath\" -> \"/\",\"Accept\" -> \"*/*\"). Optional parameter.\nWe add the headers we need in the HTTP Request.