Skip to content

Commit 50ca48f

Browse files
MadVikingGodhanyuancheungpellared
authored
Remove high cardanility metrics from otelhttp (#4277)
* Add a metric attribute SemConvUtil target. * changelog * Fix lint * use switch over map lookup * Add top level HTTPServerRequestMetrics Make the otelhttp use the new function Add test for new function. * Update CHANGELOG.md * Address PR comments --------- Co-authored-by: Chester Cheung <[email protected]> Co-authored-by: Robert Pająk <[email protected]>
1 parent b6fc62f commit 50ca48f

File tree

18 files changed

+1030
-33
lines changed

18 files changed

+1030
-33
lines changed

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
2323
- The `faas.execution` attribute is now `faas.invocation_id`.
2424
- The `faas.id` attribute is now `aws.lambda.invoked_arn`.
2525
- The semantic conventions used by `go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws` have been upgraded to v1.21.0. (#4265)
26+
- The `http.request.method` attribute will only allow known HTTP methods from the metrics generated by `go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp`. (#4277)
27+
28+
### Removed
29+
30+
- The high cardinality attributes `net.sock.peer.addr`, `net.sock.peer.port`, `http.user_agent`, `enduser.id`, and `http.client_ip` were removed from the metrics generated by `go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp`. (#4277)
2631

2732
## [1.18.0/0.43.0/0.12.0] - 2023-08-28
2833

‎instrumentation/github.com/emicklei/go-restful/otelrestful/internal/semconvutil/httpconv.go‎

Lines changed: 95 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,30 @@ func HTTPServerRequest(server string, req *http.Request) []attribute.KeyValue {
8383
return hc.ServerRequest(server, req)
8484
}
8585

86+
// HTTPServerRequestMetrics returns metric attributes for an HTTP request received by a
87+
// server.
88+
//
89+
// The server must be the primary server name if it is known. For example this
90+
// would be the ServerName directive
91+
// (https://httpd.apache.org/docs/2.4/mod/core.html#servername) for an Apache
92+
// server, and the server_name directive
93+
// (http://nginx.org/en/docs/http/ngx_http_core_module.html#server_name) for an
94+
// nginx server. More generically, the primary server name would be the host
95+
// header value that matches the default virtual host of an HTTP server. It
96+
// should include the host identifier and if a port is used to route to the
97+
// server that port identifier should be included as an appropriate port
98+
// suffix.
99+
//
100+
// If the primary server name is not known, server should be an empty string.
101+
// The req Host will be used to determine the server instead.
102+
//
103+
// The following attributes are always returned: "http.method", "http.scheme",
104+
// "http.flavor", "net.host.name". The following attributes are
105+
// returned if they related values are defined in req: "net.host.port".
106+
func HTTPServerRequestMetrics(server string, req *http.Request) []attribute.KeyValue {
107+
return hc.ServerRequestMetrics(server, req)
108+
}
109+
86110
// HTTPServerStatus returns a span status code and message for an HTTP status code
87111
// value returned by a server. Status codes in the 400-499 range are not
88112
// returned as errors.
@@ -217,7 +241,7 @@ func (c *httpConv) ClientRequest(req *http.Request) []attribute.KeyValue {
217241
attrs := make([]attribute.KeyValue, 0, n)
218242

219243
attrs = append(attrs, c.method(req.Method))
220-
attrs = append(attrs, c.proto(req.Proto))
244+
attrs = append(attrs, c.flavor(req.Proto))
221245

222246
var u string
223247
if req.URL != nil {
@@ -318,7 +342,7 @@ func (c *httpConv) ServerRequest(server string, req *http.Request) []attribute.K
318342

319343
attrs = append(attrs, c.method(req.Method))
320344
attrs = append(attrs, c.scheme(req.TLS != nil))
321-
attrs = append(attrs, c.proto(req.Proto))
345+
attrs = append(attrs, c.flavor(req.Proto))
322346
attrs = append(attrs, c.NetConv.HostName(host))
323347

324348
if hostPort > 0 {
@@ -349,21 +373,89 @@ func (c *httpConv) ServerRequest(server string, req *http.Request) []attribute.K
349373
return attrs
350374
}
351375

376+
// ServerRequestMetrics returns metric attributes for an HTTP request received
377+
// by a server.
378+
//
379+
// The server must be the primary server name if it is known. For example this
380+
// would be the ServerName directive
381+
// (https://httpd.apache.org/docs/2.4/mod/core.html#servername) for an Apache
382+
// server, and the server_name directive
383+
// (http://nginx.org/en/docs/http/ngx_http_core_module.html#server_name) for an
384+
// nginx server. More generically, the primary server name would be the host
385+
// header value that matches the default virtual host of an HTTP server. It
386+
// should include the host identifier and if a port is used to route to the
387+
// server that port identifier should be included as an appropriate port
388+
// suffix.
389+
//
390+
// If the primary server name is not known, server should be an empty string.
391+
// The req Host will be used to determine the server instead.
392+
//
393+
// The following attributes are always returned: "http.method", "http.scheme",
394+
// "http.flavor", "net.host.name". The following attributes are
395+
// returned if they related values are defined in req: "net.host.port".
396+
func (c *httpConv) ServerRequestMetrics(server string, req *http.Request) []attribute.KeyValue {
397+
// TODO: This currently does not add the specification required
398+
// `http.target` attribute. It has too high of a cardinality to safely be
399+
// added. An alternate should be added, or this comment removed, when it is
400+
// addressed by the specification. If it is ultimately decided to continue
401+
// not including the attribute, the HTTPTargetKey field of the httpConv
402+
// should be removed as well.
403+
404+
n := 4 // Method, scheme, proto, and host name.
405+
var host string
406+
var p int
407+
if server == "" {
408+
host, p = splitHostPort(req.Host)
409+
} else {
410+
// Prioritize the primary server name.
411+
host, p = splitHostPort(server)
412+
if p < 0 {
413+
_, p = splitHostPort(req.Host)
414+
}
415+
}
416+
hostPort := requiredHTTPPort(req.TLS != nil, p)
417+
if hostPort > 0 {
418+
n++
419+
}
420+
attrs := make([]attribute.KeyValue, 0, n)
421+
422+
attrs = append(attrs, c.methodMetric(req.Method))
423+
attrs = append(attrs, c.scheme(req.TLS != nil))
424+
attrs = append(attrs, c.flavor(req.Proto))
425+
attrs = append(attrs, c.NetConv.HostName(host))
426+
427+
if hostPort > 0 {
428+
attrs = append(attrs, c.NetConv.HostPort(hostPort))
429+
}
430+
431+
return attrs
432+
}
433+
352434
func (c *httpConv) method(method string) attribute.KeyValue {
353435
if method == "" {
354436
return c.HTTPMethodKey.String(http.MethodGet)
355437
}
356438
return c.HTTPMethodKey.String(method)
357439
}
358440

441+
func (c *httpConv) methodMetric(method string) attribute.KeyValue {
442+
method = strings.ToUpper(method)
443+
switch method {
444+
case http.MethodConnect, http.MethodDelete, http.MethodGet, http.MethodHead, http.MethodOptions, http.MethodPatch, http.MethodPost, http.MethodPut, http.MethodTrace:
445+
default:
446+
method = "_OTHER"
447+
}
448+
return c.HTTPMethodKey.String(method)
449+
}
450+
359451
func (c *httpConv) scheme(https bool) attribute.KeyValue { // nolint:revive
360452
if https {
361453
return c.HTTPSchemeHTTPS
362454
}
363455
return c.HTTPSchemeHTTP
364456
}
365457

366-
func (c *httpConv) proto(proto string) attribute.KeyValue {
458+
func (c *httpConv) flavor(proto string) attribute.KeyValue {
367459
switch proto {
368460
case "HTTP/1.0":
369461
return c.HTTPFlavorKey.String("1.0")

‎instrumentation/github.com/emicklei/go-restful/otelrestful/internal/semconvutil/httpconv_test.go‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,38 @@ func TestHTTPServerRequest(t *testing.T) {
165165
HTTPServerRequest("", req))
166166
}
167167

168+
func TestHTTPServerRequestMetrics(t *testing.T) {
169+
got := make(chan *http.Request, 1)
170+
handler := func(w http.ResponseWriter, r *http.Request) {
171+
got <- r
172+
w.WriteHeader(http.StatusOK)
173+
}
174+
175+
srv := httptest.NewServer(http.HandlerFunc(handler))
176+
defer srv.Close()
177+
178+
srvURL, err := url.Parse(srv.URL)
179+
require.NoError(t, err)
180+
srvPort, err := strconv.ParseInt(srvURL.Port(), 10, 32)
181+
require.NoError(t, err)
182+
183+
resp, err := srv.Client().Get(srv.URL)
184+
require.NoError(t, err)
185+
require.NoError(t, resp.Body.Close())
186+
187+
req := <-got
188+
189+
assert.ElementsMatch(t,
190+
[]attribute.KeyValue{
191+
attribute.String("http.method", "GET"),
192+
attribute.String("http.scheme", "http"),
193+
attribute.String("http.flavor", "1.1"),
194+
attribute.String("net.host.name", srvURL.Hostname()),
195+
attribute.Int("net.host.port", int(srvPort)),
196+
},
197+
HTTPServerRequestMetrics("", req))
198+
}
199+
168200
func TestHTTPServerName(t *testing.T) {
169201
req := new(http.Request)
170202
var got []attribute.KeyValue
@@ -223,7 +255,7 @@ func TestHTTPProto(t *testing.T) {
223255

224256
for proto, want := range tests {
225257
expect := attribute.String("http.flavor", want)
226-
assert.Equal(t, expect, hc.proto(proto), proto)
258+
assert.Equal(t, expect, hc.flavor(proto), proto)
227259
}
228260
}
229261

‎instrumentation/github.com/gin-gonic/gin/otelgin/internal/semconvutil/httpconv.go‎

Lines changed: 95 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,30 @@ func HTTPServerRequest(server string, req *http.Request) []attribute.KeyValue {
8383
return hc.ServerRequest(server, req)
8484
}
8585

86+
// HTTPServerRequestMetrics returns metric attributes for an HTTP request received by a
87+
// server.
88+
//
89+
// The server must be the primary server name if it is known. For example this
90+
// would be the ServerName directive
91+
// (https://httpd.apache.org/docs/2.4/mod/core.html#servername) for an Apache
92+
// server, and the server_name directive
93+
// (http://nginx.org/en/docs/http/ngx_http_core_module.html#server_name) for an
94+
// nginx server. More generically, the primary server name would be the host
95+
// header value that matches the default virtual host of an HTTP server. It
96+
// should include the host identifier and if a port is used to route to the
97+
// server that port identifier should be included as an appropriate port
98+
// suffix.
99+
//
100+
// If the primary server name is not known, server should be an empty string.
101+
// The req Host will be used to determine the server instead.
102+
//
103+
// The following attributes are always returned: "http.method", "http.scheme",
104+
// "http.flavor", "net.host.name". The following attributes are
105+
// returned if they related values are defined in req: "net.host.port".
106+
func HTTPServerRequestMetrics(server string, req *http.Request) []attribute.KeyValue {
107+
return hc.ServerRequestMetrics(server, req)
108+
}
109+
86110
// HTTPServerStatus returns a span status code and message for an HTTP status code
87111
// value returned by a server. Status codes in the 400-499 range are not
88112
// returned as errors.
@@ -217,7 +241,7 @@ func (c *httpConv) ClientRequest(req *http.Request) []attribute.KeyValue {
217241
attrs := make([]attribute.KeyValue, 0, n)
218242

219243
attrs = append(attrs, c.method(req.Method))
220-
attrs = append(attrs, c.proto(req.Proto))
244+
attrs = append(attrs, c.flavor(req.Proto))
221245

222246
var u string
223247
if req.URL != nil {
@@ -318,7 +342,7 @@ func (c *httpConv) ServerRequest(server string, req *http.Request) []attribute.K
318342

319343
attrs = append(attrs, c.method(req.Method))
320344
attrs = append(attrs, c.scheme(req.TLS != nil))
321-
attrs = append(attrs, c.proto(req.Proto))
345+
attrs = append(attrs, c.flavor(req.Proto))
322346
attrs = append(attrs, c.NetConv.HostName(host))
323347

324348
if hostPort > 0 {
@@ -349,21 +373,89 @@ func (c *httpConv) ServerRequest(server string, req *http.Request) []attribute.K
349373
return attrs
350374
}
351375

376+
// ServerRequestMetrics returns metric attributes for an HTTP request received
377+
// by a server.
378+
//
379+
// The server must be the primary server name if it is known. For example this
380+
// would be the ServerName directive
381+
// (https://httpd.apache.org/docs/2.4/mod/core.html#servername) for an Apache
382+
// server, and the server_name directive
383+
// (http://nginx.org/en/docs/http/ngx_http_core_module.html#server_name) for an
384+
// nginx server. More generically, the primary server name would be the host
385+
// header value that matches the default virtual host of an HTTP server. It
386+
// should include the host identifier and if a port is used to route to the
387+
// server that port identifier should be included as an appropriate port
388+
// suffix.
389+
//
390+
// If the primary server name is not known, server should be an empty string.
391+
// The req Host will be used to determine the server instead.
392+
//
393+
// The following attributes are always returned: "http.method", "http.scheme",
394+
// "http.flavor", "net.host.name". The following attributes are
395+
// returned if they related values are defined in req: "net.host.port".
396+
func (c *httpConv) ServerRequestMetrics(server string, req *http.Request) []attribute.KeyValue {
397+
// TODO: This currently does not add the specification required
398+
// `http.target` attribute. It has too high of a cardinality to safely be
399+
// added. An alternate should be added, or this comment removed, when it is
400+
// addressed by the specification. If it is ultimately decided to continue
401+
// not including the attribute, the HTTPTargetKey field of the httpConv
402+
// should be removed as well.
403+
404+
n := 4 // Method, scheme, proto, and host name.
405+
var host string
406+
var p int
407+
if server == "" {
408+
host, p = splitHostPort(req.Host)
409+
} else {
410+
// Prioritize the primary server name.
411+
host, p = splitHostPort(server)
412+
if p < 0 {
413+
_, p = splitHostPort(req.Host)
414+
}
415+
}
416+
hostPort := requiredHTTPPort(req.TLS != nil, p)
417+
if hostPort > 0 {
418+
n++
419+
}
420+
attrs := make([]attribute.KeyValue, 0, n)
421+
422+
attrs = append(attrs, c.methodMetric(req.Method))
423+
attrs = append(attrs, c.scheme(req.TLS != nil))
424+
attrs = append(attrs, c.flavor(req.Proto))
425+
attrs = append(attrs, c.NetConv.HostName(host))
426+
427+
if hostPort > 0 {
428+
attrs = append(attrs, c.NetConv.HostPort(hostPort))
429+
}
430+
431+
return attrs
432+
}
433+
352434
func (c *httpConv) method(method string) attribute.KeyValue {
353435
if method == "" {
354436
return c.HTTPMethodKey.String(http.MethodGet)
355437
}
356438
return c.HTTPMethodKey.String(method)
357439
}
358440

441+
func (c *httpConv) methodMetric(method string) attribute.KeyValue {
442+
method = strings.ToUpper(method)
443+
switch method {
444+
case http.MethodConnect, http.MethodDelete, http.MethodGet, http.MethodHead, http.MethodOptions, http.MethodPatch, http.MethodPost, http.MethodPut, http.MethodTrace:
445+
default:
446+
method = "_OTHER"
447+
}
448+
return c.HTTPMethodKey.String(method)
449+
}
450+
359451
func (c *httpConv) scheme(https bool) attribute.KeyValue { // nolint:revive
360452
if https {
361453
return c.HTTPSchemeHTTPS
362454
}
363455
return c.HTTPSchemeHTTP
364456
}
365457

366-
func (c *httpConv) proto(proto string) attribute.KeyValue {
458+
func (c *httpConv) flavor(proto string) attribute.KeyValue {
367459
switch proto {
368460
case "HTTP/1.0":
369461
return c.HTTPFlavorKey.String("1.0")

‎instrumentation/github.com/gin-gonic/gin/otelgin/internal/semconvutil/httpconv_test.go‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,38 @@ func TestHTTPServerRequest(t *testing.T) {
165165
HTTPServerRequest("", req))
166166
}
167167

168+
func TestHTTPServerRequestMetrics(t *testing.T) {
169+
got := make(chan *http.Request, 1)
170+
handler := func(w http.ResponseWriter, r *http.Request) {
171+
got <- r
172+
w.WriteHeader(http.StatusOK)
173+
}
174+
175+
srv := httptest.NewServer(http.HandlerFunc(handler))
176+
defer srv.Close()
177+
178+
srvURL, err := url.Parse(srv.URL)
179+
require.NoError(t, err)
180+
srvPort, err := strconv.ParseInt(srvURL.Port(), 10, 32)
181+
require.NoError(t, err)
182+
183+
resp, err := srv.Client().Get(srv.URL)
184+
require.NoError(t, err)
185+
require.NoError(t, resp.Body.Close())
186+
187+
req := <-got
188+
189+
assert.ElementsMatch(t,
190+
[]attribute.KeyValue{
191+
attribute.String("http.method", "GET"),
192+
attribute.String("http.scheme", "http"),
193+
attribute.String("http.flavor", "1.1"),
194+
attribute.String("net.host.name", srvURL.Hostname()),
195+
attribute.Int("net.host.port", int(srvPort)),
196+
},
197+
HTTPServerRequestMetrics("", req))
198+
}
199+
168200
func TestHTTPServerName(t *testing.T) {
169201
req := new(http.Request)
170202
var got []attribute.KeyValue
@@ -223,7 +255,7 @@ func TestHTTPProto(t *testing.T) {
223255

224256
for proto, want := range tests {
225257
expect := attribute.String("http.flavor", want)
226-
assert.Equal(t, expect, hc.proto(proto), proto)
258+
assert.Equal(t, expect, hc.flavor(proto), proto)
227259
}
228260
}
229261

0 commit comments

Comments
 (0)