Merge pull request #10008 from dashevchenko/activityParamDesc

Synchronized DEFAULT_INACTIVITY_TIMEOUT  and TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT default env values

application/src/main/resources/thingsboard.yml

@@ -777,7 +777,12 @@ audit-log:
 
 # Device state parameters
 state:
-  # Should be greater than transport.sessions.report_timeout
+  # Device inactivity timeout is a global configuration parameter that defines when the device will be marked as "inactive" by the server.
+  # The parameter value is in seconds. A user can overwrite this parameter for an individual device by setting the “inactivityTimeout” server-side attribute (NOTE: expects value in milliseconds).
+  # We recommend this parameter to be in sync with session inactivity timeout ("transport.sessions.inactivity_timeout" or TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT) parameter
+  # which is responsible for detection of the stale device connection sessions.
+  # The value of the session inactivity timeout parameter should be greater or equal to the device inactivity timeout.
+  # Note that the session inactivity timeout is set in milliseconds while device inactivity timeout is in seconds.
   defaultInactivityTimeoutInSec: "${DEFAULT_INACTIVITY_TIMEOUT:600}"
   defaultStateCheckIntervalInSec: "${DEFAULT_STATE_CHECK_INTERVAL:60}" # Interval for checking the device state after a specified period. Time in seconds
   # Controls whether we store the device 'active' flag in attributes (default) or telemetry.
@@ -866,8 +871,15 @@ js:
 # Transport configuration parameters
 transport:
   sessions:
-    # Inactivity timeout for device session in transport service. The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # Session inactivity timeout is a global configuration parameter that defines how long the device transport session will be opened after the last message arrives from the device.
-    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:300000}"
+    # The parameter value is in milliseconds.
+    # The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # If there is no activity, the session will be closed, and all subscriptions will be deleted.
+    # We recommend this parameter to be in sync with device inactivity timeout ("state.defaultInactivityTimeoutInSec" or DEFAULT_INACTIVITY_TIMEOUT) parameter
+    # which is responsible for detection of the device connectivity status in the core service of the platform.
+    # The value of the session inactivity timeout parameter should be greater or equal to the device inactivity timeout.
+    # Note that the session inactivity timeout is set in milliseconds while device inactivity timeout is in seconds.
+    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:600000}"
     # Interval of periodic check for expired sessions and report of the changes to session last activity time
     report_timeout: "${TB_TRANSPORT_SESSIONS_REPORT_TIMEOUT:3000}"
   activity:

transport/coap/src/main/resources/tb-coap-transport.yml

@@ -175,8 +175,15 @@ transport:
         # Interval of periodic eviction of the timed-out DTLS sessions
         dtls_session_report_timeout: "${TB_COAP_X509_DTLS_SESSION_REPORT_TIMEOUT:1800000}"
   sessions:
-    # Inactivity timeout for device session in transport service. The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # Session inactivity timeout is a global configuration parameter that defines how long the device transport session will be opened after the last message arrives from the device.
-    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:300000}"
+    # The parameter value is in milliseconds.
+    # The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # If there is no activity, the session will be closed, and all subscriptions will be deleted.
+    # We recommend this parameter to be in sync with device inactivity timeout ("state.defaultInactivityTimeoutInSec" or DEFAULT_INACTIVITY_TIMEOUT) parameter
+    # which is responsible for detection of the device connectivity status in the core service of the platform.
+    # The value of the session inactivity timeout parameter should be greater or equal to the device inactivity timeout.
+    # Note that the session inactivity timeout is set in milliseconds while device inactivity timeout is in seconds.
+    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:600000}"
     # Interval of periodic check for expired sessions and report of the changes to session last activity time
     report_timeout: "${TB_TRANSPORT_SESSIONS_REPORT_TIMEOUT:3000}"
   json:

transport/http/src/main/resources/tb-http-transport.yml

@@ -160,8 +160,15 @@ transport:
     # HTTP maximum request processing timeout in milliseconds
     max_request_timeout: "${HTTP_MAX_REQUEST_TIMEOUT:300000}"
   sessions:
