Skip to content

Commit

Permalink
counters update README
Browse files Browse the repository at this point in the history
  • Loading branch information
oej committed May 31, 2016
1 parent 935737b commit 0ffc1fb
Showing 1 changed file with 32 additions and 33 deletions.
65 changes: 32 additions & 33 deletions modules/counters/README
@@ -1,12 +1,11 @@

Counters Module

Andrei Pelinescu-Onciul

iptelorg GmbH

Copyright � 2010 iptelorg GmbH
_________________________________________________________________
__________________________________________________________________

Table of Contents

Expand All @@ -20,9 +19,9 @@ Andrei Pelinescu-Onciul

3. Functions

3.1. cnt_inc([group.]name)
3.2. cnt_add([group.]name, number)
3.3. cnt_reset([group.]name)
3.1. cnt_inc([group.]name)
3.2. cnt_add([group.]name, number)
3.3. cnt_reset([group.]name)

4. counters RPC Functions

Expand All @@ -35,8 +34,8 @@ Andrei Pelinescu-Onciul

List of Examples

1.1. Create a new script_counter
1.2. Set script_cnt_grp_name in the config file
1.1. Create a new script_counter
1.2. Set script_cnt_grp_name in the config file
1.3. cnt_inc usage
1.4. cnt_add usage
1.5. cnt_reset usage
Expand All @@ -59,9 +58,9 @@ Chapter 1. Admin Guide

3. Functions

3.1. cnt_inc([group.]name)
3.2. cnt_add([group.]name, number)
3.3. cnt_reset([group.]name)
3.1. cnt_inc([group.]name)
3.2. cnt_add([group.]name, number)
3.3. cnt_reset([group.]name)

4. counters RPC Functions

Expand All @@ -74,7 +73,7 @@ Chapter 1. Admin Guide

1. Overview

This module exports counters/statistics manipulating script functions
This module exports counters/statistics manipulating script functions
and RPCs.

2. Parameters
Expand All @@ -85,39 +84,39 @@ Chapter 1. Admin Guide
2.1. script_counter

Define a new counter that can be used from the script. The declaration
might include a group in front of the counter name, separated with
'.'. It might also include a counter description string (help
message), separated from the name with a ' ' or ':'. If the group is
missing, the group defined in the script_cnt_grp_name module parameter
will be used (the default is "script"). If the description is missing,
the default is "custom script counter". The format of the declaration
is: [group.]name[( |:)description].

Example 1.1. Create a new script_counter
might include a group in front of the counter name, separated with '.'.
It might also include a counter description string (help message),
separated from the name with a ' ' or ':'. If the group is missing, the
group defined in the script_cnt_grp_name module parameter will be used
(the default is "script"). If the description is missing, the default
is "custom script counter". The format of the declaration is:
[group.]name[( |:)description].

Example 1.1. Create a new script_counter
modparam("counters", "script_counter", "foo") # script.foo
modparam("counters", "script_counter", "test.bar") # test.bar
modparam("counters", "script_counter", "baz example counter") # script.baz
modparam("counters", "script_counter", "test.x:another example") # test.x

2.2. script_cnt_grp_name

Group name that will be used for the counters defined via the
Group name that will be used for the counters defined via the
script_counter module parameter which do not have a specified group.

Default: "script".

Example 1.2. Set script_cnt_grp_name in the config file
Example 1.2. Set script_cnt_grp_name in the config file
modparam("counters", "script_cnt_grp_name", "my_counters")

3. Functions

3.1. cnt_inc([group.]name)
3.2. cnt_add([group.]name, number)
3.3. cnt_reset([group.]name)
3.1. cnt_inc([group.]name)
3.2. cnt_add([group.]name, number)
3.3. cnt_reset([group.]name)

3.1. cnt_inc([group.]name)
3.1. cnt_inc([group.]name)

Increments the counter group.name. The counter must be defined using
Increments the counter group.name. The counter must be defined using
the script_counter module parameter. If the group name is missing, the
group specified by the script_cnt_grp_name modparam will be used.

Expand All @@ -133,9 +132,9 @@ route {
...
}

3.2. cnt_add([group.]name, number)
3.2. cnt_add([group.]name, number)

Adds number the counter group.name. The counter must be defined using
Adds number the counter group.name. The counter must be defined using
the script_counter module parameter. If the group name is missing, the
group specified by the script_cnt_grp_name modparam will be used.

Expand All @@ -148,10 +147,10 @@ route {
...
}

3.3. cnt_reset([group.]name)
3.3. cnt_reset([group.]name)

Resets the counter group.name. The counter must be defined using the
script_counter module parameter. If the group name is missing, the
Resets the counter group.name. The counter must be defined using the
script_counter module parameter. If the group name is missing, the
group specified by the script_cnt_grp_name modparam will be used.

Example 1.5. cnt_reset usage
Expand Down Expand Up @@ -196,7 +195,7 @@ route {

4.4. cnt.var_list group

Lists all the names of all the counters belonging to the specified
Lists all the names of all the counters belonging to the specified
group.

Example 1.9. cnt.var_list group usage
Expand Down

0 comments on commit 0ffc1fb

Please sign in to comment.