summaryrefslogtreecommitdiff
path: root/src/pmdas/txmon/help
blob: 83e2300a6f2551d6fce618da07004f1bde900f70 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#
# Copyright (c) 2000-2004 Silicon Graphics, Inc.  All Rights Reserved.
# 
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 2 of the License, or (at your
# option) any later version.
# 
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
# for more details.
# 
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#
# txmon PMDA help file in the ASCII format
#
# lines beginning with a # are ignored
# lines beginning @ introduce a new entry of the form
#  @ metric_name oneline-text
#  help test goes
#  here over multiple lines
#  ...
#
# the metric_name is decoded against the default PMNS -- as a special case,
# a name of the form NNN.MM (for numeric NNN and MM) is interpreted as an
# instance domain identification, and the text describes the instance domain
#
# blank lines before the @ line are ignored
#

@ TXMON.0 Instance domain "transaction type name" for txmon PMDA
There is one instance for each transaction type.

@ txmon.count count by transaction type
Count by transaction type of transactions serviced since the txmon PMDA
started.

@ txmon.reset_count reset count by transaction type
Count by transaction type of transactions serviced since the last time
the average and maximum summaries were reset.

@ txmon.ave_time average time per transaction type
Average recorded service time per transaction type since the last time
the statistics were reset.

@ txmon.max_time maximum time per transaction type
Maximum recorded service time per transaction type since the last time
the statistics were reset.

@ txmon.control.level statistics control levels
0 => no statistics are collected
1 => transaction counts are enabled
2 => transaction counts and service times are enabled

@ txmon.control.reset reset statistics
This metric is a toggle-switch ... any pmStore() operation for this
metric will reset all statistics except txmon.count.

The value for this metric is always 1.