diff --git a/docs/references/environment_variables.md b/docs/references/environment_variables.md index 42c4a3a9b..8383ceb1f 100644 --- a/docs/references/environment_variables.md +++ b/docs/references/environment_variables.md @@ -13,6 +13,7 @@ SGLang supports various environment variables that can be used to configure its | `SGLANG_PORT` | Port for the server | auto-detected | | `SGLANG_LOGGING_CONFIG_PATH` | Custom logging configuration path | Not set | | `SGLANG_DISABLE_REQUEST_LOGGING` | Disable request logging | `false` | +| `SGLANG_LOG_REQUEST_HEADERS` | Comma-separated list of additional HTTP headers to log when `--log-requests` is enabled. Appends to the default `x-smg-routing-key`. | Not set | | `SGLANG_HEALTH_CHECK_TIMEOUT` | Timeout for health check in seconds | `20` | | `SGLANG_EPLB_HEATMAP_COLLECTION_INTERVAL` | The interval of passes to collect the metric of selected count of physical experts on each layer and GPU rank. 0 means disabled. | `0` | | `SGLANG_FORWARD_UNKNOWN_TOOLS` | Forward unknown tool calls to clients instead of dropping them | `false` (drop unknown tools) | diff --git a/python/sglang/srt/environ.py b/python/sglang/srt/environ.py index 928ec998e..702e065dd 100644 --- a/python/sglang/srt/environ.py +++ b/python/sglang/srt/environ.py @@ -163,6 +163,7 @@ class Envs: SGLANG_LOG_MS = EnvBool(False) SGLANG_DISABLE_REQUEST_LOGGING = EnvBool(False) SGLANG_LOG_REQUEST_EXCEEDED_MS = EnvInt(-1) + SGLANG_LOG_REQUEST_HEADERS = EnvTuple(tuple()) SGLANG_LOG_SCHEDULER_STATUS_TARGET = EnvStr("") SGLANG_LOG_SCHEDULER_STATUS_INTERVAL = EnvFloat(60.0) diff --git a/python/sglang/srt/utils/request_logger.py b/python/sglang/srt/utils/request_logger.py index d0f6f26b9..aad5664a7 100644 --- a/python/sglang/srt/utils/request_logger.py +++ b/python/sglang/srt/utils/request_logger.py @@ -29,7 +29,10 @@ if TYPE_CHECKING: logger = logging.getLogger(__name__) -WHITELISTED_HEADERS = ["x-smg-routing-key"] +_DEFAULT_WHITELISTED_HEADERS = ["x-smg-routing-key"] +WHITELISTED_HEADERS = _DEFAULT_WHITELISTED_HEADERS + [ + h.lower() for h in envs.SGLANG_LOG_REQUEST_HEADERS.get() +] def _extract_whitelisted_headers( diff --git a/test/registered/utils/test_request_logger.py b/test/registered/utils/test_request_logger.py index a7744b758..14a801652 100644 --- a/test/registered/utils/test_request_logger.py +++ b/test/registered/utils/test_request_logger.py @@ -1,5 +1,6 @@ import io import json +import os import tempfile import time import unittest @@ -20,10 +21,14 @@ register_cuda_ci(est_time=120, suite="nightly-1-gpu", nightly=True) register_amd_ci(est_time=120, suite="nightly-amd-1-gpu", nightly=True) TEST_ROUTING_KEY = "test-routing-key-12345" +TEST_CUSTOM_HEADER_NAME = "X-Test-Header" +TEST_CUSTOM_HEADER_VALUE = "test-header-value-67890" class BaseTestRequestLogger: log_requests_format = None + env_vars: dict[str, str] = {} # Env vars to set before server launch + request_headers: dict[str, str] = {"X-SMG-Routing-Key": TEST_ROUTING_KEY} @classmethod def setUpClass(cls): @@ -42,6 +47,12 @@ class BaseTestRequestLogger: "stdout", cls.temp_dir, ] + # Set env vars and save old values for restoration + cls._old_env_vars = {} + for key, value in cls.env_vars.items(): + cls._old_env_vars[key] = os.environ.get(key) + os.environ[key] = value + cls.process = popen_launch_server( "Qwen/Qwen3-0.6B", DEFAULT_URL_FOR_TEST, @@ -56,6 +67,12 @@ class BaseTestRequestLogger: cls.stdout.close() cls.stderr.close() cls._temp_dir_obj.cleanup() + # Restore env vars + for key, old_value in cls._old_env_vars.items(): + if old_value is None: + os.environ.pop(key, None) + else: + os.environ[key] = old_value def _verify_logs(self, content: str, source_name: str): raise NotImplementedError @@ -67,7 +84,7 @@ class BaseTestRequestLogger: "text": "Hello", "sampling_params": {"max_new_tokens": 8, "temperature": 0}, }, - headers={"X-SMG-Routing-Key": TEST_ROUTING_KEY}, + headers=self.request_headers, timeout=30, ) self.assertEqual(response.status_code, 200) @@ -136,5 +153,40 @@ class TestRequestLoggerJson(BaseTestRequestLogger, CustomTestCase): ) +class TestCustomHeaderViaEnvVar(BaseTestRequestLogger, CustomTestCase): + """Test that custom headers can be added via SGLANG_LOG_REQUEST_HEADERS env var.""" + + log_requests_format = "text" + env_vars = {"SGLANG_LOG_REQUEST_HEADERS": TEST_CUSTOM_HEADER_NAME} + request_headers = { + "X-SMG-Routing-Key": TEST_ROUTING_KEY, + TEST_CUSTOM_HEADER_NAME: TEST_CUSTOM_HEADER_VALUE, + } + + def _verify_logs(self, content: str, source_name: str): + # Verify custom header is logged + self.assertIn( + TEST_CUSTOM_HEADER_NAME.lower(), + content, + f"Custom header name not found in {source_name}", + ) + self.assertIn( + TEST_CUSTOM_HEADER_VALUE, + content, + f"Custom header value not found in {source_name}", + ) + # Verify default header is still logged (env var appends, not replaces) + self.assertIn( + "x-smg-routing-key", + content, + f"Default header should still be in whitelist in {source_name}", + ) + self.assertIn( + TEST_ROUTING_KEY, + content, + f"Default header value not found in {source_name}", + ) + + if __name__ == "__main__": unittest.main()