Skip to content

Commit e56cd8f

Browse files
Add HttpClient tracer header filter (#6697)
Co-authored-by: Tim <[email protected]>
1 parent a959a8b commit e56cd8f

3 files changed

Lines changed: 124 additions & 0 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"effect": patch
3+
---
4+
5+
Add a configurable filter for HTTP client request and response header span attributes.

‎packages/effect/src/unstable/http/HttpClient.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -687,8 +687,10 @@ export const make = (
687687
span.attribute("url.query", query)
688688
}
689689
const redactedHeaderNames = fiber.getRef(Headers.CurrentRedactedNames)
690+
const headerFilter = fiber.getRef(TracerHeaderFilter)
690691
const redactedHeaders = Headers.redact(request.headers, redactedHeaderNames)
691692
for (const name in redactedHeaders) {
693+
if (!headerFilter(name, "request")) continue
692694
span.attribute(`http.request.header.${name}`, String(redactedHeaders[name]))
693695
}
694696
request = fiber.getRef(TracerPropagationEnabled)
@@ -702,6 +704,7 @@ export const make = (
702704
span.attribute("http.response.status_code", response.status)
703705
const redactedHeaders = Headers.redact(response.headers, redactedHeaderNames)
704706
for (const name in redactedHeaders) {
707+
if (!headerFilter(name, "response")) continue
705708
span.attribute(`http.response.header.${name}`, String(redactedHeaders[name]))
706709
}
707710

@@ -1508,6 +1511,18 @@ export const TracerDisabledWhen = Context.Reference<
15081511
defaultValue: () => constFalse
15091512
})
15101513

1514+
/**
1515+
* Context reference for filtering request and response headers added to client spans.
1516+
*
1517+
* @category references
1518+
* @since 4.0.0
1519+
*/
1520+
export const TracerHeaderFilter = Context.Reference<
1521+
(headerName: string, phase: "request" | "response") => boolean
1522+
>("effect/http/HttpClient/TracerHeaderFilter", {
1523+
defaultValue: () => constTrue
1524+
})
1525+
15111526
/**
15121527
* Context reference that controls whether outgoing client spans are propagated to request headers.
15131528
*

‎packages/effect/test/unstable/http/HttpClient.test.ts‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { assert, describe, it } from "@effect/vitest"
22
import { strictEqual } from "@effect/vitest/utils"
33
import { Clock, Duration, Effect, Fiber, Layer, Ref, Stream } from "effect"
44
import { TestClock } from "effect/testing"
5+
import * as Tracer from "effect/Tracer"
56
import { HttpClient, HttpClientRequest, HttpClientResponse } from "effect/unstable/http"
67
import { RateLimiter } from "effect/unstable/persistence"
78

@@ -37,6 +38,109 @@ const makeRedirectClient = Effect.fnUntraced(function*(status: number, location:
3738
const RateLimiterTestLayer = RateLimiter.layer.pipe(Layer.provide(RateLimiter.layerStoreMemory))
3839

3940
describe("HttpClient", () => {
41+
describe("tracer", () => {
42+
it.effect("includes request and response headers by default", () =>
43+
Effect.gen(function*() {
44+
let clientSpan: Tracer.NativeSpan | undefined
45+
const tracer = Tracer.make({
46+
span(options) {
47+
clientSpan = new Tracer.NativeSpan(options)
48+
return clientSpan
49+
}
50+
})
51+
const client = HttpClient.make((request) =>
52+
Effect.succeed(
53+
HttpClientResponse.fromWeb(
54+
request,
55+
new Response(null, {
56+
headers: { "x-response-default": "response" }
57+
})
58+
)
59+
)
60+
)
61+
62+
yield* client.get("http://test/", {
63+
headers: { "x-request-default": "request" }
64+
}).pipe(Effect.provideService(Tracer.Tracer, tracer))
65+
66+
assert(clientSpan !== undefined)
67+
assert.strictEqual(clientSpan.attributes.get("http.request.header.x-request-default"), "request")
68+
assert.strictEqual(clientSpan.attributes.get("http.response.header.x-response-default"), "response")
69+
}))
70+
71+
it.effect("filters request and response header span attributes", () =>
72+
Effect.gen(function*() {
73+
let clientSpan: Tracer.NativeSpan | undefined
74+
const tracer = Tracer.make({
75+
span(options) {
76+
clientSpan = new Tracer.NativeSpan(options)
77+
return clientSpan
78+
}
79+
})
80+
const client = HttpClient.make((request) =>
81+
Effect.succeed(
82+
HttpClientResponse.fromWeb(
83+
request,
84+
new Response(null, {
85+
headers: {
86+
"x-response-drop": "drop",
87+
"x-response-keep": "keep"
88+
}
89+
})
90+
)
91+
)
92+
)
93+
94+
yield* client.get("http://test/", {
95+
headers: {
96+
"x-request-drop": "drop",
97+
"x-request-keep": "keep"
98+
}
99+
}).pipe(
100+
Effect.provideService(HttpClient.TracerHeaderFilter, (name) => name.endsWith("-keep")),
101+
Effect.provideService(Tracer.Tracer, tracer)
102+
)
103+
104+
assert(clientSpan !== undefined)
105+
assert.strictEqual(clientSpan.attributes.get("http.request.header.x-request-drop"), undefined)
106+
assert.strictEqual(clientSpan.attributes.get("http.request.header.x-request-keep"), "keep")
107+
assert.strictEqual(clientSpan.attributes.get("http.response.header.x-response-drop"), undefined)
108+
assert.strictEqual(clientSpan.attributes.get("http.response.header.x-response-keep"), "keep")
109+
}))
110+
111+
it.effect("filters the same header name independently by phase", () =>
112+
Effect.gen(function*() {
113+
let clientSpan: Tracer.NativeSpan | undefined
114+
const tracer = Tracer.make({
115+
span(options) {
116+
clientSpan = new Tracer.NativeSpan(options)
117+
return clientSpan
118+
}
119+
})
120+
const client = HttpClient.make((request) =>
121+
Effect.succeed(
122+
HttpClientResponse.fromWeb(
123+
request,
124+
new Response(null, {
125+
headers: { "x-phase-filter": "response" }
126+
})
127+
)
128+
)
129+
)
130+
131+
yield* client.get("http://test/", {
132+
headers: { "x-phase-filter": "request" }
133+
}).pipe(
134+
Effect.provideService(HttpClient.TracerHeaderFilter, (_name, phase) => phase === "response"),
135+
Effect.provideService(Tracer.Tracer, tracer)
136+
)
137+
138+
assert(clientSpan !== undefined)
139+
assert.strictEqual(clientSpan.attributes.get("http.request.header.x-phase-filter"), undefined)
140+
assert.strictEqual(clientSpan.attributes.get("http.response.header.x-phase-filter"), "response")
141+
}))
142+
})
143+
40144
describe("followRedirects", () => {
41145
it.effect("preserves credential headers on same-origin redirects", () =>
42146
Effect.gen(function*() {

0 commit comments

Comments
 (0)