Mercurial > hg > freeDiameter
annotate doc/app_acct.conf.sample @ 1524:195f3fe9b4ed
Fix type of 3GPP HSS-ID (3325)
Note: 3GPP TS 29.338 table 6.3.3.1/1 row HSS-ID (3325)
incorrectly lists type as OctetString instead of UTF8String.
3GPP TS 29.338 clause 6.3.3.14 uses UTF8String.
Fix: HSS-ID (3325) type changed from OctetString to UTF8String.
author | Luke Mewburn <luke@mewburn.net> |
---|---|
date | Sat, 18 Apr 2020 10:47:51 +1000 |
parents | e5010975da35 |
children |
rev | line source |
---|---|
284
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
1 ####################### |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
2 # This file contains the description of configuration and general information about the |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
3 # "App_Acct" extension. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
4 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
5 # This extension provides a simple Diameter Accounting server. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
6 # The extension does receive the Accounting-Request message, then |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
7 # saves the contents of the AVP in a database, as configured here. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
8 # The data is not processed at all. The intent is that a dedicated |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
9 # application will then pull from this database and process the data (consolidate |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
10 # sessions, ...) |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
11 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
12 # In order to enable this extension, the main freeDiameter configuration file |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
13 # must contain the following declaration: |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
14 # LoadExtension = "extensions/app_acct.fdx" : "/path/to/app_acct.conf" ; |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
15 ####################### |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
16 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
17 ################# |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
18 ## Part I: AVP ## |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
19 ################# |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
20 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
21 # Configure here the AVPs that must be stored in the database. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
22 # The format is: |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
23 # "AVP-dictionary-name" = { |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
24 # field = "db-field-name"; |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
25 # required; |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
26 # multi=N; |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
27 # }; |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
28 # Where: |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
29 # AVP-dictionary-name: |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
30 # The name of the AVP, such as "Session-Id". Only this field is mandatory. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
31 # field="...": |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
32 # The name of the field in the database where is AVP contents will be saved. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
33 # The default is that the field is named as the AVP-dictionary-name. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
34 # required: |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
35 # By default, if the AVP is not in the Diameter message, it is not passed in |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
36 # the INSERT statement (will get NULL). If Required is specified for the AVP, |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
37 # an error is returned in the Diameter answer, and the data is discarded. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
38 # multi=N: |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
39 # If an AVP may appear several times in a request, you may specify a number of |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
40 # occurrences to save in the database. The Nth first occurrences of the AVP |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
41 # will be saved in fields "db-field-name1", "db-field-name2", ... "db-field-nameN" |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
42 # |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
43 # In case the default behavior for an AVP is fine, you can use the short syntax: |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
44 # "AVP-dictionary-name"; |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
45 # |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
46 # Note that at the moment, GROUPED AVP are not supported. Also, only the top-level AVPs are |
528
1b3b9790e7cb
Add a new field in the app_acct.fdx database to receive the name of the local server.
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
527
diff
changeset
|
47 # searched. This behavior can be changed quite easily if needed. |
284
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
48 |
533
4cdf146f11d5
Added a set of example PHP scripts to parse the app_acct.fdx data.
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
529
diff
changeset
|
49 # You may look at contrib/app_acct_tools/app_acct.conf and database.sql files |
4cdf146f11d5
Added a set of example PHP scripts to parse the app_acct.fdx data.
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
529
diff
changeset
|
50 # for an example of setup. |
290
7842bed901ca
Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
284
diff
changeset
|
51 |
284
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
52 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
53 ####################### |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
54 ## Part II: Database ## |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
55 ####################### |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
56 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
57 # You must specify the connection information to the database here. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
58 # Please note that if the connection is terminated, it will trig the shutdown of the freeDiameter daemon |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
59 # For this reason, you should as much as possible use a local database. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
60 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
61 # ConnInfo: |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
62 # The connection string to the database. See http://www.postgresql.org/docs/8.4/static/libpq-connect.html |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
63 # Example: ConnInfo = "host=localhost port=5432 dbname=acct user=acct password=freediameter"; |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
64 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
65 # Table: |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
66 # The name of the table to use. The fields and types in this table must be created accordingly to the Part I configuration in this file. |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
67 # Example: Table = "incoming"; |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
68 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
69 # Timestamp_field: |
1228 | 70 # Optionally, you can specify a name of a field that will receive the value 'now' when a new record is inserted. |
284
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
71 # Default: no timestamp is inserted. |
528
1b3b9790e7cb
Add a new field in the app_acct.fdx database to receive the name of the local server.
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
527
diff
changeset
|
72 # Example: Timestamp_field = "recorded_on"; |
1b3b9790e7cb
Add a new field in the app_acct.fdx database to receive the name of the local server.
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
527
diff
changeset
|
73 |
1b3b9790e7cb
Add a new field in the app_acct.fdx database to receive the name of the local server.
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
527
diff
changeset
|
74 # Server_name_field: |
1228 | 75 # Optionally, you can specify a field which will receive the Diameter Identity of the local server for each record saved. |
528
1b3b9790e7cb
Add a new field in the app_acct.fdx database to receive the name of the local server.
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
527
diff
changeset
|
76 # This is useful especially if you have several Accounting servers and want to check Load-Balancing behavior or so, |
1b3b9790e7cb
Add a new field in the app_acct.fdx database to receive the name of the local server.
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
527
diff
changeset
|
77 # after aggregating all the data. |
1b3b9790e7cb
Add a new field in the app_acct.fdx database to receive the name of the local server.
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
527
diff
changeset
|
78 # Default: no server name inserted. |
1b3b9790e7cb
Add a new field in the app_acct.fdx database to receive the name of the local server.
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
527
diff
changeset
|
79 # Example: Server_name_field = "recorded_serv"; |
284
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
80 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
81 |
397cdcd41f53
New app_acct in progress, backup only
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
82 |