RequestLogConfig

Defined in: packages/gateway/src/policies/observability/request-log.ts:11

Configuration for the requestLog policy.

Extends

• PolicyConfig

Properties

extractFields?

optional extractFields?: (c) => Record<string, unknown>

Defined in: packages/gateway/src/policies/observability/request-log.ts:13

Additional fields to extract from the request

Parameters

c

unknown

Returns

Record<string, unknown>

---

ipHeaders?

optional ipHeaders?: string[]

Defined in: packages/gateway/src/policies/observability/request-log.ts:17

Ordered list of headers to inspect for the client IP. Default: ["cf-connecting-ip", "x-forwarded-for"].

---

logRequestBody?

optional logRequestBody?: boolean

Defined in: packages/gateway/src/policies/observability/request-log.ts:19

Log request body (opt-in). Default: false.

---

logResponseBody?

optional logResponseBody?: boolean

Defined in: packages/gateway/src/policies/observability/request-log.ts:21

Log response body (opt-in). Default: false.

---

maxBodyLength?

optional maxBodyLength?: number

Defined in: packages/gateway/src/policies/observability/request-log.ts:23

Maximum body size in bytes to capture. Default: 8192.

---

redactPaths?

optional redactPaths?: string[]

Defined in: packages/gateway/src/policies/observability/request-log.ts:25

JSON field paths to redact from logged bodies (e.g., ["password", "*.secret"]).

---

sink?

optional sink?: (entry) => void | Promise<void>

Defined in: packages/gateway/src/policies/observability/request-log.ts:15

Custom log sink - defaults to console.log with structured JSON

Parameters

entry

LogEntry

Returns

void | Promise<void>

---

skip?

optional skip?: (c) => boolean | Promise<boolean>

Defined in: packages/gateway/src/policies/types.ts:90

Skip this policy when condition returns true

Parameters

c

unknown

Returns

boolean | Promise<boolean>

Inherited from

PolicyConfig.skip