Mercurial > hg > freeDiameter

annotate doc/test_netemul.conf.sample @ 1562:6219359a36a9 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge latest changes from proposed branch
author Sebastien Decugis <sdecugis@freediameter.net>
date Mon, 21 Jun 2021 19:08:18 +0800
parents 083317a4e947
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
651
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
1 # This file contains information for configuring the test_netemul extension.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
2 # To find how to have freeDiameter load this extension, please refer to the freeDiameter documentation.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
3 #
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
4 # The test_netemul extension implements a Diameter proxy that behaves like simple forwarding agent,
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
5 # with the exception that it can introduce delay in the forwarding of the messages and generate duplicates
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
6 # of messages, as can be expected from a real Diameter network. It can also generate routing errors when
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
7 # connected to more than 2 peers.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
8
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
9
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
10 # LATENCY:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
11 # Two parameters are used to control the delay introduced in the messages.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
12 # - latency_average:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
13 # This is the average delay introduced in the packets.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
14 # Set to 0 to not add any latency (beyond the normal processing time).
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
15 # The value is expressed as an integer followed by a unit which can
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
16 # be 's' (seconds) or 'ms' (milliseconds). Example:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
17 # latency_average = 700 ms;
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
18 #
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
19 # - latency_deviation:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
20 # This parameter controls the variance in the latency. It is expressed
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
21 # as a value between 0 % and 100 %. When set to 0 %, all messages will be delayed
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
22 # by exactly latency_average. Otherwise, it represents the width of the interval
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
23 # "around" the average where "most" of the latency will be chosen (the distribution
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
24 # has a Gaussian shape). Example:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
25 # latency_deviation = 25 %;
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
26 #
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
27 # The default values give an added latency "mostly" between 0.4 and 0.6 seconds:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
28 # latency_average = 500 ms;
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
29 # latency_deviation = 20 % ;
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
30
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
31
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
32 # REORDERING:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
33 # There is no special control over the reordering of messages. It may simply happen
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
34 # as a result of the latency. If you want to get a lot of reordering, set the
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
35 # latency_variance to a high value.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
36
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
37
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
38 # DUPLICATES:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
39 # Duplicate messages are expected in the Diameter protocol by design, as a consequence
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
40 # of the failover mechanism that provides the protocol's reliability.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
41 # - dupl_proba:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
42 # This value gives the probability of producing a duplicate of a forwarded message.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
43 # The value is comprized between 0 (no duplicates) and 1 (duplicate all messages).
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
44 # Duplicates are created for requests, but may result in duplicate answers
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
45 # received by your Diameter client(s), depending on your server(s)'s behavior.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
46 # In the case of freeDiameter client, the duplicate answer is automatically filtered out
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
47 # because the hop-by-hop id has already been used.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
48 # Note that each duplicate copy is an independent message,
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
49 # which receives a different latency, and might be routed to a different server if you
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
50 # use for example load-balancing.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
51 # The parameter can take several forms:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
52 # dupl_proba = 0 ;
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
53 # Disables the generation of duplicate messages completely.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
54 # dupl_proba = 1 / 10000 ;
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
55 # dupl_proba = 0.0001 ;
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
56 # Around 1 messages over ten thousands will be duplicated.
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
57 #
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
58 # Default value:
083317a4e947 Added new test_netemul extension (need testing)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
59 # dupl_proba = 1 / 100 ;
"Welcome to our mercurial repository"