Skip to content
Treblle

MuleSoft App for Auto Discovery

treblle-autodiscovery

The official Treblle MuleSoft App for automatic API discovery and registration with Treblle platform.

This app is an extension of the MuleSoft integration enabled by the policy.

It ensures Treblle can discover all inactive/stale APIs and correctly capture API names inside Treblle for complete visibility and gives you the best Treblle experience.

Using the MuleSoft policy and this app together ensures you get 100% API visibility and a full Treblle experience across your MuleSoft environment.

Prerequisites

Before you begin, make sure you have:

Step 1: Clone Treblle Auto-Discovery Repository

  1. Clone the Treblle repository:

    Terminal window
    git clone https://github.com/Treblle/treblle-mulesoft-autodiscovery.git

  2. Open the cloned repository in your development environment

Step 2: Obtain the JAR File

You have two options to get the required JAR file:

Option A: Build the Project

  1. Save your changes
  2. Run the following command in your MuleSoft project directory:
    Terminal window
    mvn clean install
  3. Navigate to your .m2 folder and find the JAR file: 
    treblle-register-apis-1.0.0-SNAPSHOT-mule-application.jar

Option B: Use Pre-built JAR from Repository

Alternatively, you can use the pre-built JAR file directly from the repository without building it yourself.

Step 3: Create Connected App

  1. Go to Anypoint Platform Connected Apps
  2. Navigate to Access Management > Connected Apps
  1. Create a new app with the required information and scopes:
  1. Copy the Client ID and Client Secret - these will be needed for deployment:

Step 4: Deploy to Runtime Manager

  1. Go to Runtime Manager and click Deploy Application
  1. Provide a name for the application and upload the JAR file: treblle-register-apis-1.0.0-SNAPSHOT-mule-application.jar

Step 5: Configure Application Properties

Go to the Properties section and add the following:

  • CLIENT_ID: Your Connected App Client ID
  • CLIENT_SECRET: Your Connected App Client Secret
  • API_KEY: Enter your Treblle API key
  • SDK_TOKEN: Enter your Treblle SDK token
  • OrganizationId: Your MuleSoft Business Group ID

Click Deploy Application.

Step 6: Monitor Deployment

  1. Once the app is deployed, click on it:
  1. Click on Logs to view all application logs:

For Multiple Business Groups

If you need to monitor APIs across different business groups, follow these additional steps:

Step 1: Build and Deploy the Treblle Policy on the business group that you want to add.

Step 2: Apply policy to the APIs.

(Refer to the MuleSoft policy documentation for detailed steps on how to apply policies to APIs)

Step 3: Update Connected App Scopes: Click the checkbox for different business groups to expand the scope permissions.

Step 4: Add Scopes for Other Business Groups: Ensure you add the same scopes for each business group you want to monitor.

Step 5: Configure Business Group IDs: In the connected app properties, add multiple business group IDs separated by commas (,).

Example: businessGroupIDs: group1-id,group2-id,group3-id

The logs will show different organization IDs when monitoring multiple business groups.

How It Works

The Treblle MuleSoft Auto-Discovery app automatically:

  1. Discovers APIs in your MuleSoft environment
  2. Registers them with the Treblle platform
  3. Monitors changes and updates API information
  4. Provides visibility into your API landscape

This enables smooth integration between your MuleSoft APIs and Treblle’s observability.