Use Azure Toolkit for Eclipse to create Apache Spark applications for an HDInsight cluster

Use HDInsight Tools in Azure Toolkit for Eclipse to develop Apache Spark applications written in Scala and submit them to an Azure HDInsight Spark cluster, directly from the Eclipse IDE. You can use the HDInsight Tools plug-in in a few different ways:

  • To develop and submit a Scala Spark application on an HDInsight Spark cluster.
  • To access your Azure HDInsight Spark cluster resources.
  • To develop and run a Scala Spark application locally.

Prerequisites

Install required plug-ins

Install Azure Toolkit for Eclipse

For installation instructions, see Installing Azure Toolkit for Eclipse.

Install the Scala plug-in

When you open Eclipse, HDInsight Tools automatically detects whether you installed the Scala plug-in. Select OK to continue, and then follow the instructions to install the plug-in from the Eclipse Marketplace. Restart the IDE after installation completes.

Automatic installation of the Scala plug-in

Confirm plug-ins

  1. Navigate to Help > Eclipse Marketplace....

  2. Select the Installed tab.

  3. You should see at least:

    • Azure Toolkit for Eclipse <version>.
    • Scala IDE <version>.

Sign in to your Azure subscription

  1. Start Eclipse IDE.

  2. Navigate to Window > Show View > Other... > Sign In...

  3. From the Show View dialog, navigate to Azure > Azure Explorer, and then select Open.

    Apache Spark Eclipse show view

  4. From Azure Explorer, right-click the Azure node, and then select Sign in.

  5. In the Azure Sign In dialog box, choose the authentication method, select Sign in, and complete the sign-in process.

    Apache Spark Eclipse Azure Sign

  6. After you're signed in, the Your Subscriptions dialog box lists all the Azure subscriptions associated with the credentials. Press Select to close the dialog box.

    Select Subscriptions dialog box

  7. From Azure Explorer, navigate to Azure > HDInsight to see the HDInsight Spark clusters under your subscription.

    HDInsight Spark clusters in Azure Explorer3

  8. You can further expand a cluster name node to see the resources (for example, storage accounts) associated with the cluster.

    Expanding a cluster name to see resources

You can link a normal cluster by using the Ambari managed username. Similarly, for a domain-joined HDInsight cluster, you can link by using the domain and username, such as user1@contoso.com.

  1. From Azure Explorer, right-click HDInsight, and select Link A Cluster.

    Azure Explorer link cluster menu

  2. Enter Cluster Name, User Name, and Password, then select OK. Optionally, enter Storage Account, Storage Key and then select Storage Container for storage explorer to work in the left tree view

    Link New HDInsight cluster dialog

    Note

    We use the linked storage key, username and password if the cluster both logged in Azure subscription and Linked a cluster. Azure Explorer storage accounts

    For the keyboard only user, when the current focus is at Storage Key, you need to use Ctrl+TAB to focus on the next field in the dialog.

  3. You can see the linked cluster under HDInsight. Now you can submit an application to this linked cluster.

    Azure Explorer hdi linked cluster

  4. You also can unlink a cluster from Azure Explorer.

    Azure Explorer unlinked cluster

Set up a Spark Scala project for an HDInsight Spark cluster

  1. From the Eclipse IDE workspace, select File > New > Project....

  2. In the New Project wizard, select HDInsight Project > Spark on HDInsight (Scala). Then select Next.

    Selecting the Spark on HDInsight (Scala) project

  3. In the New HDInsight Scala Project dialog box, provide the following values, and then select Next:

    • Enter a name for the project.
    • In the JRE area, make sure that Use an execution environment JRE is set to JavaSE-1.7 or later.
    • In the Spark Library area, you can choose Use Maven to configure Spark SDK option. Our tool integrates the proper version for Spark SDK and Scala SDK. You can also choose Add Spark SDK manually option, download, and add Spark SDK by manually.

    New HDInsight Scala Project dialog box

  4. In the next dialog box, review the details, and then select Finish.

