chore(rivetkit): clean up logging configuration

Author: NathanFlurry

rivetkit-typescript/packages/cloudflare-workers/tests/driver-tests.test.ts

@@ -207,8 +207,8 @@ async function setupProject(projectPath: string) {
 			LOG_LEVEL: "DEBUG",
 			LOG_TARGET: "1",
 			LOG_TIMESTAMP: "1",
-			_RIVETKIT_ERROR_STACK: "1",
-			_RIVETKIT_LOG_MESSAGE: "1",
+			LOG_ERROR_STACK: "1",
+			LOG_MESSAGE: "1",
 		},
 	};
 	await fs.writeFile(

rivetkit-typescript/packages/rivetkit/src/client/actor-conn.ts

@@ -16,6 +16,7 @@ import type {
 	UniversalEventSource,
 	UniversalMessageEvent,
 } from "@/common/eventsource-interface";
+import { isLogMessageEnabled } from "@/common/log-config";
 import { assertUnreachable, stringifyError } from "@/common/utils";
 import type { UniversalWebSocket } from "@/common/websocket-interface";
 import type { ManagerDriver } from "@/driver-helpers/mod";
@@ -39,7 +40,6 @@ import {
 } from "@/serde";
 import {
 	bufferToArrayBuffer,
-	getEnvUniversal,
 	httpUserAgent,
 	promiseWithResolvers,
 } from "@/utils";
@@ -418,7 +418,7 @@ enc
 
 		const response = await this.#parseMessage(data as ConnMessage);
 		logger().trace(
-			getEnvUniversal("_RIVETKIT_LOG_MESSAGE")
+			isLogMessageEnabled()
 				? {
 						msg: "parsed message",
 						message:

rivetkit-typescript/packages/rivetkit/src/common/log-config.ts

@@ -0,0 +1,55 @@
+import { getEnvUniversal } from "@/utils";
+
+/**
+ * Logging configuration functions.
+ *
+ * These functions provide access to logging-related environment variables.
+ */
+
+/**
+ * Get log level (e.g., "debug", "info", "warn", "error").
+ * Defaults to "warn" if not set.
+ */
+export function getLogLevelEnv(): string | undefined {
+	return getEnvUniversal("LOG_LEVEL");
+}
+
+/**
+ * Check if log target should be included in log output.
+ * Returns true when LOG_TARGET=1.
+ */
+export function isLogTargetEnabled(): boolean {
+	return getEnvUniversal("LOG_TARGET") === "1";
+}
+
+/**
+ * Check if timestamps should be included in log output.
+ * Returns true when LOG_TIMESTAMP=1.
+ */
+export function isLogTimestampEnabled(): boolean {
+	return getEnvUniversal("LOG_TIMESTAMP") === "1";
+}
+
+/**
+ * Check if detailed message logging is enabled for debugging.
+ * Returns true when LOG_MESSAGE=1.
+ */
+export function isLogMessageEnabled(): boolean {
+	return getEnvUniversal("LOG_MESSAGE") === "1";
+}
+
+/**
+ * Check if stack traces should be included in error stringification.
+ * Returns true when LOG_ERROR_STACK=1.
+ */
+export function isErrorStackEnabled(): boolean {
+	return getEnvUniversal("LOG_ERROR_STACK") === "1";
+}
+
+/**
+ * Check if HTTP headers should be logged.
+ * Returns true when LOG_HEADERS=1.
+ */
+export function isLogHeadersEnabled(): boolean {
+	return getEnvUniversal("LOG_HEADERS") === "1";
+}

rivetkit-typescript/packages/rivetkit/src/common/log.ts

@@ -5,13 +5,17 @@ import {
 	stdTimeFunctions,
 } from "pino";
 import { z } from "zod";
-import { getEnvUniversal } from "@/utils";
 import {
 	castToLogValue,
 	formatTimestamp,
 	LOGGER_CONFIG,
 	stringify,
 } from "./logfmt";
+import {
+	getLogLevelEnv,
+	isLogTargetEnabled,
+	isLogTimestampEnabled,
+} from "./log-config";
 
 export type { Logger } from "pino";
 
@@ -43,9 +47,7 @@ export function getPinoLevel(logLevel?: LogLevel): LevelWithSilent {
 		return configuredLogLevel;
 	}
 
-	const raw = (getEnvUniversal("LOG_LEVEL") || "warn")
-		.toString()
-		.toLowerCase();
+	const raw = (getLogLevelEnv() || "warn").toString().toLowerCase();
 
 	const parsed = LogLevelSchema.safeParse(raw);
 	if (parsed.success) {
@@ -57,7 +59,7 @@ export function getPinoLevel(logLevel?: LogLevel): LevelWithSilent {
 }
 
 export function getIncludeTarget(): boolean {
-	return getEnvUniversal("LOG_TARGET") === "1";
+	return isLogTargetEnabled();
 }
 
 /**
@@ -73,7 +75,7 @@ function customWrite(level: string, o: any) {
 	const entries: any = {};
 
 	// Add timestamp if enabled
-	if (getEnvUniversal("LOG_TIMESTAMP") === "1" && o.time) {
+	if (isLogTimestampEnabled() && o.time) {
 		const date = typeof o.time === "number" ? new Date(o.time) : new Date();
 		entries.ts = formatTimestamp(date);
 	}
@@ -131,10 +133,9 @@ export async function configureDefaultLogger(
 				return { level: number };
 			},
 		},
-		timestamp:
-			getEnvUniversal("LOG_TIMESTAMP") === "1"
-				? stdTimeFunctions.epochTime
-				: false,
+		timestamp: isLogTimestampEnabled()
+			? stdTimeFunctions.epochTime
+			: false,
 		browser: {
 			write: {
 				fatal: customWrite.bind(null, "fatal"),
@@ -158,10 +159,7 @@ export async function configureDefaultLogger(
 					60: "fatal",
 				};
 				const levelName = levelMap[level] || "info";
-				const time =
-					getEnvUniversal("LOG_TIMESTAMP") === "1"
-						? Date.now()
-						: undefined;
+				const time = isLogTimestampEnabled() ? Date.now() : undefined;
 
 				// Get bindings from the logger instance (child logger fields)
 				const bindings = (this as any).bindings?.() || {};

rivetkit-typescript/packages/rivetkit/src/common/router.ts

@@ -17,8 +17,9 @@ import {
 	HttpResponseErrorSchema,
 } from "@/schemas/client-protocol-zod/mod";
 import { encodingIsBinary, serializeWithEncoding } from "@/serde";
-import { bufferToArrayBuffer, getEnvUniversal, VERSION } from "@/utils";
+import { bufferToArrayBuffer, VERSION } from "@/utils";
 import { getLogger, type Logger } from "./log";
+import { isLogHeadersEnabled } from "./log-config";
 import { deconstructError, stringifyError } from "./utils";
 
 export function logger() {
@@ -43,7 +44,7 @@ export function loggerMiddleware(logger: Logger) {
 			reqSize: c.req.header("content-length"),
 			resSize: c.res.headers.get("content-length"),
 			userAgent: c.req.header("user-agent"),
-			...(getEnvUniversal("_RIVET_LOG_HEADERS")
+			...(isLogHeadersEnabled()
 				? { allHeaders: JSON.stringify(c.req.header()) }
 				: {}),
 		});

rivetkit-typescript/packages/rivetkit/src/common/utils.ts

@@ -1,7 +1,8 @@
 import type { Next } from "hono";
 import type { ContentfulStatusCode } from "hono/utils/http-status";
 import * as errors from "@/actor/errors";
-import { EXTRA_ERROR_LOG, getEnvUniversal, VERSION } from "@/utils";
+import { EXTRA_ERROR_LOG, VERSION } from "@/utils";
+import { isErrorStackEnabled } from "./log-config";
 import type { Logger } from "./log";
 
 export function assertUnreachable(x: never): never {
@@ -298,10 +299,7 @@ export function deconstructError(
 
 export function stringifyError(error: unknown): string {
 	if (error instanceof Error) {
-		if (
-			typeof process !== "undefined" &&
-			getEnvUniversal("_RIVETKIT_ERROR_STACK") === "1"
-		) {
+		if (typeof process !== "undefined" && isErrorStackEnabled()) {
 			return `${error.name}: ${error.message}${error.stack ? `\n${error.stack}` : ""}`;
 		} else {
 			return `${error.name}: ${error.message}`;

vitest.base.ts

@@ -14,8 +14,8 @@ export default {
 			LOG_LEVEL: "DEBUG",
 			LOG_TARGET: "1",
 			LOG_TIMESTAMP: "1",
-			_RIVETKIT_ERROR_STACK: "1",
-			_RIVETKIT_LOG_MESSAGE: "1",
+			LOG_ERROR_STACK: "1",
+			LOG_MESSAGE: "1",
 		},
 	},
 } satisfies ViteUserConfig;