| Rohan Agrawal | c32d993 | 2020-06-15 11:01:47 +0000 | [diff] [blame] | 1 | // Copyright (c) 2017 Uber Technologies, Inc. |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
| 14 | |
| 15 | package metrics |
| 16 | |
| 17 | import ( |
| 18 | "time" |
| 19 | ) |
| 20 | |
| 21 | // StartStopwatch begins recording the executing time of an event, returning |
| 22 | // a Stopwatch that should be used to stop the recording the time for |
| 23 | // that event. Multiple events can be occurring simultaneously each |
| 24 | // represented by different active Stopwatches |
| 25 | func StartStopwatch(timer Timer) Stopwatch { |
| 26 | return Stopwatch{t: timer, start: time.Now()} |
| 27 | } |
| 28 | |
| 29 | // A Stopwatch tracks the execution time of a specific event |
| 30 | type Stopwatch struct { |
| 31 | t Timer |
| 32 | start time.Time |
| 33 | } |
| 34 | |
| 35 | // Stop stops executing of the stopwatch and records the amount of elapsed time |
| 36 | func (s Stopwatch) Stop() { |
| 37 | s.t.Record(s.ElapsedTime()) |
| 38 | } |
| 39 | |
| 40 | // ElapsedTime returns the amount of elapsed time (in time.Duration) |
| 41 | func (s Stopwatch) ElapsedTime() time.Duration { |
| 42 | return time.Since(s.start) |
| 43 | } |