This repository contains an application which is built to demonstrate as an example of Apache Storm distributed framework by finding the top hashtags of Twitter in real-time.
Apache Storm is an open source distributed real-time computation system, developed at BackType by Nathan Marz and team. It has been open sourced by Twitter [post BackType acquisition] in August, 2011. And Storm became a top level project in Apache on 29th September, 2014.
This application has been developed and tested initially with Storm v0.8.2 on Windows 7 in local mode; and was eventually updated and tested with Storm v0.9.3 on 28th December, 2014. Application may or may not work with earlier or later versions than Apache Storm v0.9.3.
This application has been tested in:
- Local mode on a CentOS virtual machine and even on Microsoft Windows 7 machine.
- Cluster mode on a private cluster and also on Amazon EC2 environment of 4 machines and 5 machines respectively; with all the machines in private cluster running Ubuntu while EC2 environment machines were powered by CentOS.
- Recent update to Apache Storm v0.9.3 has not been tested in a Cluster mode.
- Application retrieves tweets from Twitter stream (using Twitter4J).
- It calculates stats of the top hashtags every 30 seconds.
- After processing, the application logs the top hashtags grouped by their count to the console and also to a log file using Logback.
- In local mode, topology runs for 2 minutes and then shuts down. Topology run can be updated by modifying this value in
TopHashtagsTopology.java. - Also, this project has been made compatible with both Eclipse IDE and IntelliJ IDEA. Import the project in your favorite IDE [which has Maven plugin installed] and you can quickly follow the code.
Please check the config.properties and add your own values and complete the integration of Twitter API to your application by looking at your values from Twitter Developer Page.
If you did not create a Twitter App before, then please create a new Twitter App where you will get all the required values of config.properties afresh and then populate them here without any mistake.
- Apache Storm v0.9.3
- Twitter4J v4.0.2
- Google Guava v18.0
- Logback v1.1.2
Also, please check pom.xml for more information on the various dependencies of the project.
This project uses Apache Maven to build and run the topology.
You need the following on your machine:
- Oracle JDK >= 1.8.x
- Apache Maven >= 3.2.3
- Clone this repo and import as an existing Apache Maven project to either Eclipse IDE or IntelliJ IDEA.
- This application uses Google Guava for making life simple while using Collections.
- Requires ZooKeeper, etc installed and configured in case of executing this project in distributed mode i.e. Storm Cluster.
- Follow the steps mentioned on Storm Wiki for more details on setting up a Storm Cluster.
- Follow the steps mentioned on Storm Wiki for more details on setting up a Storm Cluster.
Rest of the required frameworks and libraries are downloaded by Apache Maven as required in the build process, the first time the Apache Maven build is invoked.
To build and run this topology, you must use Java 1.8.
Local mode can also be run on Windows environment without installing any specific software or framework as such.
Note: Please be sure to clear your temp folder as it adds lot of temporary files in every run.
In local mode, this application can be run from command line by invoking:
mvn clean compile exec:java -Dexec.classpathScope=compile -Dexec.mainClass=org.p7h.storm.hashtags.topology.TopHashtagsTopology
or
mvn clean compile package && java -jar target/storm-top-hashtags-0.1-jar-with-dependencies.jar
Distributed mode requires a complete and proper Storm Cluster setup. Please check Apache Storm wiki for setting up a Storm Cluster.
In distributed mode, after starting Nimbus and Supervisors on individual machines, this application can be executed on the master [or Nimbus] machine by invoking the following on the command line:
storm jar target/storm-top-hashtags-0.1.jar org.p7h.storm.hashtags.topology.TopHashtagsTopology TopHashtags
If you find any issues, please report them either raising an issue here on GitHub or alert me on my Twitter handle @P7h. Or even better, please send a pull request. Appreciate your help. Thanks!
Copyright © 2013-2015 Prashanth Babu.
Licensed under the Apache License, Version 2.0.