This documentation is for WSO2 Business Activity Monitor 2.4.1. View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

When a WSO2 product server starts, it starts all features and related artifacts bundled in the product. Multi-profile support allows you to run the product on a selected profile so that only features specific to that profile along with the common features start up with the server. This enables better resource utilization.

To run the product on a preferred profile:
  1. Download the product distribution. See Downloading the Product.
  2. Open a command prompt:
    • On Windows, choose Start > Run, type cmd at the prompt, and press Enter.
    • On Linux/Solaris, establish a SSH connection to the server or log into the Linux console.
  3. Execute one of the following commands to start a product on a preferred profile, where <PRODUCT_HOME> is the directory where you installed the product distribution and . For more information on <preferred-profile>, see BAM profiles.

    On Windows
    <PRODUCT_HOME>\bin\wso2server.bat -Dprofile=<preferred-profile> --run
    On Linux/Solaris

    sh <PRODUCT _HOME>/bin/ -Dprofile=<preferred-profile> 

    For example, in Linux/Solaris, to start BAM Cassandra node only, type the following command: sh <PRODUCT_HOME>/bin/ -Dprofile=cassandra

    To stop running Cassandra that is bundled with BAM by default, run the following command (on Linux) when starting the server: sh -Ddisable.cassandra.server.startup=true. In this case, you are recommended to point to an external Cassandra cluster.

  4. Once the server has started, run the Management Console by opening a Web browser and typing in the management console's URL. The URL is displayed as the last line in the start script's console and log. The URL should be in the following format: https://<Server Host>:9443/carbon

BAM profiles

The following are the list of profiles that corresponds to the respective services/applications:

Service/Application NameProfile Name
Loads Cassandra components such as Cassandra server, explorer UI and key space list UI etc.

How multi-profiling works

Starting a product on a preferred profile starts only a subset of features bundled in the product. In order to identify what feature bundles apply to what profile, each product maintains a set of files in the  <PRODUCT_HOME>/repository/components/<profile-name>/configuration/org.eclipse.equinox.simpleconfigurator directories. The files contain references to the actual bundles. Note that <profile-name> in the directory path refers to the name of the profile. For example, when there is a product profile named webapp, references to all the feature bundles required for the webapp profile to function are in a file saved in <PRODUCT_HOME>/repository/components/webapp/configuration/org.eclipse.equinox.simpleconfigurator directory.

Note that when you start the server without using a preferred profile, the server refers to the  <PRODUCT_HOME>/repository/components/default/configuration/org.eclipse.equinox.simpleconfigurator/ file by default. This file contains references to all bundles in the <PRODUCT_HOME>/repository/components/plugins directory, which is where all the components/bundles of a product are saved.

Disabling selected BAM components

You can disable selected BAM components when starting the server. Note that this method is a workaround to using an actual server profile. We plan to provide this facility through server profiles in a future release. In the meantime, you can use this workaround.

Command (on Linux)Description
sh <PRODUCT_HOME>/bin/
Used to disable the analytics-related components. If you run this command to start BAM on a particular node, the node does not join the task execution. You use this property to start a node that works as a receiver.
sh <PRODUCT_HOME>/bin/ -Ddisable.receiver=trueUsed to disable the receiver-related components. If you run this command, the thrift server does not start and you do not need to open 7611+<BAM_PORT_OFFSET> and 7711+<BAM_PORT_OFFSET> ports. You use this property to start a node that works as an analyzer.
sh <PRODUCT_HOME>/bin/ -Ddisable.receiver=trueUsed to disable both components described above.
  • No labels