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.
Difference between revisions of "OSEE/ReqAndDesign"
< OSEE
| Line 8: | Line 8: | ||
=== Design === | === Design === | ||
| − | id, timestamp, user | + | id, parent_id, timestamp, user, type_id, duration, status, details (maybe in JSON format) |
| − | server uses a queue to collect log entries for a short time (configurable) and then insert them in batch. This means that any update to a log entry that occurs in less than this configured time will not require a database update (i.e. writing the duration of a short operation). | + | * log entries where duration does not apply have a duration of -1 |
| + | * log entries where duration applies start with a duration of -2 and are updated only when the associated job ends | ||
| + | * Status: | ||
| + | 0-99 percent complete | ||
| + | 200 OK completed normally | ||
| + | 4xx client error (as defined for HTTP Status Code Definitions) | ||
| + | 500 server error (as defined for HTTP Status Code Definitions) | ||
| + | |||
| + | * server uses a queue to collect log entries for a short time (configurable) and then insert them in batch. This means that any update to a log entry that occurs in less than this configured time will not require a database update (i.e. writing the duration of a short operation). | ||
log entry types are defined as tokens with a long and name (which is not in db) | log entry types are defined as tokens with a long and name (which is not in db) | ||
Revision as of 15:17, 29 October 2013
Logging
Requirements
- shall handle thousands of log entries per second
- log entries shall be quickly accessible based on any combination of server, user, timestamp, log type, duration, status
- log entries shall be accessible (especially) when an application server is unresponsive
- log entries shall be available until they are deleted by an admin or admin policy (applied by server automatically)
- at run-time logging shall be enabled/disabled based on any combination of user, source, and type
Design
id, parent_id, timestamp, user, type_id, duration, status, details (maybe in JSON format)
- log entries where duration does not apply have a duration of -1
- log entries where duration applies start with a duration of -2 and are updated only when the associated job ends
- Status:
0-99 percent complete 200 OK completed normally 4xx client error (as defined for HTTP Status Code Definitions) 500 server error (as defined for HTTP Status Code Definitions)
- server uses a queue to collect log entries for a short time (configurable) and then insert them in batch. This means that any update to a log entry that occurs in less than this configured time will not require a database update (i.e. writing the duration of a short operation).
log entry types are defined as tokens with a long and name (which is not in db) Optimize JDBC Performance -7 is used for duration on instantaneous events otherwise the actual duration in ms is updated upon completion (in the meantime -1 is used)
Exception Handeling
Requirements
- avoid unnecessary wrapping of exceptions
Design
Checked exceptions I love you, but you have to go Why should you use Unchecked exceptions over Checked exceptions Clean Code by Example: Checked versus unchecked exceptions
- Use application specific exceptions that extend RuntimeException - application specific allows for setting exception breakpoints in the debugger
- Do not declare any run-time exceptions in any method signatures