salesforce Dreamforce On-Demand
Contact Us 1-800-596-4880
  1. Homepage
  2. Mule Management Console (3.4)

  3. MMC Walkthrough

MMC Walkthrough

Mule Management Console’s graphical interface offers visibility into your Web application server(s) so you can monitor and manage multiple Mule applications.

Walkthrough Description

This walkthrough illustrates some of the basic functionality MMC provides as a monitoring tool:

  • how to register a server

  • how to deploy a sample application onto the server

  • how to monitor flow activity in the application

  • how to undeploy the application

End Result

At the end of this walkthrough, you’ll have successfully deployed a sample application onto a server using the console, verified the health of the application by monitoring the activity of the individual flows, and undeployed the application from the server.

Learning Outcome

After completing the walkthrough, you will understand the basic mechanisms by which you can register servers and deploy and manage applications using the console.

Assumptions

This walkthrough assumes that you are familiar with Mule applications and Mule flows and that you have downloaded and installed Mule ESB Enterprise Runtime (with Management Tools) which includes a trial version of the Mule Management Console. Beyond installation, you do not need to complete any specific setup configurations to complete this walkthrough.

Launching MMC

$MULE_HOME` is the directory where your Mule installation resides, for example /opt/mule-3.4.1.

  1. From the command line, run the mule executable file located in the $MULE_HOME/bin directory. To run the mule executable:

    • Windows: Open a command window, then navigate to the $MULE_HOME\bin directory. Type mule from within the \bin directory. Alternatively, you can execute mule.bat to start Mule.

    • Unix: Open a terminal window, then navigate to the $MULE_HOME/bin directory. Type ./mule to start Mule, or ./mule start to launch Mule in the terminal background.

  2. Mule starts and launches MMC automatically. Once Mule is up and kicking, use a browser to navigate to the following URL: http://localhost:8585/mmc

  3. Log in to MMC using the following credentials:

    1. Username: admin

    2. Password: admin

  4. Since you are using the bundled trial distribution, the server is automatically registered with the console. The console Dashboard "Quick Start" panel, which displays when you first login, indicates that there are no servers to register. Close the Quick Start panel by clicking the X in the upper right corner.

    MMC-quickstartpanel-annotated

Registering the Server

Before you use MMC to deploy Mule applications to a server, you must first identify the server to MMC. This action is called registering the server.

The first time you run the trial version of MMC, the console automatically registers the local server, so you do not need to follow the steps below; skip ahead to the Deploying an Application.

However, if you run the trial version more than once, you may wish to register a different server. The simplest way to register a server is with the console’s auto-discovery feature. The console automatically senses that a Mule server is running and captures much of the information needed for registration, thus making it easy to register any "discovered" servers.

  1. Click the Servers tab, then click Unregistered in the left navigation pane.

  2. The console lists all servers that have come online and are not yet registered. Select the Mule-3.4 server, then click the Register button.

    mmc-register_servers

  3. Click All in the left navigation pane to view the server you registered.

    mmc-server_registered

Alternatively, you can manually register a server. To do so,

  1. Click the Servers tab, then the Add button, then select New Server.

    MMC-addserver

  2. In the screen that opens, enter a Server Name and a Mule Agent URL for the server, then click Add.
    image::mmc-addserver-name.png[MMC-addserver-name]

Deploying an Application

Having identified a server to the console, you can now deploy applications to it. To do so, you first create an application group, known as a "deployment," which bundles applications so you can deploy the group to one or more servers. Then, within the deployment, you deploy an application. This walkthrough describes how to deploy the Hello application included as an example application in the example folder in the Mule ESB download.

  1. Click the Deployments tab in the console.

  2. Click New to create a new deployment.

  3. Enter a unique Deployment Name, such as HelloWorld.

  4. Click the Upload New Application button.

  5. In the dialog that appears, use the Browse button to navigate to the following filepath: $MULE_HOME/examples/hello/mule-example-hello-3.4.1.zip.

  6. Click Add. The console uploads the application within the deployment (see below).

    uploaded

  7. To identify the server to which to deploy the HelloWorld deployment, use the drop-down list under the Servers heading to select the server that the console registered for you upon launch.

    mmc-uploaded_server

  8. Click Deploy to deploy the HelloWorld deployment (containing the Hello application) to the server.

    all_deployments

    When you deploy the application, the console automatically saves the Hello application to the server repository. If you wish, you can click Save instead of Deploy to simply save the applications to the server repository for later deployment. Click Repository in the left navigation panel to view all applications saved in the repository. (Note that in the repository of the trial version, MMC contains all example applications that come bundled with the download package.)
    mmc repositoryexamples

Using the Deployed Application

To confirm that the Hello application is up and running, enter the following URL in your browser:

http://localhost:8888/?name=Ross

The application returns a response, confirming that the application has indeed been deployed.

hello_world

Viewing Flow Details

After using the application to return a "hello" response, you can access the console window to view details about how the request was processed.

  1. In the console, click the Flows tab. The screen displays only the flows within the Hello application. The table shows a summary of the number of events handled by the application (both processed and received events), along with the average and total event processing time per individual flow (see below).

    flows

  2. You can pause, stop, or start an individual flow, or flows. For example, use the checkboxes to select one or more flows, then click the Control Flows button, then select Stop to stop the flow from accepting any more events.

  3. Click a flow name to examine more detailed information about the flow. For example, click the HelloWorld flow name to open a screen with two tabs:

    • The Summary tab displays summary information about the flow such as the message sources and message processors it contains, its status (started, stopped, paused), and details about the events it has received and events it has processed.

      image::flow-summary.png[flow_summary]

    • The Endpoints tab displays a table of all endpoints for the flow and data about each endpoint, including the endpoint type, its address, connector information, whether or not it is filtered, if it is synchronous or asynchronous, and whether it handles transactions. Click one or more endpoints and, using the Control Endpoints button, start or stop those endpoints.

      image::flow-endpoints.png[]

Undeploying the Application

  1. Click the Deployments tab.

  2. Check the box next to the HelloWorld deployment.

  3. Click Undeploy. The console stops all applications in the selected deployment. In this example, you only had one application (Hello) in the deployment.

    mmc undeploy

  4. To stop Mule itself, hit Ctrl+C in the terminal where you launched Mule. If you launched Mule in the terminal background, issue the command $MULE_HOME/bin/mule stop.

See Also