Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

EPP/Obsolete/Logging

< EPP
Revision as of 11:53, 14 March 2016 by Marcel.bruch.gmail.com (Talk | contribs) (Pre v1.100)

Mission

The Logging project is component of the Eclipse Packaging Project (EPP). At the moment it contains the Automated Error Reporting client.

Links

Contact

To get in touch with the committers, post your questions to the EPP forum. Preferably you prefix your post's subject with [aeri] your subject title for questions about the automated error reporting.

To start a private conversation contact Marcel Bruch (marcel.bruch@codetrails.com).

Update Sites

The update sites are at the moment hosted here:

No promises that these urls will be stable for all times yet.

Contributing

EPP Logging maintains an Oomph profile that provisions a complete workspace with code formatter settings etc. Simply start the Oomph installer, switch to advanced mode, select the EPP -> Logging profile and click install.

Disabling AERI in builds and runtime Eclipse

The automated error reporting disables itself if it cannot detect a system property called eclipse.buildId. This is usually the case if you execute a test suite with Maven Tycho. If you want the automated error reporting to stay enabled, set the system property to ‑Declipse.buildId=some-id in your Eclipse launch configuration.

In the case you run your test suite in a 'normal' eclipse installation which already has the buildId, you can disable error reporting completely by setting the system property ‑Dorg.eclipse.epp.logging.aeri.ui.skipReports=true.

Note: In Aeri v2 the property name changed to org.eclipse.epp.logging.aeri.core.skipReports.

Enable additional debug output

AERI can write additional debug information to the error log, e.g.,:

  • Network exceptions on startup.
  • Explanation why an error log event was ignored.

To enable the debug output,

  • Open ${eclipse.working.dir}/.options and insert the line:
    org.eclipse.epp.logging.aeri.ui/debug=true
    • On Mac it's .../Eclipse.app/MacOs/.options - next to the eclipse executable.
  • In your eclipse.ini add the following line before the -vmargs section:
    -debug
  • Restart Eclipse.

Visit this page for details on how to use Platform debug tracing facility.


FAQ

Can I collect errors for my own Eclipse plug-ins?

Yes, you can. AERI offers and Eclipse extension point where projects can register their own servers/endpoints via plugin.xml. This feature is under development and will be released in v2.0.0. Early access candidates can be installed from the milestones update site.

Can I use error reporting in my own Eclipse RCP applications?

Yes, you can. AERI builds on the Eclipse DI mechanisms. The SystemControl.class (since 1.100.0) declares the system-wide IEclipseContext used for creating dialogs, notifications and others sub-services. When building your own RCP applications on Eclipse 4 you can integrate and customize any concern of AERI as needed. This feature will be released in v2.0.0. Early access candidates can be installed from the milestones update site.

Where to move old or invalid bugs created by AERI?

You can move those bugs into Z_Archived/AERI.

I track my problems in Bugzilla. Why doesn't allow AERI to edit the problem status and severity anymore?

As soon as you track problems in Bugzilla, the bug controls the lifecycle of a problem. AERI synchronizes the bug's state every 6 hours.

How can I include AERI in my own products?

Since v1.100

AERI provides an extension point that allows you to contribute your own error reporting server to the Eclipse IDE. See this example plugin.xml how to do that.

To use AERI in your own Eclipse product check out this example project on how to implement a reporting client that silently sends error reports to your in-house server.


v1.0.x

Reusing it "as-is" in custom products is possible but keep in mind it was built to serve the need of the Eclipse IDE. It may not be as extensible and configurable as you like.

To integrate the error reporter "as-is" into your product, add the feature org.eclipse.epp.logging.aeri.feature to your product. To send error reports to your own endpoint you have to specify the end-point url in your RCP client by setting thesystem property org.eclipse.epp.logging.aeri.ui.serverUrl in your product’s eclipse.ini (e.g. -Dorg.eclipse.epp.logging.aeri.ui.serverUrl=http://localhost/aeri/discovery.

At the end-point url, you need a server that sends the service configuration back to the client. See this url for the eclipse.org configuration. The configuration contains various settings and urls like aboutUrl, submitUrl, problemsUrl etc. These values need to point to your urls where you accept user requests.

To integrate a customized error reporting into your product, you have to integrate org.eclipse.epp.logging.aeri.ui into your product and specify an early startup hook that configures the system to suite your needs. Look at this startup hook for the Eclipse IDE setup. All powers, all responsibilities, but no documentation...

Is the server-side available too?

No it's not. If you are looking for professional support please contact info@codetrails.com.

Back to the top