-    # Inactivity timeout for device session in transport service. The last activity time of the device session is updated if device sends any message, including keepalive messages
+    # Session inactivity timeout is a global configuration parameter that defines how long the device transport session will be opened after the last message arrives from the device.
-    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:300000}"
+    # The parameter value is in milliseconds.
+    # The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # If there is no activity, the session will be closed, and all subscriptions will be deleted.
+    # We recommend this parameter to be in sync with device inactivity timeout ("state.defaultInactivityTimeoutInSec" or DEFAULT_INACTIVITY_TIMEOUT) parameter
+    # which is responsible for detection of the device connectivity status in the core service of the platform.
+    # The value of the session inactivity timeout parameter should be greater or equal to the device inactivity timeout.
+    # Note that the session inactivity timeout is set in milliseconds while device inactivity timeout is in seconds.
+    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:600000}"
     # Interval of periodic check for expired sessions and report of the changes to session last activity time
     report_timeout: "${TB_TRANSPORT_SESSIONS_REPORT_TIMEOUT:3000}"
   json:

transport/lwm2m/src/main/resources/tb-lwm2m-transport.yml

@@ -122,8 +122,15 @@ redis:
 # LWM2M server parameters
 transport:
   sessions:
-    # Inactivity timeout for device session in transport service. The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # Session inactivity timeout is a global configuration parameter that defines how long the device transport session will be opened after the last message arrives from the device.
-    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:300000}"
+    # The parameter value is in milliseconds.
+    # The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # If there is no activity, the session will be closed, and all subscriptions will be deleted.
+    # We recommend this parameter to be in sync with device inactivity timeout ("state.defaultInactivityTimeoutInSec" or DEFAULT_INACTIVITY_TIMEOUT) parameter
+    # which is responsible for detection of the device connectivity status in the core service of the platform.
+    # The value of the session inactivity timeout parameter should be greater or equal to the device inactivity timeout.
+    # Note that the session inactivity timeout is set in milliseconds while device inactivity timeout is in seconds.
+    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:600000}"
     # Interval of periodic check for expired sessions and report of the changes to session last activity time
     report_timeout: "${TB_TRANSPORT_SESSIONS_REPORT_TIMEOUT:3000}"
   json:

transport/mqtt/src/main/resources/tb-mqtt-transport.yml

@@ -181,8 +181,15 @@ transport:
       # Skip certificate validity check for client certificates.
       skip_validity_check_for_client_cert: "${MQTT_SSL_SKIP_VALIDITY_CHECK_FOR_CLIENT_CERT:false}"
   sessions:
-    # Inactivity timeout for device session in transport service. The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # Session inactivity timeout is a global configuration parameter that defines how long the device transport session will be opened after the last message arrives from the device.
-    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:300000}"
+    # The parameter value is in milliseconds.
+    # The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # If there is no activity, the session will be closed, and all subscriptions will be deleted.
+    # We recommend this parameter to be in sync with device inactivity timeout ("state.defaultInactivityTimeoutInSec" or DEFAULT_INACTIVITY_TIMEOUT) parameter
+    # which is responsible for detection of the device connectivity status in the core service of the platform.
+    # The value of the session inactivity timeout parameter should be greater or equal to the device inactivity timeout.
+    # Note that the session inactivity timeout is set in milliseconds while device inactivity timeout is in seconds.
+    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:600000}"
     # Interval of periodic check for expired sessions and report of the changes to session last activity time
     report_timeout: "${TB_TRANSPORT_SESSIONS_REPORT_TIMEOUT:3000}"
   json:

transport/snmp/src/main/resources/tb-snmp-transport.yml

@@ -137,8 +137,15 @@ transport:
       # To ignore SNMP response values that do not match the data type of the configured OID mapping (by default false - will throw an error if any value of the response not match configured data types)
       ignore_type_cast_errors: "${SNMP_RESPONSE_IGNORE_TYPE_CAST_ERRORS:false}"
   sessions:
-    # Inactivity timeout for device session in transport service. The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # Session inactivity timeout is a global configuration parameter that defines how long the device transport session will be opened after the last message arrives from the device.
-    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:300000}"
+    # The parameter value is in milliseconds.
+    # The last activity time of the device session is updated if the device sends any message, including keepalive messages
+    # If there is no activity, the session will be closed, and all subscriptions will be deleted.
+    # We recommend this parameter to be in sync with device inactivity timeout ("state.defaultInactivityTimeoutInSec" or DEFAULT_INACTIVITY_TIMEOUT) parameter
+    # which is responsible for detection of the device connectivity status in the core service of the platform.
+    # The value of the session inactivity timeout parameter should be greater or equal to the device inactivity timeout.
+    # Note that the session inactivity timeout is set in milliseconds while device inactivity timeout is in seconds.
+    inactivity_timeout: "${TB_TRANSPORT_SESSIONS_INACTIVITY_TIMEOUT:600000}"
     # Interval of periodic check for expired sessions and report of the changes to session last activity time
     report_timeout: "${TB_TRANSPORT_SESSIONS_REPORT_TIMEOUT:3000}"
   json: