Trace Components

Identifier:

org.eclipse.ui.trace.traceComponents

Since:

1.0

Description:

This extension point allows plug-ins to contribute debug trace options to the Tracing preference page (Preferences > General > Tracing). All of the option-paths from a set of plug-in .options files will be editable from the preference page. As the options will be dynamically enabled or disabled via the OSGi DebugOptions service, the specified plug-ins' tracing must listen for changes (see org.eclipse.osgi.service.debug.DebugOptions).

Configuration Markup:

<!ELEMENT extension (component+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT component (bundle*)>

<!ATTLIST component

id CDATA #REQUIRED

label CDATA #IMPLIED>

A tracing component

id - unqiue identifier for this component
label - A human readable label for the component which will be displayed in the tracing dialog. If no label is provided then the label "Missing Label" will be displayed.

<!ELEMENT bundle EMPTY>

<!ATTLIST bundle

name CDATA #IMPLIED

consumed (true | false) >

An Eclipse bundle.

name - The symbolic name of a specific bundle or a regular expression defining the name of a set of bundles.
consumed - Describes if the bundle (or bundles) is consumed by this component. A consumed bundle is one that will not show up in any other tracing component except for this component.

Examples:

The following is an example for the extension point where a component called 'Equinox Framework' includes all of the option-paths from the .options file in the org.eclipse.osgi bundle. As well, a second component called 'JDT Core' includes all of the option-paths from the .options files found in any bundle matching org.eclipse.jdt.*core*. The tracing preference page would display these two categories in the tree with all known option-paths as children.


   <extension
         point="org.eclipse.ui.trace.traceComponent">
      <component
            id="org.eclipse.ui.trace.osgitrace"
            label="Equinox Framework">
         <bundle
               name="org.eclipse.osgi">
         </bundle>
      </component>
   </extension>
   <extension
         point="org.eclipse.ui.trace.traceComponent">
      <component
            id="org.eclipse.ui.trace.jdtcoretrace"
            label="JDT Core">
         <bundle
               name="org.eclipse.jdt.*core*">
         </bundle>
      </component>
   </extension>

Copyright (c) 2011, 2014 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0