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.
Difference between revisions of "E4/Doc/Logging"
(New page: == Logging And Tracing == <center> <h2><font color=red>A Work In Progress, Please Read First</font></h2> <!-- Leave this notification text for each service --> {| style="background-color:...) |
|||
| Line 1: | Line 1: | ||
== Logging And Tracing == | == Logging And Tracing == | ||
| − | + | {{E4/Doc/Under construction}} | |
| − | + | ||
| − | + | ||
| − | { | + | |
| − | + | ||
| − | + | ==Description == | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
<div style="margin-left:10px;"> | <div style="margin-left:10px;"> | ||
The ability to output knowledge from an executing program is incredibly useful in determining a variety of problems including crashes, bugs and performance issues. The action of outputting this information during runtime to a storage medium (txt file, database, xml etc.) is known as logging and tracing and is common among all practices of software development. When implementing or using logging and tracing it is useful to be aware of the [http://en.wikipedia.org/wiki/Singleton_pattern Singleton Pattern] as it is the most common implementation of a logger. | The ability to output knowledge from an executing program is incredibly useful in determining a variety of problems including crashes, bugs and performance issues. The action of outputting this information during runtime to a storage medium (txt file, database, xml etc.) is known as logging and tracing and is common among all practices of software development. When implementing or using logging and tracing it is useful to be aware of the [http://en.wikipedia.org/wiki/Singleton_pattern Singleton Pattern] as it is the most common implementation of a logger. | ||
| Line 19: | Line 8: | ||
Logging and tracing are the same concept but used to describe varying levels of information. Logging generally refers to higher level information, generally useful to System Administrators on a production system, whereas Tracing is generally more low-level and more useful to developers doing debugging of large systems. | Logging and tracing are the same concept but used to describe varying levels of information. Logging generally refers to higher level information, generally useful to System Administrators on a production system, whereas Tracing is generally more low-level and more useful to developers doing debugging of large systems. | ||
</div> | </div> | ||
| − | == | + | == Consumer === |
<div style="margin-left:10px;"> | <div style="margin-left:10px;"> | ||
e4 specific description of the service/ implementation details etc. | e4 specific description of the service/ implementation details etc. | ||
| − | + | === Usage === | |
(natural breakdown relevant to the service itself here) | (natural breakdown relevant to the service itself here) | ||
| − | + | === Code Samples === | |
<source lang="java"> | <source lang="java"> | ||
| Line 35: | Line 24: | ||
</source> | </source> | ||
| − | + | === Eclipse 3.x === | |
(only if it's relevant AND helpful) | (only if it's relevant AND helpful) | ||
</div> | </div> | ||
| − | == | + | == Producer == |
<div style="margin-left:10px;"> | <div style="margin-left:10px;"> | ||
e4 specific description of the service/ implementation details etc. | e4 specific description of the service/ implementation details etc. | ||
| − | + | === Usage === | |
| − | + | === Code Samples === | |
| − | + | === Eclipse 3.x === | |
(this is not likely needed here) | (this is not likely needed here) | ||
</div> | </div> | ||
| − | == | + | == Related Materials == |
<div style="margin-left:10px;"> | <div style="margin-left:10px;"> | ||
| − | + | === Related Services === | |
| − | + | === Related API's === | |
| − | + | === See Also === | |
</div> | </div> | ||
Revision as of 20:23, 11 February 2010
Contents
Logging And Tracing
The evolution of this document is a collaborative effort between a team of students at the University of Manitoba and the wider Eclipse community. Details about the project can be found here and on our Blog.
Your input is not just welcome; it is needed! Please contribute as your expertise allows, while adhering to our template. To send your feedback and any questions or comments you may have please email us. Also, while we do our very best to be as accurate and precise as possible, it is worth noting that we are students with limited exposure to the Eclipse platform, so if you see any incorrect technical details please let us know.
Description
The ability to output knowledge from an executing program is incredibly useful in determining a variety of problems including crashes, bugs and performance issues. The action of outputting this information during runtime to a storage medium (txt file, database, xml etc.) is known as logging and tracing and is common among all practices of software development. When implementing or using logging and tracing it is useful to be aware of the Singleton Pattern as it is the most common implementation of a logger.
Logging and tracing are the same concept but used to describe varying levels of information. Logging generally refers to higher level information, generally useful to System Administrators on a production system, whereas Tracing is generally more low-level and more useful to developers doing debugging of large systems.
Consumer =
e4 specific description of the service/ implementation details etc.
Usage
(natural breakdown relevant to the service itself here)
Code Samples
System.out.println("I'm some java code");
alert("I'm some javascript");
Eclipse 3.x
(only if it's relevant AND helpful)
Producer
e4 specific description of the service/ implementation details etc.
Usage
Code Samples
Eclipse 3.x
(this is not likely needed here)