Parcourir la source

modules: readme files regenerated - influxdbc ... [skip ci]

Kamailio Dev il y a 1 an
Parent
commit
c4e4b266ad
1 fichiers modifiés avec 63 ajouts et 6 suppressions
  1. 63 6
      src/modules/influxdbc/README

+ 63 - 6
src/modules/influxdbc/README

@@ -33,7 +33,10 @@ Daniel-Constantin Mierla
 
 
               4.1. influxdbc_measure(name)
               4.1. influxdbc_measure(name)
               4.2. influxdbc_measureend()
               4.2. influxdbc_measureend()
-              4.3. influxdbc_long(name, value)
+              4.3. influxdbc_sub(name)
+              4.4. influxdbc_subend()
+              4.5. influxdbc_push()
+              4.6. influxdbc_long(name, value)
 
 
    List of Examples
    List of Examples
 
 
@@ -42,7 +45,10 @@ Daniel-Constantin Mierla
    1.3. Set database parameter
    1.3. Set database parameter
    1.4. influxdbc_measure() usage
    1.4. influxdbc_measure() usage
    1.5. influxdbc_measureend() usage
    1.5. influxdbc_measureend() usage
-   1.6. influxdbc_long() usage
+   1.6. influxdbc_sub() usage
+   1.7. influxdbc_subend() usage
+   1.8. influxdbc_push() usage
+   1.9. influxdbc_long() usage
 
 
 Chapter 1. Admin Guide
 Chapter 1. Admin Guide
 
 
@@ -64,7 +70,10 @@ Chapter 1. Admin Guide
 
 
         4.1. influxdbc_measure(name)
         4.1. influxdbc_measure(name)
         4.2. influxdbc_measureend()
         4.2. influxdbc_measureend()
-        4.3. influxdbc_long(name, value)
+        4.3. influxdbc_sub(name)
+        4.4. influxdbc_subend()
+        4.5. influxdbc_push()
+        4.6. influxdbc_long(name, value)
 
 
 1. Overview
 1. Overview
 
 
@@ -129,7 +138,10 @@ modparam("influxdbc", "database", "stats")
 
 
    4.1. influxdbc_measure(name)
    4.1. influxdbc_measure(name)
    4.2. influxdbc_measureend()
    4.2. influxdbc_measureend()
-   4.3. influxdbc_long(name, value)
+   4.3. influxdbc_sub(name)
+   4.4. influxdbc_subend()
+   4.5. influxdbc_push()
+   4.6. influxdbc_long(name, value)
 
 
 4.1.  influxdbc_measure(name)
 4.1.  influxdbc_measure(name)
 
 
@@ -161,14 +173,59 @@ request_route {
 }
 }
 ...
 ...
 
 
-4.3.  influxdbc_long(name, value)
+4.3.  influxdbc_sub(name)
+
+   Start a measure subgroup with the given name.
+
+   This function can be used from ANY_ROUTE.
+
+   Example 1.6. influxdbc_sub() usage
+...
+request_route {
+    ...
+    influxdbc_sub("grp1");
+    ...
+}
+...
+
+4.4.  influxdbc_subend()
+
+   End the current measure subgroup.
+
+   This function can be used from ANY_ROUTE.
+
+   Example 1.7. influxdbc_subend() usage
+...
+request_route {
+    ...
+    influxdbc_subend();
+    ...
+}
+...
+
+4.5.  influxdbc_push()
+
+   Push accumulated values to the server.
+
+   This function can be used from ANY_ROUTE.
+
+   Example 1.8. influxdbc_push() usage
+...
+request_route {
+    ...
+    influxdbc_push();
+    ...
+}
+...
+
+4.6.  influxdbc_long(name, value)
 
 
    Save the pair with provided name and value. Both parameters can have
    Save the pair with provided name and value. Both parameters can have
    variables.
    variables.
 
 
    This function can be used from ANY_ROUTE.
    This function can be used from ANY_ROUTE.
 
 
-   Example 1.6. influxdbc_long() usage
+   Example 1.9. influxdbc_long() usage
 ...
 ...
 request_route {
 request_route {
     ...
     ...