Add heartbeat API.

ossrs · Apr 12, 2024 · 9fc0241 · 9fc0241
1 parent 545ce8b
commit 9fc0241
Show file tree

Hide file tree

Showing 4 changed files with 180 additions and 0 deletions.
diff --git a/i18n/en-us/docusaurus-plugin-content-docs/current/doc/http-callback.md b/i18n/en-us/docusaurus-plugin-content-docs/current/doc/http-callback.md
@@ -221,6 +221,52 @@ Body:
 
 > Note: You can use wireshark or tcpdump to verify it.
 
+## Heartbeat
+
+SRS will send heartbeat to the HTTP callback server. This allows you to monitor the health of SRS server.
+Enable this feature by:
+
+```bash
+# heartbeat to api server
+# @remark, the ip report to server, is retrieve from system stat,
+#       which need the config item stats.network.
+heartbeat {
+    # whether heartbeat is enabled.
+    # Overwrite by env SRS_HEARTBEAT_ENABLED
+    # default: off
+    enabled off;
+    # the interval seconds for heartbeat,
+    # recommend 0.3,0.6,0.9,1.2,1.5,1.8,2.1,2.4,2.7,3,...,6,9,12,....
+    # Overwrite by env SRS_HEARTBEAT_INTERVAL
+    # default: 9.9
+    interval 9.3;
+    # when startup, srs will heartbeat to this api.
+    # @remark: must be a restful http api url, where SRS will POST with following data:
+    #   {
+    #       "device_id": "my-srs-device",
+    #       "ip": "192.168.1.100"
+    #   }
+    # Overwrite by env SRS_HEARTBEAT_URL
+    # default: http://127.0.0.1:8085/api/v1/servers
+    url http://127.0.0.1:8085/api/v1/servers;
+    # the id of device.
+    # Overwrite by env SRS_HEARTBEAT_DEVICE_ID
+    device_id       "my-srs-device";
+    # whether report with summaries
+    # if on, put /api/v1/summaries to the request data:
+    #   {
+    #       "summaries": summaries object.
+    #   }
+    # @remark: optional config.
+    # Overwrite by env SRS_HEARTBEAT_SUMMARIES
+    # default: off
+    summaries off;
+}
+```
+
+By enable the `summaries`, you can get the SRS server states, such as `self.pid` and `self.srs_uptime`, so you
+can use this to determine whether SRS restarted.
+
 ## Go Example
 
 Write Go code to handle SRS callback, for example, handling `on_publish`:

diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/doc/http-callback.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/doc/http-callback.md
@@ -220,6 +220,50 @@ Body:
 
 > Note: 也可以用wireshark或tcpdump抓包验证。
 
+## Heartbeat
+
+SRS将向HTTP回调服务器发送心跳信号。这允许你监控SRS服务器的健康状况。启用此功能方法：
+
+```bash
+# heartbeat to api server
+# @remark, the ip report to server, is retrieve from system stat,
+#       which need the config item stats.network.
+heartbeat {
+    # whether heartbeat is enabled.
+    # Overwrite by env SRS_HEARTBEAT_ENABLED
+    # default: off
+    enabled off;
+    # the interval seconds for heartbeat,
+    # recommend 0.3,0.6,0.9,1.2,1.5,1.8,2.1,2.4,2.7,3,...,6,9,12,....
+    # Overwrite by env SRS_HEARTBEAT_INTERVAL
+    # default: 9.9
+    interval 9.3;
+    # when startup, srs will heartbeat to this api.
+    # @remark: must be a restful http api url, where SRS will POST with following data:
+    #   {
+    #       "device_id": "my-srs-device",
+    #       "ip": "192.168.1.100"
+    #   }
+    # Overwrite by env SRS_HEARTBEAT_URL
+    # default: http://127.0.0.1:8085/api/v1/servers
+    url http://127.0.0.1:8085/api/v1/servers;
+    # the id of device.
+    # Overwrite by env SRS_HEARTBEAT_DEVICE_ID
+    device_id       "my-srs-device";
+    # whether report with summaries
+    # if on, put /api/v1/summaries to the request data:
+    #   {
+    #       "summaries": summaries object.
+    #   }
+    # @remark: optional config.
+    # Overwrite by env SRS_HEARTBEAT_SUMMARIES
+    # default: off
+    summaries off;
+}
+```
+
+通过启用`summaries`，您可以获取SRS服务器状态，例如`self.pid`和`self.srs_uptime`，因此您可以使用它来判断SRS是否重新启动。
+
 ## Go Example
 
 使用Go处理SRS的回调，以`on_publish`为例：

diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-5.0/doc/http-callback.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-5.0/doc/http-callback.md
@@ -220,6 +220,50 @@ Body:
 
 > Note: 也可以用wireshark或tcpdump抓包验证。
 
+## Heartbeat
+
+SRS将向HTTP回调服务器发送心跳信号。这允许你监控SRS服务器的健康状况。启用此功能方法：
+
+```bash
+# heartbeat to api server
+# @remark, the ip report to server, is retrieve from system stat,
+#       which need the config item stats.network.
+heartbeat {
+    # whether heartbeat is enabled.
+    # Overwrite by env SRS_HEARTBEAT_ENABLED
+    # default: off
+    enabled off;
+    # the interval seconds for heartbeat,
+    # recommend 0.3,0.6,0.9,1.2,1.5,1.8,2.1,2.4,2.7,3,...,6,9,12,....
+    # Overwrite by env SRS_HEARTBEAT_INTERVAL
+    # default: 9.9
+    interval 9.3;
+    # when startup, srs will heartbeat to this api.
+    # @remark: must be a restful http api url, where SRS will POST with following data:
+    #   {
+    #       "device_id": "my-srs-device",
+    #       "ip": "192.168.1.100"
+    #   }
+    # Overwrite by env SRS_HEARTBEAT_URL
+    # default: http://127.0.0.1:8085/api/v1/servers
+    url http://127.0.0.1:8085/api/v1/servers;
+    # the id of device.
+    # Overwrite by env SRS_HEARTBEAT_DEVICE_ID
+    device_id       "my-srs-device";
+    # whether report with summaries
+    # if on, put /api/v1/summaries to the request data:
+    #   {
+    #       "summaries": summaries object.
+    #   }
+    # @remark: optional config.
+    # Overwrite by env SRS_HEARTBEAT_SUMMARIES
+    # default: off
+    summaries off;
+}
+```
+
+通过启用`summaries`，您可以获取SRS服务器状态，例如`self.pid`和`self.srs_uptime`，因此您可以使用它来判断SRS是否重新启动。
+
 ## Go Example
 
 使用Go处理SRS的回调，以`on_publish`为例：

diff --git a/versioned_docs/version-5.0/doc/http-callback.md b/versioned_docs/version-5.0/doc/http-callback.md
@@ -221,6 +221,52 @@ Body:
 
 > Note: You can use wireshark or tcpdump to verify it.
 
+## Heartbeat
+
+SRS will send heartbeat to the HTTP callback server. This allows you to monitor the health of SRS server. 
+Enable this feature by:
+
+```bash
+# heartbeat to api server
+# @remark, the ip report to server, is retrieve from system stat,
+#       which need the config item stats.network.
+heartbeat {
+    # whether heartbeat is enabled.
+    # Overwrite by env SRS_HEARTBEAT_ENABLED
+    # default: off
+    enabled off;
+    # the interval seconds for heartbeat,
+    # recommend 0.3,0.6,0.9,1.2,1.5,1.8,2.1,2.4,2.7,3,...,6,9,12,....
+    # Overwrite by env SRS_HEARTBEAT_INTERVAL
+    # default: 9.9
+    interval 9.3;
+    # when startup, srs will heartbeat to this api.
+    # @remark: must be a restful http api url, where SRS will POST with following data:
+    #   {
+    #       "device_id": "my-srs-device",
+    #       "ip": "192.168.1.100"
+    #   }
+    # Overwrite by env SRS_HEARTBEAT_URL
+    # default: http://127.0.0.1:8085/api/v1/servers
+    url http://127.0.0.1:8085/api/v1/servers;
+    # the id of device.
+    # Overwrite by env SRS_HEARTBEAT_DEVICE_ID
+    device_id       "my-srs-device";
+    # whether report with summaries
+    # if on, put /api/v1/summaries to the request data:
+    #   {
+    #       "summaries": summaries object.
+    #   }
+    # @remark: optional config.
+    # Overwrite by env SRS_HEARTBEAT_SUMMARIES
+    # default: off
+    summaries off;
+}
+```
+
+By enable the `summaries`, you can get the SRS server states, such as `self.pid` and `self.srs_uptime`, so you 
+can use this to determine whether SRS restarted.
+
 ## Go Example
 
 Write Go code to handle SRS callback, for example, handling `on_publish`: