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

Difference between revisions of "EPP/Obsolete/Logging"

< EPP
(FAQ)
m (Jonah.kichwacoders.com moved page EPP/Logging to EPP/Obsolete/Logging: Obsolete)
 
(31 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Mission ==
+
{{warning|Note: The contents of this page is obsolete, but it may still contain some interesting tid-bits.}}
The Logging project is component of the Eclipse Packaging Project (EPP). At the moment it contains the Automated Error Reporting client.
+
  
== Links ==
+
[[Category:EPP:Obsolete]]
  
* [https://dev.eclipse.org/recommenders/community/confess/#/guide General guide to AERI (slightly outdated)]
+
== Sign Up ==
* [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=short_desc%2Cvotes&component=logging&f1=status_whiteboard&list_id=11915260&o1=allwordssubstr&product=EPP&query_format=advanced&v1=votes Open feature requests for AERI]
+
* [https://www.eclipse.org/forums/index.php/f/69/ Annoucements in the EPP Forum]
+
  
== Contact ==
+
=== Eclipse.org Projects ===
 +
Every Eclipse project can sign up to receive error reports. To do so, file a request in [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EPP AERI's Bugzilla component].
  
To get in touch with the committers, post your questions to the [https://www.eclipse.org/forums/index.php/f/69/ EPP forum]. Preferably you prefix your post's subject with '''[aeri] your subject title''' for questions about the automated error reporting.  
+
=== Non-Eclipse.org Projects ===
 +
Non-Eclipse.org projects can signup using the free error reporting service hosted by Codetrails. Check out [https://www.codetrails.com/error-analytics/?utm_campaign=error-analytics&utm_source=eclipse-web&utm_medium=epp-wiki] for details.
  
To start a private conversation contact Marcel Bruch (marcel.bruch@codetrails.com).
+
== Documentation ==
 +
Check out the [https://www.codetrails.com/error-analytics/manual/?utm_campaign=error-analytics-manual&utm_source=eclipse-web&utm_medium=epp-wiki Codetrails Error Analytics manual].
  
== Update Sites ==
+
=== Disabling AERI in builds and runtime Eclipse ===
  
The update sites are at the moment hosted here:
+
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.
* http://download.eclipse.org/technology/epp/logging/stable/
+
* http://download.eclipse.org/technology/epp/logging/milestones/
+
* http://download.eclipse.org/technology/epp/logging/head/
+
  
No promises that these urls will be stable for all times yet.
+
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.skipReports=true'''.
 
+
== 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 1.x the property name was '''org.eclipse.epp.logging.aeri.ui.skipReports'''.
  
== Enable additional debug output ==
+
=== Enable additional debug output ===
 
AERI can write additional debug information to the error log, e.g.,:
 
AERI can write additional debug information to the error log, e.g.,:
 
* Network exceptions on startup.
 
* Network exceptions on startup.
Line 39: Line 28:
  
 
To enable the debug output,  
 
To enable the debug output,  
* Open ${eclipse.working.dir}/.options and insert the line:<pre>org.eclipse.epp.logging.aeri.ui/debug=true</pre>
+
* Open ${eclipse.working.dir}/.options and insert the line:<pre>org.eclipse.epp.logging.aeri.core/debug=true</pre>
 
** On Mac it's .../Eclipse.app/MacOs/.options - next to the <tt>eclipse</tt> executable.
 
** On Mac it's .../Eclipse.app/MacOs/.options - next to the <tt>eclipse</tt> executable.
 
* In your eclipse.ini add the following line before the -vmargs section: <pre>-debug</pre>
 
* In your eclipse.ini add the following line before the -vmargs section: <pre>-debug</pre>
Line 45: Line 34:
  
 
Visit [https://wiki.eclipse.org/FAQ_How_do_I_use_the_platform_debug_tracing_facility#Turning_on_debug_tracing this page] for details on how to use Platform debug tracing facility.
 
Visit [https://wiki.eclipse.org/FAQ_How_do_I_use_the_platform_debug_tracing_facility#Turning_on_debug_tracing this page] for details on how to use Platform debug tracing facility.
 
  
 
== FAQ ==
 
== FAQ ==
  
=== Where to move old or invalid bugs created by AERI? ===
+
=== How can I collect error reports for my own Eclipse plug-ins? ===
You can move those bugs into Z_Archived/AERI.
+
AERI 2.x offers an Eclipse extension point where projects can register their own servers/endpoints via plugin.xml. See [https://codetrails.com/error-analytics/manual/?utm_campaign=error-analytics-manual&utm_source=eclipse-web&utm_medium=epp-wiki] for details.
  
=== I track my problems in Bugzilla. Why doesn't allow AERI to edit the problem status and severity anymore? ===
+
=== Can I send error reports for my own Eclipse RCP applications? ===
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.
+
Yes. Watch [https://www.youtube.com/watch?v=TDSv9Tm7hGA this webinar] for details and check out the examples in the git repository.
  
== How can I include AERI in my own products? ==
+
== Contact ==
  
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 get in touch, post your questions to the [https://www.eclipse.org/forums/index.php/f/69/ EPP forum]. Preferably you prefix your post's subject with '''[aeri] your subject title''' for questions about the automated error reporting.
  
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 the'''system 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.
+
If you use Mattermost, check out the [https://mattermost-test.eclipse.org/eclipse/channels/epp-aeri Mattermost EPP AERI channel].
  
At the end-point url, you need a server that sends the service configuration back to the client. See [https://dev.eclipse.org/recommenders/community/confess/v2/discovery 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 [http://git.eclipse.org/c/epp/org.eclipse.epp.logging.git/tree/bundles/org.eclipse.epp.logging.aeri.ide/src/org/eclipse/epp/internal/logging/aeri/ide/Startup.java this startup hook] for the Eclipse IDE setup. All powers, all responsibilities, but no documentation...
 
  
If you are looking for professional support, contact info@codetrails.com
+
== Update Sites ==
  
 +
The update sites are at the moment hosted here:
 +
* http://download.eclipse.org/technology/epp/logging/stable/
 +
* http://download.eclipse.org/technology/epp/logging/milestones/
 +
* http://download.eclipse.org/technology/epp/logging/head/
 +
 +
URLs may change without further notice. If you need stable URLs, use the annual release train update sites.
 +
 +
== 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.
 
[[Category:EPP]]
 
[[Category:EPP]]

Latest revision as of 21:35, 6 May 2021

Warning2.png
Note: The contents of this page is obsolete, but it may still contain some interesting tid-bits.

Sign Up

Eclipse.org Projects

Every Eclipse project can sign up to receive error reports. To do so, file a request in AERI's Bugzilla component.

Non-Eclipse.org Projects

Non-Eclipse.org projects can signup using the free error reporting service hosted by Codetrails. Check out [1] for details.

Documentation

Check out the Codetrails Error Analytics manual.

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.skipReports=true.

Note: In Aeri 1.x the property name was org.eclipse.epp.logging.aeri.ui.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.core/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

How can I collect error reports for my own Eclipse plug-ins?

AERI 2.x offers an Eclipse extension point where projects can register their own servers/endpoints via plugin.xml. See [2] for details.

Can I send error reports for my own Eclipse RCP applications?

Yes. Watch this webinar for details and check out the examples in the git repository.

Contact

To get in touch, 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.

If you use Mattermost, check out the Mattermost EPP AERI channel.


Update Sites

The update sites are at the moment hosted here:

URLs may change without further notice. If you need stable URLs, use the annual release train update sites.

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.

Back to the top