XRebel Hub logo

Quick Start

Account Signing up

  1. Sign up over at XRebel Hub.
  2. Open the account creation link in the email.
  3. Complete the signup at hub.xrebel.com.
  4. Next → Project

Project Creating a new project

  1. You will be asked to create your first Project immediately following signup.
  2. Specify a project title and press Create.
  3. Next → Agents

Good to know

You can create additional projects by clicking your project title in the top left corner. Simply type the name for the new project and click Create.

Agents Configuring XRebel Hub for your applications

  1. You will be prompted to download the XRebel Hub Agent as soon as you create a new project.
    The project’s agent file is tied to that project.
  2. Download and extract the archive to a location of your choice.
  3. Add the XRebel Hub Agent to you server startup parameters:
    -javaagent:[/path/to/]xrebel-hub-agent.jar
  4. Start your server!
  5. Next → Applications

Good to know

Microservices

In order to profile distributed applications or microservices, add agents to all connected applications.

Keep in mind that there are two methods to collect transactions:

  1. When the applications or services have the same name, the traces will be collected into one transaction using that name.
  2. When using different names, transactions are separately collected under each application.

Did this work?

A console banner is shown for a successful launch:
2016-03-03 15:59:14 XRebel Hub: ########################################################
2016-03-03 15:59:14 XRebel Hub: 
2016-03-03 15:59:14 XRebel Hub:  XRebel Hub Agent 1.4.1 (201602291430)
2016-03-03 15:59:14 XRebel Hub:  © Copyright ZeroTurnaround AS, Estonia, Tallinn.
2016-03-03 15:59:14 XRebel Hub: 
2016-03-03 15:59:14 XRebel Hub: ########################################################

Applications Adding multiple applications to a project

You can add multiple applications to a single project by downloading the project agent and adding a startup parameter to the application server.

  1. Add the startup parameter to the previously downloaded project agent to specify the application:
    -javaagent:[/path/to/]xrebel-hub-agent.jar -Dxrebel.hub.app.name=Application-01
  2. New application data is displayed following some app activity.
  3. Next → Dashboard

Good to know

The specified applications are displayed within the project for which the agent was originally downloaded.

Versions

Use one of these methods to add versions to your applications.

  1. Using Maven. Use your pom.xml to specify the application versions for XRebel Hub. Add a JAR or WAR build plugin to your configuration:
    <build>
      ...
        <plugins>
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-war-plugin</artifactId>
            <!--or <artifactId>maven-jar-plugin</artifactId>-->
            <configuration>
            <archive>
              <manifestEntries>
                <XRebel-Hub-App-Version>${project.version}</XRebel-Hub-App-Version>
              </manifestEntries>
            </archive>
      ...
    
  2. Using Gradle. Include the following in your build.gradle file.
    war { // or jar
        version = 'my-version-3.14'
        manifest {
            attributes("XRebel-Hub-App-Version": version)
        }
    }
  3. Using JVM arguments. Add the version parameter to your application startup:
    -javaagent:[/path/to/]xrebel-hub-agent.jar -Dxrebel.hub.app.version=314

For more information, please head over to the XRebel Hub reference manual.

Dashboard Using XRebel Hub

  1. Click around in your web application.
  2. Open the XRebel Hub dashboard.

Advanced profiling

XRebel Hub Agents can be configured to use a customized profiling setup. To do this:

  1. Download the customized configuration file.
  2. Edit the file to set up customized entry points. Detailed instructions are contained within.
  3. Save the file in the same location as the XRebel Hub Agent file.