document var_metric usage to prevent bugreports that are actually configuration issues

(closes issue #12151)
Reported by: caio1982
Patches:
      DB_metric3.diff uploaded by caio1982 (license 22)


git-svn-id: http://svn.digium.com/svn/asterisk/trunk@106186 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 14 insertions, 0 deletions

diff --git a/doc/tex/realtime.tex b/doc/tex/realtime.tex
index 62349f60c..26f937e87 100644
--- a/doc/tex/realtime.tex
+++ b/doc/tex/realtime.tex
@@ -39,6 +39,20 @@ modules that read configurations, there's no difference between a static
 file in the file system, like extensions.conf, and a configuration loaded
 from a database.
 
+You just have to always make sure the var\_metric values are properly set and
+ordered as you expect in your database server if you're using the static mode
+with ARA (either sequentially or with the same var\_metric value for everybody).
+
+If you have an option that depends on another one in a given configuration
+file (i.e, 'musiconhold' depending on 'agent' from agents.conf) but their
+var\_metric are not sequential you'll probably get default values being assigned for
+those options instead of the desired ones. You can still use the same
+var\_metric for all entries in your DB, just make sure the entries
+are recorded in an order that does not break the option dependency.
+
+That doesn't happen when you use a static file in the file system. Although
+this might be interpreted as a bug or limitation, it is not.
+
 \subsubsection{Realtime SIP friends}
 
 The SIP realtime objects are users and peers that are loaded in memory