github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

all: consistently return text-based HTTP responses with charset=utf-8

Browse source 
This is a follow-up for https://github.com/VictoriaMetrics/VictoriaMetrics/pull/897
This commit is contained in:
Aliaksandr Valialkin 2020-11-13 10:25:39 +02:00
parent 64e99744f1
commit 7ceaf4ba8f
10 changed files with 37 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
app/vmagent/main.go
View file

@ -228,7 +228,7 @@ func requestHandler(w http.ResponseWriter, r *http.Request) bool {
errMsg := fmt.Sprintf("waiting for scrapes to init, left: %d", rdy) errMsg := fmt.Sprintf("waiting for scrapes to init, left: %d", rdy)
http.Error(w, errMsg, http.StatusTooEarly) http.Error(w, errMsg, http.StatusTooEarly)
} else { } else {
w.Header().Set("Content-Type", "text/plain") w.Header().Set("Content-Type", "text/plain; charset=utf-8")
w.WriteHeader(http.StatusOK) w.WriteHeader(http.StatusOK)
w.Write([]byte("OK")) w.Write([]byte("OK"))
} }

2
app/vmalert/datasource/vm.go
View file

@ -82,7 +82,7 @@ func (s *VMStorage) Query(ctx context.Context, query string) ([]Metric, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
req.Header.Set("Content-Type", "application/json") req.Header.Set("Content-Type", "application/json; charset=utf-8")
if s.basicAuthPass != "" { if s.basicAuthPass != "" {
req.SetBasicAuth(s.basicAuthUser, s.basicAuthPass) req.SetBasicAuth(s.basicAuthUser, s.basicAuthPass)
} }

2
app/vmalert/notifier/alertmanager.go
View file

@ -28,7 +28,7 @@ func (am *AlertManager) Send(ctx context.Context, alerts []Alert) error {
if err != nil { if err != nil {
return err return err
} }
req.Header.Set("Content-Type", "application/json") req.Header.Set("Content-Type", "application/json; charset=utf-8")
req = req.WithContext(ctx) req = req.WithContext(ctx)
if am.basicAuthPass != "" { if am.basicAuthPass != "" {
req.SetBasicAuth(am.basicAuthUser, am.basicAuthPass) req.SetBasicAuth(am.basicAuthUser, am.basicAuthPass)

6
app/vmalert/web.go
View file

@ -40,7 +40,7 @@ func (rh *requestHandler) handler(w http.ResponseWriter, r *http.Request) bool {
httpserver.Errorf(w, r, "error in %q: %s", r.URL.Path, err) httpserver.Errorf(w, r, "error in %q: %s", r.URL.Path, err)
return true return true
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
w.Write(data) w.Write(data)
return true return true
case "/api/v1/alerts": case "/api/v1/alerts":
@ -49,7 +49,7 @@ func (rh *requestHandler) handler(w http.ResponseWriter, r *http.Request) bool {
httpserver.Errorf(w, r, "error in %q: %s", r.URL.Path, err) httpserver.Errorf(w, r, "error in %q: %s", r.URL.Path, err)
return true return true
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
w.Write(data) w.Write(data)
return true return true
case "/-/reload": case "/-/reload":
@ -67,7 +67,7 @@ func (rh *requestHandler) handler(w http.ResponseWriter, r *http.Request) bool {
httpserver.Errorf(w, r, "error in %q: %s", r.URL.Path, err) httpserver.Errorf(w, r, "error in %q: %s", r.URL.Path, err)
return true return true
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
w.Write(data) w.Write(data)
return true return true
} }

12
app/vmselect/graphite/graphite.go
View file

@ -88,9 +88,9 @@ func MetricsFindHandler(startTime time.Time, at *auth.Token, w http.ResponseWrit
} }
paths = deduplicatePaths(paths, delimiter) paths = deduplicatePaths(paths, delimiter)
sortPaths(paths, delimiter) sortPaths(paths, delimiter)
contentType := "application/json" contentType := "application/json; charset=utf-8"
if jsonp != "" { if jsonp != "" {
contentType = "text/javascript" contentType = "text/javascript; charset=utf-8"
} }
w.Header().Set("Content-Type", contentType) w.Header().Set("Content-Type", contentType)
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
@ -173,9 +173,9 @@ func MetricsExpandHandler(startTime time.Time, at *auth.Token, w http.ResponseWr
} }
m[query] = paths m[query] = paths
} }
contentType := "application/json" contentType := "application/json; charset=utf-8"
if jsonp != "" { if jsonp != "" {
contentType = "text/javascript" contentType = "text/javascript; charset=utf-8"
} }
w.Header().Set("Content-Type", contentType) w.Header().Set("Content-Type", contentType)
if groupByExpr { if groupByExpr {
@ -225,9 +225,9 @@ func MetricsIndexHandler(startTime time.Time, at *auth.Token, w http.ResponseWri
if isPartial && searchutils.GetDenyPartialResponse(r) { if isPartial && searchutils.GetDenyPartialResponse(r) {
return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable") return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable")
} }
contentType := "application/json" contentType := "application/json; charset=utf-8"
if jsonp != "" { if jsonp != "" {
contentType = "text/javascript" contentType = "text/javascript; charset=utf-8"
} }
w.Header().Set("Content-Type", contentType) w.Header().Set("Content-Type", contentType)
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)

8
app/vmselect/main.go
View file

@ -339,19 +339,19 @@ func selectHandler(startTime time.Time, w http.ResponseWriter, r *http.Request,
case "prometheus/api/v1/rules": case "prometheus/api/v1/rules":
// Return dumb placeholder // Return dumb placeholder
rulesRequests.Inc() rulesRequests.Inc()
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
fmt.Fprintf(w, "%s", `{"status":"success","data":{"groups":[]}}`) fmt.Fprintf(w, "%s", `{"status":"success","data":{"groups":[]}}`)
return true return true
case "prometheus/api/v1/alerts": case "prometheus/api/v1/alerts":
// Return dumb placehloder // Return dumb placehloder
alertsRequests.Inc() alertsRequests.Inc()
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
fmt.Fprintf(w, "%s", `{"status":"success","data":{"alerts":[]}}`) fmt.Fprintf(w, "%s", `{"status":"success","data":{"alerts":[]}}`)
return true return true
case "prometheus/api/v1/metadata": case "prometheus/api/v1/metadata":
// Return dumb placeholder // Return dumb placeholder
metadataRequests.Inc() metadataRequests.Inc()
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
fmt.Fprintf(w, "%s", `{"status":"success","data":{}}`) fmt.Fprintf(w, "%s", `{"status":"success","data":{}}`)
return true return true
default: default:
@ -378,7 +378,7 @@ func deleteHandler(startTime time.Time, w http.ResponseWriter, r *http.Request,
func sendPrometheusError(w http.ResponseWriter, r *http.Request, err error) { func sendPrometheusError(w http.ResponseWriter, r *http.Request, err error) {
logger.Warnf("error in %q: %s", r.RequestURI, err) logger.Warnf("error in %q: %s", r.RequestURI, err)
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
statusCode := http.StatusUnprocessableEntity statusCode := http.StatusUnprocessableEntity
var esc *httpserver.ErrorWithStatusCode var esc *httpserver.ErrorWithStatusCode
if errors.As(err, &esc) { if errors.As(err, &esc) {

25
app/vmselect/prometheus/prometheus.go
View file

@ -96,7 +96,7 @@ func FederateHandler(startTime time.Time, at *auth.Token, w http.ResponseWriter,
return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable") return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable")
} }
w.Header().Set("Content-Type", "text/plain") w.Header().Set("Content-Type", "text/plain; charset=utf-8")
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
defer bufferedwriter.Put(bw) defer bufferedwriter.Put(bw)
err = rss.RunParallel(func(rs *netstorage.Result, workerID uint) error { err = rss.RunParallel(func(rs *netstorage.Result, workerID uint) error {
@ -161,7 +161,7 @@ func ExportCSVHandler(startTime time.Time, at *auth.Token, w http.ResponseWriter
MaxTimestamp: end, MaxTimestamp: end,
TagFilterss: tagFilterss, TagFilterss: tagFilterss,
} }
w.Header().Set("Content-Type", "text/csv") w.Header().Set("Content-Type", "text/csv; charset=utf-8")
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
defer bufferedwriter.Put(bw) defer bufferedwriter.Put(bw)
@ -350,9 +350,9 @@ func exportHandler(at *auth.Token, w http.ResponseWriter, r *http.Request, match
WriteExportJSONLine(bb, xb) WriteExportJSONLine(bb, xb)
resultsCh <- bb resultsCh <- bb
} }
contentType := "application/stream+json" contentType := "application/stream+json; charset=utf-8"
if format == "prometheus" { if format == "prometheus" {
contentType = "text/plain" contentType = "text/plain; charset=utf-8"
writeLineFunc = func(xb *exportBlock, resultsCh chan<- *quicktemplate.ByteBuffer) { writeLineFunc = func(xb *exportBlock, resultsCh chan<- *quicktemplate.ByteBuffer) {
bb := quicktemplate.AcquireByteBuffer() bb := quicktemplate.AcquireByteBuffer()
WriteExportPrometheusLine(bb, xb) WriteExportPrometheusLine(bb, xb)
@ -631,7 +631,7 @@ func LabelValuesHandler(startTime time.Time, at *auth.Token, labelName string, w
return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable") return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable")
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
defer bufferedwriter.Put(bw) defer bufferedwriter.Put(bw)
WriteLabelValuesResponse(bw, labelValues) WriteLabelValuesResponse(bw, labelValues)
@ -714,7 +714,7 @@ func LabelsCountHandler(startTime time.Time, at *auth.Token, w http.ResponseWrit
if isPartial && searchutils.GetDenyPartialResponse(r) { if isPartial && searchutils.GetDenyPartialResponse(r) {
return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable") return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable")
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
defer bufferedwriter.Put(bw) defer bufferedwriter.Put(bw)
WriteLabelsCountResponse(bw, labelEntries) WriteLabelsCountResponse(bw, labelEntries)
@ -768,7 +768,7 @@ func TSDBStatusHandler(startTime time.Time, at *auth.Token, w http.ResponseWrite
if isPartial && searchutils.GetDenyPartialResponse(r) { if isPartial && searchutils.GetDenyPartialResponse(r) {
return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable") return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable")
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
defer bufferedwriter.Put(bw) defer bufferedwriter.Put(bw)
WriteTSDBStatusResponse(bw, status) WriteTSDBStatusResponse(bw, status)
@ -842,7 +842,7 @@ func LabelsHandler(startTime time.Time, at *auth.Token, w http.ResponseWriter, r
return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable") return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable")
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
defer bufferedwriter.Put(bw) defer bufferedwriter.Put(bw)
WriteLabelsResponse(bw, labels) WriteLabelsResponse(bw, labels)
@ -913,8 +913,7 @@ func SeriesCountHandler(startTime time.Time, at *auth.Token, w http.ResponseWrit
if isPartial && searchutils.GetDenyPartialResponse(r) { if isPartial && searchutils.GetDenyPartialResponse(r) {
return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable") return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable")
} }
w.Header().Set("Content-Type", "application/json; charset=utf-8")
w.Header().Set("Content-Type", "application/json")
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
defer bufferedwriter.Put(bw) defer bufferedwriter.Put(bw)
WriteSeriesCountResponse(bw, n) WriteSeriesCountResponse(bw, n)
@ -977,7 +976,7 @@ func SeriesHandler(startTime time.Time, at *auth.Token, w http.ResponseWriter, r
return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable") return fmt.Errorf("cannot return full response, since some of vmstorage nodes are unavailable")
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
defer bufferedwriter.Put(bw) defer bufferedwriter.Put(bw)
resultsCh := make(chan *quicktemplate.ByteBuffer) resultsCh := make(chan *quicktemplate.ByteBuffer)
@ -1117,7 +1116,7 @@ func QueryHandler(startTime time.Time, at *auth.Token, w http.ResponseWriter, r
} }
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
defer bufferedwriter.Put(bw) defer bufferedwriter.Put(bw)
WriteQueryResponse(bw, result) WriteQueryResponse(bw, result)
@ -1219,7 +1218,7 @@ func queryRangeHandler(startTime time.Time, at *auth.Token, w http.ResponseWrite
// See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/153 // See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/153
result = removeEmptyValuesAndTimeseries(result) result = removeEmptyValuesAndTimeseries(result)
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
bw := bufferedwriter.Get(w) bw := bufferedwriter.Get(w)
defer bufferedwriter.Put(bw) defer bufferedwriter.Put(bw)
WriteQueryRangeResponse(bw, result) WriteQueryRangeResponse(bw, result)

8
app/vmstorage/main.go
View file

@ -169,7 +169,7 @@ func requestHandler(w http.ResponseWriter, r *http.Request, strg *storage.Storag
switch path { switch path {
case "/create": case "/create":
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
snapshotPath, err := strg.CreateSnapshot() snapshotPath, err := strg.CreateSnapshot()
if err != nil { if err != nil {
err = fmt.Errorf("cannot create snapshot: %w", err) err = fmt.Errorf("cannot create snapshot: %w", err)
@ -179,7 +179,7 @@ func requestHandler(w http.ResponseWriter, r *http.Request, strg *storage.Storag
fmt.Fprintf(w, `{"status":"ok","snapshot":%q}`, snapshotPath) fmt.Fprintf(w, `{"status":"ok","snapshot":%q}`, snapshotPath)
return true return true
case "/list": case "/list":
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
snapshots, err := strg.ListSnapshots() snapshots, err := strg.ListSnapshots()
if err != nil { if err != nil {
err = fmt.Errorf("cannot list snapshots: %w", err) err = fmt.Errorf("cannot list snapshots: %w", err)
@ -196,7 +196,7 @@ func requestHandler(w http.ResponseWriter, r *http.Request, strg *storage.Storag
fmt.Fprintf(w, `]}`) fmt.Fprintf(w, `]}`)
return true return true
case "/delete": case "/delete":
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
snapshotName := r.FormValue("snapshot") snapshotName := r.FormValue("snapshot")
if err := strg.DeleteSnapshot(snapshotName); err != nil { if err := strg.DeleteSnapshot(snapshotName); err != nil {
err = fmt.Errorf("cannot delete snapshot %q: %w", snapshotName, err) err = fmt.Errorf("cannot delete snapshot %q: %w", snapshotName, err)
@ -206,7 +206,7 @@ func requestHandler(w http.ResponseWriter, r *http.Request, strg *storage.Storag
fmt.Fprintf(w, `{"status":"ok"}`) fmt.Fprintf(w, `{"status":"ok"}`)
return true return true
case "/delete_all": case "/delete_all":
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json; charset=utf-8")
snapshots, err := strg.ListSnapshots() snapshots, err := strg.ListSnapshots()
if err != nil { if err != nil {
err = fmt.Errorf("cannot list snapshots: %w", err) err = fmt.Errorf("cannot list snapshots: %w", err)

2
docs/CHANGELOG.md
View file

@ -10,6 +10,8 @@
* FEATURE: add `-search.treatDotsAsIsInRegexps` command-line flag, which can be used for automatic escaping of dots in regexp label filters used in queries. * FEATURE: add `-search.treatDotsAsIsInRegexps` command-line flag, which can be used for automatic escaping of dots in regexp label filters used in queries.
For example, if `-search.treatDotsAsIsInRegexps` is set, then the query `foo{bar=~"aaa.bb.cc|dd.eee"}` is automatically converted to `foo{bar=~"aaa\\.bb\\.cc|dd\\.eee"}`. For example, if `-search.treatDotsAsIsInRegexps` is set, then the query `foo{bar=~"aaa.bb.cc|dd.eee"}` is automatically converted to `foo{bar=~"aaa\\.bb\\.cc|dd\\.eee"}`.
This may be useful for querying Graphite data. This may be useful for querying Graphite data.
* FEATURE: consistently return text-based HTTP responses such as `plain/text` and `application/json` with `charset=utf-8`.
See https://github.com/VictoriaMetrics/VictoriaMetrics/pull/897
* BUGFIX: do not return data points in the end of the selected time range for time series ending in the middle of the selected time range. * BUGFIX: do not return data points in the end of the selected time range for time series ending in the middle of the selected time range.
See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/887 and https://github.com/VictoriaMetrics/VictoriaMetrics/issues/845 See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/887 and https://github.com/VictoriaMetrics/VictoriaMetrics/issues/845

6
lib/httpserver/httpserver.go
View file

@ -204,7 +204,7 @@ func handlerWrapper(s *server, w http.ResponseWriter, r *http.Request, rh Reques
r.URL.Path = path r.URL.Path = path
switch r.URL.Path { switch r.URL.Path {
case "/health": case "/health":
w.Header().Set("Content-Type", "text/plain") w.Header().Set("Content-Type", "text/plain; charset=utf-8")
deadline := atomic.LoadInt64(&s.shutdownDelayDeadline) deadline := atomic.LoadInt64(&s.shutdownDelayDeadline)
if deadline <= 0 { if deadline <= 0 {
w.Write([]byte("OK")) w.Write([]byte("OK"))
@ -236,7 +236,7 @@ func handlerWrapper(s *server, w http.ResponseWriter, r *http.Request, rh Reques
case "/metrics": case "/metrics":
metricsRequests.Inc() metricsRequests.Inc()
startTime := time.Now() startTime := time.Now()
w.Header().Set("Content-Type", "text/plain") w.Header().Set("Content-Type", "text/plain; charset=utf-8")
WritePrometheusMetrics(w) WritePrometheusMetrics(w)
metricsHandlerDuration.UpdateDuration(startTime) metricsHandlerDuration.UpdateDuration(startTime)
return return
@ -365,7 +365,7 @@ func (zrw *gzipResponseWriter) Write(p []byte) (int, error) {
if h.Get("Content-Type") == "" { if h.Get("Content-Type") == "" {
// Disable auto-detection of content-type, since it // Disable auto-detection of content-type, since it
// is incorrectly detected after the compression. // is incorrectly detected after the compression.
h.Set("Content-Type", "text/html") h.Set("Content-Type", "text/html; charset=utf-8")
} }
} }
zrw.writeHeader() zrw.writeHeader()