docs: add TCP and UDP connection count fields to API documentation and examples for monitoring

Author: yosebyte

docs/en/api.md

@@ -73,6 +73,8 @@ API Key authentication is enabled by default. The key is auto-generated and stor
   "restart": true,
   "pool": 0,
   "ping": 0,
+  "tcps": 0,
+  "udps": 0,
   "tcprx": 0,
   "tcptx": 0,
   "udprx": 0,
@@ -81,6 +83,7 @@ API Key authentication is enabled by default. The key is auto-generated and stor
 ```
 
 - `pool`/`ping`: health check data, only available in debug mode
+- `tcps`/`udps`: current active connection count (TCP and UDP)
 - `tcprx`/`tcptx`/`udprx`/`udptx`: cumulative traffic stats
 - `restart`: auto-start policy
 

docs/en/configuration.md

@@ -184,6 +184,7 @@ NodePass allows flexible configuration via URL query parameters. The following t
 | `mode`    | Run mode control      |   O    |   O    |   X    |
 | `read`    | Data read timeout     |   O    |   O    |   X    |
 | `rate`    | Bandwidth rate limit  |   O    |   O    |   X    |
+| `slot`    | Maximum connection limit  |   O    |   O    |   X    |
 
 - O: Parameter is valid and recommended for configuration
 - X: Parameter is not applicable and should be ignored
@@ -201,7 +202,7 @@ NodePass behavior can be fine-tuned using environment variables. Below is the co
 
 | Variable | Description | Default | Example |
 |----------|-------------|---------|---------|
-| `NP_SEMAPHORE_LIMIT` | Maximum number of concurrent connections | 1024 | `export NP_SEMAPHORE_LIMIT=2048` |
+| `NP_SEMAPHORE_LIMIT` | Signal channel buffer size | 1024 | `export NP_SEMAPHORE_LIMIT=2048` |
 | `NP_UDP_DATA_BUF_SIZE` | Buffer size for UDP packets | 8192 | `export NP_UDP_DATA_BUF_SIZE=16384` |
 | `NP_HANDSHAKE_TIMEOUT` | Timeout for handshake operations | 10s | `export NP_HANDSHAKE_TIMEOUT=30s` |
 | `NP_TCP_DIAL_TIMEOUT` | Timeout for establishing TCP connections | 30s | `export NP_TCP_DIAL_TIMEOUT=60s` |
@@ -242,10 +243,10 @@ The connection pool parameters are important settings for performance tuning in
 
 #### Connection Management
 
-- `NP_SEMAPHORE_LIMIT`: Controls the maximum number of concurrent tunnel operations
-  - Too low: Rejected connections during traffic spikes
-  - Too high: Potential memory pressure from too many concurrent goroutines
-  - Recommended range: 1000-5000 for most applications, higher for high-throughput scenarios
+- `NP_SEMAPHORE_LIMIT`: Controls signal channel buffer size
+  - Too small: May cause signal loss
+  - Too large: Increased memory usage
+  - Recommended range: 1000-5000
 
 ### UDP Settings
 
@@ -266,10 +267,9 @@ For applications relying heavily on UDP traffic:
 For optimizing TCP connections:
 
 - `NP_TCP_DIAL_TIMEOUT`: Timeout for establishing TCP connections
-  - Default (10s) is suitable for most network conditions
+  - Default (30s) is suitable for most network conditions
   - Increase for unstable network conditions
   - Decrease for applications that need quick connection success/failure determination
-  - Affects initial connection establishment phase
 
 ### Pool Management Settings
 

docs/en/examples.md

@@ -328,6 +328,44 @@ This allows:
 - Custom URL paths for security or organizational purposes
 - Swagger UI access at http://localhost:9090/admin/v1/docs
 
+### Example 17: Real-time Connection and Traffic Monitoring
+
+Monitor instance connection counts and traffic statistics through the master API:
+
+```bash
+# Get detailed instance information including connection count statistics
+curl -H "X-API-Key: your-api-key" http://localhost:9090/api/v1/instances/{id}
+
+# Example response (including TCPS and UDPS fields)
+{
+  "id": "a1b2c3d4",
+  "alias": "web-proxy",
+  "type": "server",
+  "status": "running", 
+  "url": "server://0.0.0.0:10101/127.0.0.1:8080",
+  "restart": true,
+  "pool": 64,
+  "ping": 25,
+  "tcps": 12,
+  "udps": 5,
+  "tcprx": 1048576,
+  "tcptx": 2097152,
+  "udprx": 512000,
+  "udptx": 256000
+}
+
+# Use SSE to monitor real-time status changes for all instances
+curl -H "X-API-Key: your-api-key" \
+  -H "Accept: text/event-stream" \
+  http://localhost:9090/api/v1/events
+```
+
+This monitoring setup provides:
+- **Real-time connection tracking**: TCPS and UDPS fields show current active connection counts
+- **Performance analysis**: Evaluate system load through connection and traffic data
+- **Capacity planning**: Resource planning based on historical connection data
+- **Troubleshooting**: Abnormal connection count changes may indicate network issues
+
 ## Next Steps
 
 Now that you've seen various usage examples, you might want to:

docs/en/how-it-works.md

@@ -360,6 +360,7 @@ NodePass's data exchange mechanisms embody modern network programming best pract
    - Real-time byte-level traffic statistics, supporting precise bandwidth control
    - Protocol-specific traffic analysis, facilitating performance tuning
    - Connection-level performance metrics, supporting fine-grained monitoring
+   - Real-time tracking of active TCP and UDP connection counts for capacity planning and performance analysis
 
 ### Protocol Optimization
 1. **TCP Optimization**:

docs/zh/api.md

@@ -72,6 +72,8 @@ API Key 认证默认启用，首次启动自动生成并保存在 `nodepass.gob`
   "restart": true,
   "pool": 0,
   "ping": 0,
+  "tcps": 0,
+  "udps": 0,
   "tcprx": 0,
   "tcptx": 0,
   "udprx": 0,
@@ -80,6 +82,7 @@ API Key 认证默认启用，首次启动自动生成并保存在 `nodepass.gob`
 ```
 
 - `pool`/`ping`：健康检查数据，仅 debug 模式下统计
