Difference between revisions of "Tracing Options for Remote Services"

Latest revision as of 18:57, 25 June 2013

Introduction

ECF's implementation of OSGi Remote Services has number of tracing options to allow users to trace the discovery and/or distribution of a remote service.

There are two bundles that have tracing options:

org.eclipse.ecf.osgi.services.remoteserviceadmin (location in git repo)

and

org.eclipse.ecf.osgi.services.distribution (location in git repo)

In the project directories is a file '.options' that declares the Eclipse tracing options available for that bundle.

Options for org.eclipse.ecf.osgi.services.remoteserviceadmin

# Debugging options for the org.eclipse.ecf.osgi.services.remoteserviceadmin plug-in

# Turn on general debugging for the org.eclipse.ecf.osgi.services.remoteservicesadmin plug-in
org.eclipse.ecf.osgi.services.remoteserviceadmin/debug=true
org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/filter = *
org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/flag = true

# Trace when exceptions are caught
org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/exceptions/catching=true
# Trace when exceptions are thrown
org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/exceptions/throwing=true

org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/remoteserviceadmin=true

org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/topologymanager=true

org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/containerselector=true

org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/metadatafactory=true

org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/endpointdescriptionadvertiser=true

org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/endpointdescriptionlocator=true

org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/endpointdescriptionreader=true

org.eclipse.ecf.osgi.services.remoteserviceadmin/debug/packageversioncomparator=true

Options for org.eclipse.ecf.osgi.services.distribution

# Debugging options for the org.eclipse.ecf.osgi.services.distribution plug-in

# Turn on general debugging for the org.eclipse.ecf.osgi.services.distribution plug-in
org.eclipse.ecf.osgi.services.distribution/debug=true
org.eclipse.ecf.osgi.services.distribution/debug/filter = *
org.eclipse.ecf.osgi.services.distribution/debug/flag = true

# Trace when exceptions are caught
org.eclipse.ecf.osgi.services.distribution/debug/exceptions/catching=true
# Trace when exceptions are thrown
org.eclipse.ecf.osgi.services.distribution/debug/exceptions/throwing=true

# Trace when methods are entered
org.eclipse.ecf.osgi.services.distribution/debug/methods/entering=true
# Trace when methods are exited
org.eclipse.ecf.osgi.services.distribution/debug/methods/exiting=true

org.eclipse.ecf.osgi.services.distribution/debug/eventhook=true

org.eclipse.ecf.osgi.services.distribution/debug/discoveredservicetracker=true

org.eclipse.ecf.osgi.services.distribution/debug/containerfinder=true

Running with Tracing Options Turned On

Note that the binary versions of these bundles do not include the .options files that are in the repo, and so the easiest route to using/turning on tracing would be to:

1. Install eGit
2. Clone the ECF Repo (see bottom of here)
3. Import the org.eclipse.ecf.osgi.services.remoteserviceadmin</b> and org.eclipse.ecf.osgi.services.distribution projects into your workspace
4. Create a launch config
5. For the new launch config, select the 'Tracing' tab and check/enable tracing for these two ecf bundles. Note that if all tracing options enabled, a fairly large amount of output could be produced
6. Debug using the new launch config

Details on Using Eclipse Tracing

For more information on Eclipse Tracing...i.e. how it works and how to setup tracing options without getting source code, see FAQ How do I use the platform debug tracing facility?