Gilles commented on LANG-1373:

It's not the naming part, it's the (supposedly _unique_) identifier part.  See 
your own examples (in the unit tests): identifying the timings is fragile (it's 
easy to create two timings with the same name) and often redundant. I can't 
think of a "deal breaker"; the functionality itself seems quite fine; it's the 
usage part which I suspect is not as good as it could; but once the API is 
released, it is fairly difficult to correct the course in "Commons": fixing a 
single interface often requires changing all (even if "just" by renaming the 
top-level package).
Perhaps the "name" should be a "prefix" (set at construction of the 
{{StackWatch}} and the watch would append an increment to form a unique name at 
each call to {{startTiming}} (?). 

> Stopwatch based capability for nested, named, timings in a call stack
> ---------------------------------------------------------------------
>                 Key: LANG-1373
>                 URL: https://issues.apache.org/jira/browse/LANG-1373
>             Project: Commons Lang
>          Issue Type: New Feature
>          Components: lang.time.*
>            Reporter: Otto Fowler
>            Assignee: Otto Fowler
>            Priority: Major
> While working on adding some timing functionality to a Metron feature, I came 
> across the
> Stopwatch class, but found that it didn’t suite my needs.
> What I wanted to do was to create a timing from a top level function in our 
> Stellar dsl, and have have a group of related timings, such that the end 
> result was the overall time of the call, and nested timings of other calls 
> executed during the dsl execution of that function. These timings would all 
> be named, and have a path for identification and include timing the language 
> compiler/execution as well as the function execution itself. It would be 
> helpful if they were tagged in some way as well, such that the consumer could 
> filter during visitation.
> So I have written StackWatch to provide this functionality, and submitted it 
> in a Metron PR.
> From the PR description:
> StackWatch
> A set of utility classes under the new package stellar.common.timing have 
> been added. These provide the StackWatch functionality.
> StackWatch provides an abstraction over the Apache Commons StopWatch class 
> that allows callers to create multiple named and possibly nested timing 
> operations.
> <…>
> This class may be more generally useful to this and other projects, but I am 
> not sure where it would live since we wouldn’t want it in common.
> StackWatch uses a combination of Deque and a custom Tree implementation to 
> create, start and end timing operations.
> A Visitor pattern is also implemented to allow for retrieving the results 
> after the completion of the operation.

This message was sent by Atlassian JIRA

Reply via email to