This post will explain how to publish WSO2 G-Reg generated events to WSO2 BAM server. In other words, this is a custom data publisher for G-Reg/BAM.
Pre-requisites
- Install WSO2 Business Activity Monitor (BAM 2.0.0)
- Install WSO2 Governance Registry(G-Reg 4.5.3)
What needs to done:
a) Configure WSO2 BAM to accept events generated from WSO2 G-Reg
b) Publish events generated from G-Reg to the BAM event listeners.
How to:
- To achieve (a), we need to install a relevant Toolbox to BAM.
(A BAM Toolbox is an installable archive which contains stream definitions, dashboard components and analytics for WSO2 Business Activity Monitor. KPI_Registry_Activity.tbox is a such pre-built BAM Toolbox based on the KPI Monitoring sample of WSO2 BAM. Further you can read the KPI Monitoring sample of WSO2 BAM to learn how to make changes to this BAM Toolbox or create your own.)
- To achieve (b), in WSO2 Carbon Kernel, we are given an extension point to collect stats from a running carbon server. To accomplish this, we need to write a class that extends StatisticsCollector interface and override the collect method such that it will publish the collected event to WSO2 BAM.
I hope now you got a brief understanding of how to achieve this goal. So lets figure out what needs to be done to achieve (a) and (b) in detail.
a) Configure WSO2 BAM to accept events generated from WSO2 G-Reg
- Download the KPI_Registry_Activity.tbox .
- Start WSO2 BAM server and login as admin (username - admin password -admin).
- In BAM management console go to BAM Toolbox > Custom Toolbox select the downloaded toolbox from the file system and click Install.
Now you have the tool box installed which awaits and listens to the events coming through its tcp event listener port.
b) To add a stat collector which publish the collected stats to WSO2 BAM, we need to write a custom OSGi bundle which register the statistic collector service at bundle startup.
To write a new OSGi bundle we can reuse the greg handler sample code. Find the handler sample in
GREG_HOME/samples/handler.
There add a new class called RegistryStatCollectorServiceComponent under the package org.wso2.carbon.registry.samples.statistics.
In the sample pom file, you need to do the following changes to make the code work.
Add following dependencies to the pom.
org.wso2.carbon org.wso2.carbon.databridge.agent.thrift 4.0.1 org.wso2.carbon org.wso2.carbon.databridge.commons 4.0.0
Add the following plugin.
org.apache.felix maven-scr-plugin
Commet-out the following exclusions in the pom file.
Now edit the previously created RegistryStatCollectorServiceComponent class as follows.
package org.wso2.carbon.registry.samples.statistics;
import org.osgi.framework.ServiceRegistration;
import org.osgi.service.component.ComponentContext;
import org.wso2.carbon.context.CarbonContext;
import org.wso2.carbon.databridge.agent.thrift.Agent;
import org.wso2.carbon.databridge.agent.thrift.DataPublisher;
import org.wso2.carbon.databridge.agent.thrift.conf.AgentConfiguration;
import org.wso2.carbon.databridge.commons.Event;
import org.wso2.carbon.databridge.commons.exception.NoStreamDefinitionExistException;
import org.wso2.carbon.registry.core.service.RegistryService;
import org.wso2.carbon.registry.core.statistics.StatisticsCollector;
import org.wso2.carbon.registry.core.utils.RegistryUtils;
import org.wso2.carbon.utils.NetworkUtils;
/**
* @scr.component name="org.wso2.carbon.registry.samples.statistics" immediate="true"
* @scr.reference name="registry.service" interface="org.wso2.carbon.registry.core.service.RegistryService"
* cardinality="1..1" policy="dynamic" bind="setRegistryService" unbind="unsetRegistryService"
*/
public class RegistryStatCollectorServiceComponent {
public static final String REGISTRY_ACTIVITY_STREAM = "org.wso2.bam.registry.activity.kpi";
public static final String VERSION = "1.0.0";
private ServiceRegistration serviceRegistration;
protected void activate(ComponentContext context) {
serviceRegistration = context.getBundleContext().registerService(
StatisticsCollector.class.getName(), new StatisticsCollector() {
public void collect(Object... objects) {
try {
// Create Data Publisher
RegistryUtils.setTrustStoreSystemProperties();
DataPublisher dataPublisher = new DataPublisher(
"tcp://" + NetworkUtils.getLocalHostname() + ":7612", "admin", "admin",
new Agent(new AgentConfiguration()));
// Find Data Stream
String streamId;
try {
streamId = dataPublisher.findStream(REGISTRY_ACTIVITY_STREAM, VERSION);
} catch (NoStreamDefinitionExistException ignored) {
streamId = dataPublisher.defineStream("{" +
" 'name':'" + REGISTRY_ACTIVITY_STREAM + "'," +
" 'version':'" + VERSION + "'," +
" 'nickName': 'Registry_Activity'," +
" 'description': 'Registry Activities'," +
" 'metaData':[" +
" {'name':'clientType','type':'STRING'}" +
" ]," +
" 'payloadData':[" +
" {'name':'operation','type':'STRING'}," +
" {'name':'user','type':'STRING'}" +
" ]" +
"}");
}
if (!streamId.isEmpty()) {
// Publish Event to Stream
dataPublisher.publish(new Event(
streamId, System.currentTimeMillis(),
new Object[]{"external"}, null, new Object[]{
Thread.currentThread().getStackTrace()[3].getMethodName(),
CarbonContext.getCurrentContext().getUsername()}));
dataPublisher.stop();
System.out.println("Successfully Published Event");
}
} catch (Exception e) {
e.printStackTrace();
}
}
}, null);
}
protected void deactivate(ComponentContext context) {
serviceRegistration.unregister();
}
protected void setRegistryService(RegistryService registryService) {
// The Maven SCR Plugin Needs These
}
protected void unsetRegistryService(RegistryService registryService) {
// The Maven SCR Plugin Needs These
}
}
- Now go to REG_HOME/ samples/handler/src and do a maven clean install to build the project. Once done inside the target folder of the sample, you can find the updated jar file.
- Copy the jar org.wso2.carbon.registry.samples.handler-4.5.3.jar in to REG_HOME/repository/components/dropins folder.
- Go to REG_HOME/repository/conf/carbon.xml and change the offset value to 1 as follows.
- Now start the server and do registry operations such as adding WSDLs/Services /Resources and etc (these actions will create events from WSO2 G-Reg side and publish them to WSO2 BAM) and check the WSO2 BAM Gadget Portal and you will find the operations you did published as events on WSO2 BAM dashboard.
For more info:visit WSO2 G-Reg wiki docs - http://docs.wso2.org/wiki/display/Governance453/WSO2+Governance+Registry+Documentation
Subash,
ReplyDeleteI am new to WSO2 toolset. We are currently using ESB, G-REG 4.2.1 I am looking into a solution for Service Versioning. I believe I could support this with the G-REG. I believe we configure everything via XML files. We currently have directories such as tasks, wsdl, resources, schemas, templates, etc in our registry folder. We do not have services. These reside in our ESB folders. We want to be able to have different service versions for different consumers. I am thinking I could have registry entries for the various services in the registry and then have local-entities or some other table of consumers tied to specific services. Would you recommend this approach? or can you offer a better approach? And where can I find documentation specific to this? I have not seen anything relevant in the G-REG documentation on the WSO2 website.
Thanks in advance,
Dennis