dovecot - Aug 2019 - 2.3.7 + stats

Is there any additional documentation/information around the new stats 
module.

Have added some metrics just to see what they produce

##
## Metrics
###

metric imap {
 ??? event_name = imap_command_finished
 ??? #source_location = example.c:123

 ??? #categories 
 ??? fields = name args running_usecs bytes_in bytes_out

 ??? #filter {
 ??? #??? field_key = wildcard
 ??? #}
}

metric sql {
 ??? event_name = sql_query_finished
}

metric auth {
 ??? event_name = auth_request_finished
 ??? fields = user transport error successful
}

and get the following


[root at stargate dovecot]# doveadm stats dump
metric_name??? field??? count??? sum??? min??? max??? avg median??? 
stddev??? %95
imap??? duration??? 370??? 2007904499??? 130??? 62955249 5426768.92??? 
2068??? 16436817.37??? 60026465
imap??? name??? 370??? 0??? 0??? 0??? 0.00??? 0??? 0.00??? 0
imap??? args??? 0??? 0??? 0??? 0??? 0.00??? 0??? 0.00??? 0
imap??? running_usecs??? 370??? 2007865330??? 81 62955127??? 
5426663.05??? 1991??? 16436816.76??? 60026329
imap??? bytes_in??? 370??? 5366??? 2??? 173??? 14.50??? 8 19.04??? 35
imap??? bytes_out??? 370??? 2119971??? 0??? 941517 5729.65??? 41??? 
53760.89??? 2082
sql??? duration??? 18??? 28991??? 991??? 2305??? 1610.61 1660??? 
377.36??? 2305
auth??? duration??? 12??? 26046980??? 8146??? 7079879 2170581.67??? 
847730??? 2457811.23??? 7079879
auth??? user??? 12??? 0??? 0??? 0??? 0.00??? 0??? 0.00??? 0
auth??? transport??? 12??? 0??? 0??? 0??? 0.00??? 0??? 0.00 0
auth??? error??? 0??? 0??? 0??? 0??? 0.00??? 0??? 0.00??? 0
auth??? successful??? 0??? 0??? 0??? 0??? 0.00??? 0??? 0.00 0

the main wiki page on stats/events doesnt really hold much detail whats 
stores for each event the above fields dont make much sense

and top no longer works out of the box

[root at stargate dovecot]# doveadm stats top

usage: doveadm [-Dv] [-f <formatter>] stats <command> [<args>]
 ? dump???????? [-s <stats socket path>] [-r] [-f <fields>]


has is been removed ? do you need to specify something additional now ???


rgds


Matt

Some of the behaviours you observe may be due to the same bug I encountered:

https://dovecot.org/pipermail/dovecot/2019-July/116475.html

Especially, regarding the ?successful' field for auth, which does not exists
and is really named ?success', and which is never set anyway.

> Le 15 ao?t 2019 ? 23:57, Matt Bryant via dovecot <dovecot at
dovecot.org> a ?crit :
> 
> Is there any additional documentation/information around the new stats
module.
> 
> Have added some metrics just to see what they produce
> 
> ##
> ## Metrics
> ###
> 
> metric imap {
>     event_name = imap_command_finished
>     #source_location = example.c:123
> 
>     #categories > 
>     fields = name args running_usecs bytes_in bytes_out
> 
>     #filter {
>     #    field_key = wildcard
>     #}
> }
> 
> metric sql {
>     event_name = sql_query_finished
> }
> 
> metric auth {
>     event_name = auth_request_finished
>     fields = user transport error successful
> }
> 
> and get the following
> 
> 
> [root at stargate dovecot]# doveadm stats dump
> metric_name    field    count    sum    min    max    avg median    stddev 
%95
> imap    duration    370    2007904499    130    62955249 5426768.92    2068
16436817.37    60026465
> imap    name    370    0    0    0    0.00    0    0.00    0
> imap    args    0    0    0    0    0.00    0    0.00    0
> imap    running_usecs    370    2007865330    81 62955127    5426663.05   
1991    16436816.76    60026329
> imap    bytes_in    370    5366    2    173    14.50    8 19.04    35
> imap    bytes_out    370    2119971    0    941517 5729.65    41   
53760.89    2082
> sql    duration    18    28991    991    2305    1610.61 1660    377.36   
2305
> auth    duration    12    26046980    8146    7079879 2170581.67    847730 
2457811.23    7079879
> auth    user    12    0    0    0    0.00    0    0.00    0
> auth    transport    12    0    0    0    0.00    0    0.00 0
> auth    error    0    0    0    0    0.00    0    0.00    0
> auth    successful    0    0    0    0    0.00    0    0.00 0
> 
> the main wiki page on stats/events doesnt really hold much detail whats
stores for each event the above fields dont make much sense
> 
> and top no longer works out of the box
> 
> [root at stargate dovecot]# doveadm stats top
> 
> usage: doveadm [-Dv] [-f <formatter>] stats <command>
[<args>]
>   dump         [-s <stats socket path>] [-r] [-f <fields>]
> 
> 
> has is been removed ? do you need to specify something additional now ???
> 
> 
> rgds
> 
> 
> Matt
> 
> 
>

On 16 Aug 2019, at 14.35, Jean-Daniel via dovecot <dovecot at dovecot.org>
wrote:
> 
> Some of the behaviours you observe may be due to the same bug I
encountered:
> 
> https://dovecot.org/pipermail/dovecot/2019-July/116475.html
> 
> Especially, regarding the ?successful' field for auth, which does not
exists and is really named ?success', and which is never set anyway.
As a workaround you could use auth_passdb_request_finished. And since it shows
differences between "password mismatch" vs "user unknown",
that's likely a good permanent solution as well.

metric auth_ok {
  event_name = auth_passdb_request_finished
  filter {
    result = ok
  }
}
metric auth_user_unknown {
  event_name = auth_passdb_request_finished
  filter {
    result = user_unknown
  }
}
metric auth_password_mismatch {
  event_name = auth_passdb_request_finished
  filter {
    result = password_mismatch
  }
}