+- `tcps`/`udps`：当前活动连接数统计（TCP和UDP）
 - `tcprx`/`tcptx`/`udprx`/`udptx`：累计流量统计
 - `restart`：自启动策略
 

docs/zh/configuration.md

@@ -184,6 +184,7 @@ NodePass支持通过URL查询参数进行灵活配置，不同参数在 server
 | `mode`    | 运行模式控制         |   O    |   O    |   X    |
 | `read`    | 读取超时时间         |   O    |   O    |   X    |
 | `rate`    | 带宽速率限制         |   O    |   O    |   X    |
+| `slot`    | 最大连接数限制       |   O    |   O    |   X    |
 
 
 - O：参数有效，推荐根据实际场景配置
@@ -202,7 +203,7 @@ NodePass支持通过URL查询参数进行灵活配置，不同参数在 server
 
 | 变量 | 描述 | 默认值 | 示例 |
 |----------|-------------|---------|---------|
-| `NP_SEMAPHORE_LIMIT` | 最大并发连接数 | 1024 | `export NP_SEMAPHORE_LIMIT=2048` |
+| `NP_SEMAPHORE_LIMIT` | 信号缓冲区大小 | 1024 | `export NP_SEMAPHORE_LIMIT=2048` |
 | `NP_UDP_DATA_BUF_SIZE` | UDP数据包缓冲区大小 | 8192 | `export NP_UDP_DATA_BUF_SIZE=16384` |
 | `NP_HANDSHAKE_TIMEOUT` | 握手操作超时 | 10s | `export NP_HANDSHAKE_TIMEOUT=30s` |
 | `NP_TCP_DIAL_TIMEOUT` | TCP连接建立超时 | 30s | `export NP_TCP_DIAL_TIMEOUT=60s` |
@@ -243,10 +244,10 @@ NodePass支持通过URL查询参数进行灵活配置，不同参数在 server
 
 #### 连接管理
 
-- `NP_SEMAPHORE_LIMIT`：控制最大并发隧道操作数
-  - 太低：流量高峰期拒绝连接
-  - 太高：太多并发goroutine可能导致内存压力
-  - 推荐范围：大多数应用1000-5000，高吞吐量场景更高
+- `NP_SEMAPHORE_LIMIT`：控制信号缓冲区大小
+  - 太小：容易导致信号丢失
+  - 太大：内存使用增加
+  - 推荐范围：1000-5000
 
 ### UDP设置
 
@@ -267,10 +268,9 @@ NodePass支持通过URL查询参数进行灵活配置，不同参数在 server
 对于TCP连接的优化：
 
 - `NP_TCP_DIAL_TIMEOUT`：TCP连接建立超时
-  - 默认值(10s)适用于大多数网络条件
+  - 默认值(30s)适用于大多数网络条件
   - 对于网络条件不稳定的环境增加此值
   - 对于需要快速判断连接成功与否的应用减少此值
-  - 影响初始连接建立阶段
 
 ### 连接池管理设置
 

docs/zh/examples.md

@@ -328,6 +328,44 @@ curl -X POST http://localhost:9090/admin/v1/instances \
 - 用于安全或组织目的的自定义URL路径
 - 在http://localhost:9090/admin/v1/docs访问Swagger UI
 
+### 示例17：实时监控连接数和流量
+
+通过主控API监控实例的连接数和流量统计：
+
+```bash
+# 获取实例详细信息，包括连接数统计
+curl -H "X-API-Key: your-api-key" http://localhost:9090/api/v1/instances/{id}
+
+# 响应示例（包含TCPS和UDPS字段）
+{
+  "id": "a1b2c3d4",
+  "alias": "网站代理",
+  "type": "server",
+  "status": "running", 
+  "url": "server://0.0.0.0:10101/127.0.0.1:8080",
+  "restart": true,
+  "pool": 64,
+  "ping": 25,
+  "tcps": 12,
+  "udps": 5,
+  "tcprx": 1048576,
+  "tcptx": 2097152,
+  "udprx": 512000,
+  "udptx": 256000
+}
+
+# 使用SSE实时监控所有实例状态变化
+curl -H "X-API-Key: your-api-key" \
+  -H "Accept: text/event-stream" \
+  http://localhost:9090/api/v1/events
+```
+
+此监控设置提供：
+- **实时连接数跟踪**：TCPS和UDPS字段显示当前活动连接数
+- **性能分析**：通过连接数和流量数据评估系统负载
+- **容量规划**：基于历史连接数据进行资源规划
+- **故障诊断**：异常的连接数变化可能指示网络问题
+
 ## 下一步
 
 现在您已经了解了各种使用示例，您可能想要：

docs/zh/how-it-works.md

@@ -361,6 +361,7 @@ NodePass 的数据交换机制体现了现代网络编程的最佳实践：
    - 实时的字节级流量统计，支持精确的带宽控制
    - 分协议的流量分析，便于性能调优
    - 连接级别的性能指标，支持细粒度监控
+   - 实时跟踪TCP和UDP活动连接数，便于容量规划和性能分析
 
 ### 协议优化
 1. **TCP优化**：