mirrors/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-05-04 12:01:23 +02:00
Code Issues Projects Releases Wiki Activity

Unauth metrics: Fix missing parse form and error response (#7569)

Browse Source 
* Unauth metrics: Fix missing parse form and error response

* Change metrics error response to text/plain content type always
This commit is contained in:
Michel Vocks 2019-10-08 14:55:25 +02:00 committed by GitHub
parent 02923ce13c
commit 165b26460a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 69 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
helper/metricsutil/metricsutil.go
View File

@ -4,6 +4,7 @@ import (
"bytes"
"encoding/json"
"fmt"
"net/http"
"strings"
"github.com/armon/go-metrics"
@ -14,6 +15,9 @@ import (
const (
OpenMetricsMIMEType = "application/openmetrics-text"
// ErrorContentType is the content type returned by an error response.
ErrorContentType = "text/plain"
)
const (
@ -40,30 +44,39 @@ func FormatFromRequest(req *logical.Request) string {
return ""
}
func (m *MetricsHelper) ResponseForFormat(format string) (*logical.Response, error) {
func (m *MetricsHelper) ResponseForFormat(format string) *logical.Response {
switch format {
case PrometheusMetricFormat:
return m.PrometheusResponse()
case "":
return m.GenericResponse()
default:
return nil, fmt.Errorf("metric response format \"%s\" unknown", format)
return &logical.Response{
Data: map[string]interface{}{
logical.HTTPContentType: ErrorContentType,
logical.HTTPRawBody: fmt.Sprintf("metric response format \"%s\" unknown", format),
logical.HTTPStatusCode: http.StatusBadRequest,
},
}
}
}
func (m *MetricsHelper) PrometheusResponse() (*logical.Response, error) {
func (m *MetricsHelper) PrometheusResponse() *logical.Response {
resp := &logical.Response{
Data: map[string]interface{}{
logical.HTTPContentType: ErrorContentType,
logical.HTTPStatusCode: http.StatusBadRequest,
},
}
if !m.PrometheusEnabled {
return &logical.Response{
Data: map[string]interface{}{
logical.HTTPContentType: "text/plain",
logical.HTTPRawBody: "prometheus is not enabled",
logical.HTTPStatusCode: 400,
},
}, nil
resp.Data[logical.HTTPRawBody] = "prometheus is not enabled"
return resp
}
metricsFamilies, err := prometheus.DefaultGatherer.Gather()
if err != nil && len(metricsFamilies) == 0 {
return nil, fmt.Errorf("no prometheus metrics could be decoded: %s", err)
resp.Data[logical.HTTPRawBody] = fmt.Sprintf("no prometheus metrics could be decoded: %s", err)
return resp
}
// Initialize a byte buffer.
@ -74,32 +87,36 @@ func (m *MetricsHelper) PrometheusResponse() (*logical.Response, error) {
for _, mf := range metricsFamilies {
err := e.Encode(mf)
if err != nil {
return nil, fmt.Errorf("error during the encoding of metrics: %s", err)
resp.Data[logical.HTTPRawBody] = fmt.Sprintf("error during the encoding of metrics: %s", err)
return resp
}
}
return &logical.Response{
Data: map[string]interface{}{
logical.HTTPContentType: string(expfmt.FmtText),
logical.HTTPRawBody: buf.Bytes(),
logical.HTTPStatusCode: 200,
},
}, nil
resp.Data[logical.HTTPContentType] = string(expfmt.FmtText)
resp.Data[logical.HTTPRawBody] = buf.Bytes()
resp.Data[logical.HTTPStatusCode] = http.StatusOK
return resp
}
func (m *MetricsHelper) GenericResponse() (*logical.Response, error) {
func (m *MetricsHelper) GenericResponse() *logical.Response {
resp := &logical.Response{
Data: map[string]interface{}{
logical.HTTPContentType: ErrorContentType,
logical.HTTPStatusCode: http.StatusBadRequest,
},
}
summary, err := m.inMemSink.DisplayMetrics(nil, nil)
if err != nil {
return nil, fmt.Errorf("error while fetching the in-memory metrics: %s", err)
resp.Data[logical.HTTPRawBody] = fmt.Sprintf("error while fetching the in-memory metrics: %s", err)
return resp
}
content, err := json.Marshal(summary)
if err != nil {
return nil, fmt.Errorf("error while marshalling the in-memory metrics: %s", err)
resp.Data[logical.HTTPRawBody] = fmt.Sprintf("error while marshalling the in-memory metrics: %s", err)
return resp
}
return &logical.Response{
Data: map[string]interface{}{
logical.HTTPContentType: "application/json",
logical.HTTPRawBody: content,
logical.HTTPStatusCode: 200,
},
}, nil
resp.Data[logical.HTTPContentType] = "application/json"
resp.Data[logical.HTTPRawBody] = content
resp.Data[logical.HTTPStatusCode] = http.StatusOK
return resp
}

24
http/sys_metrics.go
View File

@ -1,6 +1,7 @@
package http
import (
"fmt"
"net/http"
"github.com/hashicorp/vault/helper/metricsutil"
@ -11,22 +12,31 @@ import (
func handleMetricsUnauthenticated(core *vault.Core) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
req := &logical.Request{Headers: r.Header}
// Parse form
if err := r.ParseForm(); err != nil {
respondError(w, http.StatusBadRequest, err)
return
}
format := r.Form.Get("format")
if format == "" {
format = metricsutil.FormatFromRequest(req)
}
// Define response
resp, err := core.MetricsHelper().ResponseForFormat(format)
if err != nil {
w.WriteHeader(http.StatusBadRequest)
w.Write([]byte(err.Error()))
return
}
resp := core.MetricsHelper().ResponseForFormat(format)
// Manually extract the logical response and send back the information
w.WriteHeader(resp.Data[logical.HTTPStatusCode].(int))
w.Header().Set("Content-Type", resp.Data[logical.HTTPContentType].(string))
w.Write(resp.Data[logical.HTTPRawBody].([]byte))
switch v := resp.Data[logical.HTTPRawBody].(type) {
case string:
w.Write([]byte(v))
case []byte:
w.Write(v)
default:
respondError(w, http.StatusInternalServerError, fmt.Errorf("wrong response returned"))
}
})
}

6
http/sys_metrics_test.go
View File

@ -14,7 +14,7 @@ func TestSysMetricsUnauthenticated(t *testing.T) {
metrics.DefaultInmemSignal(inm)
conf := &vault.CoreConfig{
BuiltinRegistry: vault.NewMockBuiltinRegistry(),
MetricsHelper: metricsutil.NewMetricsHelper(inm, false),
MetricsHelper: metricsutil.NewMetricsHelper(inm, true),
}
core, _, token := vault.TestCoreUnsealedWithConfig(t, conf)
ln, addr := TestServer(t, core)
@ -47,4 +47,8 @@ func TestSysMetricsUnauthenticated(t *testing.T) {
// Should also work with token
resp = testHttpGet(t, token, addr+"/v1/sys/metrics")
testResponseStatus(t, resp, 200)
// Test if prometheus response is correct
resp = testHttpGet(t, "", addr+"/v1/sys/metrics?format=prometheus")
testResponseStatus(t, resp, 200)
}

2
vault/logical_system.go
View File

@ -2610,7 +2610,7 @@ func (b *SystemBackend) handleMetrics(ctx context.Context, req *logical.Request,
if format == "" {
format = metricsutil.FormatFromRequest(req)
}
return b.Core.metricsHelper.ResponseForFormat(format)
return b.Core.metricsHelper.ResponseForFormat(format), nil
}
// handleHostInfo collects and returns host-related information, which includes