Hi,

On 15 June 2017 at 11:42, Chetan Mehrotra <[email protected]> wrote:

> On Thu, Jun 15, 2017 at 2:55 PM, Ian Boston <[email protected]> wrote:
> > Is are the new Oak Metrics documented somewhere ?
>
> No because so far no one else asked for it and only I was making use
> of them! Now that you asked would try to document it
>

perfect, thanks.


>
> > NRT_REFRESH_TIME
>
> That measures the time to refresh the index reader (see NRTIndex
> class). Probably we should have a way to add description at time of
> Metric creation.
>

Elsewhere I am trying to encourage doing that in JavaDoc using a @metric
custom  javadoc tag. I dont know if that will cause problems for Oaks
build, but it should be possible to extract the documentation at a later
date if required. IIUC the tag doesnt need to be formally implemented.

In the case of repository stats all that would be required is the tag added
to the existing javadoc.

When the metric name is the class name, it becomes trivial to locate the
documentation.

Best Regards
Ian




>
> Chetan Mehrotra
>

Reply via email to