Skip to main content

Notice: This Wiki is now read only and edits are no longer 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
(Add information about what data is submitted to servers)
m (Jonah.kichwacoders.com moved page EPP/Logging to EPP/Obsolete/Logging: Obsolete)
 
(10 intermediate revisions by 3 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.
+
  
 +
[[Category:EPP:Obsolete]]
  
== Sign Up Your Eclipse Project ==
+
== Sign Up ==
Every Eclipse project can sign up to receive error reports. If your project is yet not listed [https://dev.eclipse.org/recommenders/committers/aeri/v2/#!/projects/ here], create a new one [https://dev.eclipse.org/recommenders/committers/aeri/v2/#!/projects/new here]. Make sure you use a '''unique (3-letter) short label''' for your project.
+
  
Next, set up a email digest for your project to get informed about all active problems. It's a recommended best practice to set up a '''weekly digest''' sent to your project's <project>-dev@eclipse.org mailing list. Check out [https://dev.eclipse.org/recommenders/committers/aeri/v2/#!/projects/54bc3023bee886e008a60d18 EGit] or [https://dev.eclipse.org/recommenders/committers/aeri/v2/#!/projects/5537a8fce4b026254ee06203 buildship] setup as example.
+
=== 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].
  
If you have any questions, contact us at the EPP forum (see below).
+
=== 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.
  
 +
== 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].
  
== Links / Documentation ==
+
=== Disabling AERI in builds and runtime Eclipse ===
 
+
* [https://blog.ctrlflow.com/about-error-reports-problems-bugs-and-projects/ About Error Reports, Problems, Bugs, and Projects - An Introduction to the Automated Error Reporting Concepts]
+
* [https://blog.ctrlflow.com/common-problem-triaging-workflows/ Recommended Common Problem Triaging Workflow]
+
* [https://blog.ctrlflow.com/automatic-email-digests/ Setting Up Automatic Email Digests for Your Project]
+
* [https://blog.ctrlflow.com/automated-actions-for-managing-error-reports/ Setting Up Automated Actions]
+
* [https://blog.ctrlflow.com/bulk-editing-problems/ Using Bulk Editing Problems]
+
* [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 bug reports and feature requests for AERI]
+
* [https://www.eclipse.org/forums/index.php/f/69/ Annoucements in the EPP Forum]
+
 
+
== Contact ==
+
 
+
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.
+
 
+
If you use Mattermost, check out the [https://mattermost-test.eclipse.org/eclipse/channels/epp-aeri Mattermost EPP AERI channel].
+
 
+
== 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/
+
 
+
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.
 
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'''.
+
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 v2 the property name changed to '''org.eclipse.epp.logging.aeri.skipReports'''.
+
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 61: 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.
 
== Submitted Information ==
 
In order to provide committers with enough information to identify and fix problems, the following data is submitted to the Automated Error Reporting server when an error is encountered:
 
* Information about the reporter
 
** Anonymous ID
 
** Name (optional)
 
** EMail address (optional)
 
* Status information about the encountered error
 
** Exception stacktrace (can be anonymized automatically to avoid submitting sensitive data)
 
** Exception message (can be anonymized automatically to avoid submitting sensitive data)
 
** Nested exceptions if available
 
** Plugin ID of the plugin logging the error
 
** Plugin version of the plugin logging the error
 
** Plugin specific status code if available
 
** A fingerprint of the stacktrace used to identify duplicate reports
 
** Severity (always "ERROR")
 
* User supplied information
 
** Comment (optional)
 
** Estimate of problem severity (optional)
 
** Auxilliary information
 
*** Bundle wiring analysis (optional, only in case of NoClassDefFound or similar wiring errors)
 
*** Installed bundles (optional)
 
*** Installed features (optional)
 
*** System properties (optional)
 
*** User preferences (optional)
 
* Information about the environment the error occurred in
 
** Eclipse build ID
 
** Eclipse product ID
 
** OSGi bundles present in the stacktrace
 
** Java runtime version
 
** Operating system name
 
** Operating system version
 
** Operating system architecture (e.g. 64-bit)
 
** Windowing system
 
  
 
== FAQ ==
 
== FAQ ==
  
=== Can I collect errors for my own Eclipse plug-ins? ===
+
=== How can I collect error reports for my own Eclipse plug-ins? ===
Yes, you can. AERI 2.0 offers and Eclipse extension point where projects can register their own servers/endpoints via plugin.xml. See [https://www.youtube.com/watch?v=TDSv9Tm7hGA this webinar] for detailed step-by-step introduction.
+
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.
  
=== Can I use error reporting in my own Eclipse RCP applications? ===
+
=== Can I send error reports for my own Eclipse RCP applications? ===
Yes, you can. Watch [https://www.youtube.com/watch?v=TDSv9Tm7hGA this webinar] for details and check out the examples in the git repository.
+
Yes. Watch [https://www.youtube.com/watch?v=TDSv9Tm7hGA this webinar] for details and check out the examples in the git repository.
  
=== Are there any providers that host an error reporting server? ===
+
== Contact ==
Yes. Ctrlflow offers a SaaS service for free. Check https://ctrlflow.com/automated-error-reporting/ for details.
+
  
=== Where to move old or invalid bugs created by AERI? ===
+
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.
You can move those bugs into [https://bugs.eclipse.org/bugs/buglist.cgi?component=AERI&product=z_Archived Z_Archived/AERI].
+
  
=== I track my problems in Bugzilla. Why doesn't allow AERI to edit the problem status and severity anymore? ===
+
If you use Mattermost, check out the [https://mattermost-test.eclipse.org/eclipse/channels/epp-aeri Mattermost EPP AERI channel].
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? ===
 
  
AERI 2.0 provides an extension point that allows you to contribute your own error reporting server to the Eclipse IDE. See [https://git.eclipse.org/c/epp/org.eclipse.epp.logging.git/tree/examples/aeri.ide.bundle/plugin.xml this example plugin.xml] how to do that.
 
  
To use AERI in your own Eclipse product check out [https://git.eclipse.org/c/epp/org.eclipse.epp.logging.git/tree/examples/aeri.rcp.silent.bundle this example project] on how to implement a reporting client that silently sends error reports to your in-house server.
+
== Update Sites ==
  
See [https://www.youtube.com/watch?v=TDSv9Tm7hGA this webinar] for detailed step-by-step introduction.
+
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/
  
=== Is the server-side available too? ===
+
URLs may change without further notice. If you need stable URLs, use the annual release train update sites.
No, but there is a free SaaS service hosted by [https://ctrlflow.com/automated-error-reporting/ Ctrlflow].
+
  
 +
== 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