Changing objects in flight, without a Debugger

How to change data in-flight, without a Debugger

Do you ever wish you could change the behavior of some object in the middle of a bunch of method calls?  I sometimes do.

Maybe you want to set some properties on an object to replicate a fault.  Maybe you’d like to force a specific return value from a method for some reason.  These are both very possible, without altering the source code for your application.

I like to do this through Byteman.  Byteman is a JBoss project that deals with bytecode injection.  This means that you can inject code you want to run, specifying where you want to run it.  It’s sort of like AOP, except I think it allows more freedom for the user.  It’s also pretty easy to use.

Here’s how:

1)  Make a helper class to do the work you want done
2)  Put the helper class in a .jar
3)  Write the Byteman rule that tells the helper class to do it’s thing

That’s it!  So here’s the example.

Part 1, the helper class
**********************************

public void addMarker(Message msg){
System.out.println(“Changing Message contents.”);
Body msgBody = msg.getBody();
msgBody.add(“Hey, I’ve got changed content”);
System.out.println(“Done changing Message contents”);
}
***********************************

As you can see, there is nothing fancy at all about that class.  It’s just a plain old Java class.  It has a method that expects to be passed an object, and it has code that will alter properties on that object.  Absolutely nothing out of the ordinary.

Part 2, put that class in a .jar
************************************
You can use your favorite IDE for this if you want.  I like to just use Java’s ‘jar’ utility.  To use it, you just place your command line interface in the ‘root’ directory for the compiled class (in this case, one level above ‘com’ of com/byteman/helper) and do something like ‘jar cvf HelperJar.jar *

Part 3, write your rule
************************************
Put your Helper.jar in $BYTEMAN/bin.  I like to put my scripts here, too.  So add something like this in a file you might call ‘MyRule1.btm’:
RULE Alter Message
CLASS org.jboss.soa.esb.actions.SystemPrintln
METHOD process
HELPER com.byteman.helper.MsgHelper
BIND msg = ;
AT ENTRY
IF TRUE
DO addMarker(msg);
ENDRULE

That rule is pretty simple– it’s just telling Byteman to run the method ‘addMarker’, passing it the first argument (‘msg’) that was passed to SystemPrintln’s ‘process’ method.  There is some good documentation on the Byteman site to help you learn more things you can do with the scripting.

Finally, you attach Byteman to your running SOA-P server and install the rule.  I like to do that by finding SOA-P’s Process Id (pid) through ‘ps -ef |grep jboss’.
Once I have the pid, from $BYTEMAN/bin I run ‘bminstall.sh $PID’ and then submit the rule with ‘bmsubmit.sh $MYRULEFILE’, in this case MyRule1.btm.

That’s all there is to it!  You are then using Byteman, which lets you set hooks and alter data on the fly, without altering anybody else’s sourcecode.  You put whatever you want done in your helper method.

Have fun!


Join Red Hat Developers, a developer program for you to learn, share, and code faster – and get access to Red Hat software for your development.  The developer program and software are both free!

 

  1. Thanks for this ! Any thoughts on if it is flexible enough to solve this problem 🙂 http://stackoverflow.com/questions/18279397/using-aspects-to-inject-invocationhandlers-without-proxy-class Im still looking for a good way to proxy all methods in my class without providing a custom factory :

    Automobile a = AFactoryIDontcontol.newInstanceOf(Automobile.class) ;
    //now , above, say i want to debug every call to every method in my Automobile class instance like so:

    log.info(“drive(..) called”); // <– inject this into the first line of the "drive()" methods first line.

    So what I'd like to do is define a class which proxies all class to "Automobile" with the modification that each call to a method results in a log.info statement being called first. I think Aspect4J can do this but im not sure how… Just wondering if BYTEMAN can do it .

    Like

  2. Hi, thanks for reading.
    I think you’ll be happiest with AspectJ in this case. It has a nice way of allowing you to say ‘any method for this class’, where Byteman does not. (Byteman has an open request to allow wildcard matching, but as yet it’s not fulfilled.)
    So I’d probably steer toward AspectJ for this one. BTW, I highly recommend ‘AspectJ in Action’ if you’re going to work with AspectJ– it’s a great book!

    Regards,

    Rick

    Like

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s