milvus/pkg/util/paramtable/http_param.go
congqixia 486141cc12
enhance: [Restful] Make default timeout configurable (#41211)
The restful API default timeout was hard-coded. This PR make this
timeout value configurable via paramtable.

---------

Signed-off-by: Congqi Xia <congqi.xia@zilliz.com>
2025-04-10 16:14:28 +08:00

84 lines
2.6 KiB
Go

// Licensed to the LF AI & Data foundation under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package paramtable
type httpConfig struct {
Enabled ParamItem `refreshable:"false"`
DebugMode ParamItem `refreshable:"false"`
Port ParamItem `refreshable:"false"`
AcceptTypeAllowInt64 ParamItem `refreshable:"true"`
EnablePprof ParamItem `refreshable:"false"`
RequestTimeoutMs ParamItem `refreshable:"true"`
}
func (p *httpConfig) init(base *BaseTable) {
p.Enabled = ParamItem{
Key: "proxy.http.enabled",
DefaultValue: "true",
Version: "2.1.0",
Doc: "Whether to enable the http server",
Export: true,
}
p.Enabled.Init(base.mgr)
p.DebugMode = ParamItem{
Key: "proxy.http.debug_mode",
DefaultValue: "false",
Version: "2.1.0",
Doc: "Whether to enable http server debug mode",
Export: true,
}
p.DebugMode.Init(base.mgr)
p.Port = ParamItem{
Key: "proxy.http.port",
Version: "2.3.0",
Doc: "high-level restful api",
PanicIfEmpty: false,
Export: true,
}
p.Port.Init(base.mgr)
p.AcceptTypeAllowInt64 = ParamItem{
Key: "proxy.http.acceptTypeAllowInt64",
DefaultValue: "true",
Version: "2.3.2",
Doc: "high-level restful api, whether http client can deal with int64",
PanicIfEmpty: false,
Export: true,
}
p.AcceptTypeAllowInt64.Init(base.mgr)
p.EnablePprof = ParamItem{
Key: "proxy.http.enablePprof",
DefaultValue: "true",
Version: "2.3.3",
Doc: "Whether to enable pprof middleware on the metrics port",
Export: true,
}
p.EnablePprof.Init(base.mgr)
p.RequestTimeoutMs = ParamItem{
Key: "proxy.http.requestTimeoutMs",
DefaultValue: "30000",
Version: "2.5.10",
Doc: "default restful request timeout duration in milliseconds",
Export: false,
}
p.RequestTimeoutMs.Init(base.mgr)
}