Create a Scala application for an HDInsight Spark cluster

  1. From Package Explorer, expand the project that you created earlier. Right-click src, select New > Other....

  2. In the Select a wizard dialog box, select Scala Wizards > Scala Object. Then select Next.

    Select a wizard Create a Scala Object

  3. In the Create New File dialog box, enter a name for the object, and then select Finish. A text editor will open.

    New File Wizard Create New File

  4. In the text editor, replace the current contents with the code below:

    import org.apache.spark.SparkConf
    import org.apache.spark.SparkContext
    
    object MyClusterApp{
        def main (arg: Array[String]): Unit = {
        val conf = new SparkConf().setAppName("MyClusterApp")
        val sc = new SparkContext(conf)
    
        val rdd = sc.textFile("wasbs:///HdiSamples/HdiSamples/SensorSampleData/hvac/HVAC.csv")
    
        //find the rows that have only one digit in the seventh column in the CSV
        val rdd1 =  rdd.filter(s => s.split(",")(6).length() == 1)
    
        rdd1.saveAsTextFile("wasbs:///HVACOut")
        }
    }
    
  5. Run the application on an HDInsight Spark cluster:

    a. From Package Explorer, right-click the project name, and then select Submit Spark Application to HDInsight.

    b. In the Spark Submission dialog box, provide the following values, and then select Submit:

    • For Cluster Name, select the HDInsight Spark cluster on which you want to run your application.

    • Select an artifact from the Eclipse project, or select one from a hard drive. The default value depends on the item that you right-click from Package Explorer.

    • In the Main class name drop-down list, the submission wizard displays all object names from your project. Select or enter one that you want to run. If you selected an artifact from a hard drive, you must enter the main class name manually.

    • Because the application code in this example doesn't require any command-line arguments or reference JARs or files, you can leave the remaining text boxes empty.

      Apache Spark Submission dialog box

  6. The Spark Submission tab should start displaying the progress. You can stop the application by selecting the red button in the Spark Submission window. You can also view the logs for this specific application run by selecting the globe icon (denoted by the blue box in the image).

    Apache Spark Submission window

Access and manage HDInsight Spark clusters by using HDInsight Tools in Azure Toolkit for Eclipse

You can perform various operations by using HDInsight Tools, including accessing the job output.

Access the job view

  1. In Azure Explorer, expand HDInsight, then the Spark cluster name, and then select Jobs.

    Azure Explorer Eclipse job view node

  2. Select the Jobs node. If Java version is lower than 1.8, HDInsight Tools automatically reminder you install the E(fx)clipse plug-in. Select OK to continue, and then follow the wizard to install it from the Eclipse Marketplace and restart Eclipse.

    Install missing plugin E(fx)clipse

  3. Open the Job View from the Jobs node. In the right pane, the Spark Job View tab displays all the applications that were run on the cluster. Select the name of the application for which you want to see more details.

    Apache Eclipse view job logs details

    You can then take any of these actions:

    • Hover on the job graph. It displays basic info about the running job. Select the job graph, and you can see the stages and info that every job generates.

      Apache Spark job graph stage info

    • Select the Log tab to view frequently used logs, including Driver Stderr, Driver Stdout, and Directory Info.

      Apache Spark Eclipse job log info

    • Open the Spark history UI and the Apache Hadoop YARN UI (at the application level) by selecting the hyperlinks at the top of the window.

Access the storage container for the cluster

  1. In Azure Explorer, expand the HDInsight root node to see a list of HDInsight Spark clusters that are available.

  2. Expand the cluster name to see the storage account and the default storage container for the cluster.

    Storage account and default storage container

  3. Select the storage container name associated with the cluster. In the right pane, double-click the HVACOut folder. Open one of the part- files to see the output of the application.

Access the Spark history server

  1. In Azure Explorer, right-click your Spark cluster name, and then select Open Spark History UI. When you're prompted, enter the admin credentials for the cluster. You specified these while provisioning the cluster.

  2. In the Spark history server dashboard, you use the application name to look for the application that you just finished running. In the preceding code, you set the application name by using val conf = new SparkConf().setAppName("MyClusterApp"). So, your Spark application name was MyClusterApp.

