1 /**
2 * Copyright 2005-2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kew.util;
17
18 /**
19 * Records and logs performance information about an elapsed time period.
20 *
21 * @author Kuali Rice Team (rice.collab@kuali.org)
22 */
23 public class PerformanceLogger {
24
25 private static final org.apache.log4j.Logger LOG =
26 org.apache.log4j.Logger.getLogger(PerformanceLogger.class);
27 private long startTime;
28 private String documentId;
29
30 public PerformanceLogger() {
31 recordStartTime();
32 }
33
34 public PerformanceLogger(String documentId) {
35 this();
36 this.documentId = documentId;
37 }
38
39 private void recordStartTime() {
40 this.startTime = System.currentTimeMillis();
41 }
42
43 public void log(String message) {
44 log(message, false);
45 }
46
47 public void log(String message, boolean terminalPoint) {
48 if ( LOG.isInfoEnabled() ) {
49 long endTime = System.currentTimeMillis();
50 long totalTime = endTime - startTime;
51 String logMessage = "Time: "+totalTime+" ms, ";
52 if (documentId != null) {
53 logMessage+="docId="+documentId+", ";
54 }
55 logMessage += message;
56 if (terminalPoint) {
57 logMessage += "\n";
58 }
59 LOG.info(logMessage);
60 }
61 }
62
63 }