Start the Apache Ambari portal

  1. In Azure Explorer, right-click your Spark cluster name, and then select Open Cluster Management Portal (Ambari).

  2. When you're prompted, enter the admin credentials for the cluster. You specified these while provisioning the cluster.

Manage Azure subscriptions

By default, HDInsight Tool in Azure Toolkit for Eclipse lists the Spark clusters from all your Azure subscriptions. If necessary, you can specify the subscriptions for which you want to access the cluster.

  1. In Azure Explorer, right-click the Azure root node, and then select Manage Subscriptions.

  2. In the dialog box, clear the check boxes for the subscription that you don't want to access, and then select Close. You can also select Sign Out if you want to sign out of your Azure subscription.

Run a Spark Scala application locally

You can use HDInsight Tools in Azure Toolkit for Eclipse to run Spark Scala applications locally on your workstation. Typically, these applications don't need access to cluster resources such as a storage container, and you can run and test them locally.

Prerequisite

While you're running the local Spark Scala application on a Windows computer, you might get an exception as explained in SPARK-2356. This exception occurs because WinUtils.exe is missing in Windows.

To resolve this error, you need Winutils.exe to a location like C:\WinUtils\bin, and then add the environment variable HADOOP_HOME and set the value of the variable to C\WinUtils.

Run a local Spark Scala application

  1. Start Eclipse and create a project. In the New Project dialog box, make the following choices, and then select Next.

  2. In the New Project wizard, select HDInsight Project > Spark on HDInsight Local Run Sample (Scala). Then select Next.

    New project selects a wizard dialog

  3. To provide the project details, follow steps 3 through 6 from the earlier section Setup a Spark Scala project for an HDInsight Spark cluster.

  4. The template adds a sample code (LogQuery) under the src folder that you can run locally on your computer.

    Location of LogQuery local scala application

  5. Right-click LogQuery.scala , and select Run As > 1 Scala Application. Output like this appears on the Console tab:

    Spark application local run result

Reader-only role

When users submit job to a cluster with reader-only role permission, Ambari credentials is required.

  1. Sign in with reader-only role account.

  2. From Azure Explorer, expand HDInsight to view HDInsight clusters that are in your subscription. The clusters marked "Role:Reader" only have reader-only role permission.

    HDInsight Spark clusters in Azure Explorer role reader

  3. Right-click the cluster with reader-only role permission. Select Link this cluster from context menu to link cluster. Enter the Ambari username and password.

    HDInsight Spark clusters in Azure Explorer link

  4. If the cluster is linked successfully, HDInsight will be refreshed. The stage of the cluster will become linked.

    HDInsight Spark clusters in Azure Explorer linked

  1. Click Jobs node, Cluster Job Access Denied window pops up.

  2. Click Link this cluster to link cluster.

    HDInsight Spark clusters in Azure Explorer9

  1. Create an HDInsight Project.

  2. Right-click the package. Then select Submit Spark Application to HDInsight.

    HDInsight Spark clusters in Azure Explorer submit

  3. Select a cluster, which has reader-only role permission for Cluster Name. Warning message shows out. You can click Link this cluster to link cluster.

    HDInsight Spark clusters in Azure Explorer link this

View Storage Accounts

  • For clusters with reader-only role permission, click Storage Accounts node, Storage Access Denied window pops up.

    HDInsight Spark clusters in Azure Explorer storage

    HDInsight Spark clusters in Azure Explorer denied

  • For linked clusters, click Storage Accounts node, Storage Access Denied window pops up.

    HDInsight Spark clusters in Azure Explorer denied2

Known problems

When using Link A Cluster, I would suggest you to provide credential of storage.

link cluster with storage credential eclipses

There are two modes to submit the jobs. If storage credential is provided, batch mode will be used to submit the job. Otherwise, interactive mode will be used. If the cluster is busy, you might get the error below.

eclipse get error when cluster busy

eclipse get error when cluster busy yarn

See also

Scenarios

Creating and running applications

Tools and extensions

Managing resources