Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

fix(server): anchor log+telemetry file-sinks on projectDir (PRD-6936) (#1654)

mike-inkeep8baaf074307f
diff --git a/.changeset/local-sinks-anchor-on-projectdir.md b/.changeset/local-sinks-anchor-on-projectdir.md
new file mode 100644
index 000000000..63c349398
--- /dev/null
+++ b/.changeset/local-sinks-anchor-on-projectdir.md
@@ -0,0 +1,6 @@
+---
+"@inkeep/open-knowledge-server": patch
+"@inkeep/open-knowledge": patch
+---
+
+Fix the log and telemetry file-sinks writing into a second `.ok/` when `content.dir` is a sub-folder. Both per-machine sinks (`.ok/local/logs/server-current.jsonl`, `.ok/local/telemetry/spans-current.jsonl`) now anchor on the project root like `server.lock` / `principal.json` / `state.json`, so a project with e.g. `content.dir: docs` keeps a single `.ok/` at the root instead of growing a second one buried inside the content sub-folder where backups, git, sync, and visual inspection wouldn't expect it. `ok diagnose bundle` reads the sinks and `server.lock` from the same project-root-anchored `.ok/local/` so it keeps harvesting them after the move.
diff --git a/README.md b/README.md
index f6d68b88b..fa8fc1cfb 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ This public repository is mirrored from Inkeep's internal monorepo with Copybara
Public pull requests are welcome. When a public PR opens here, automation mirrors it into the internal monorepo for review and merge. After the internal PR lands, Copybara syncs the accepted change back to this repository.
-See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full contribution flow, including the [Contributor License Agreement](./CLA.md), and [AGENTS.md](./AGENTS.md) for agent-facing development guidance.
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full contribution flow and [AGENTS.md](./AGENTS.md) for agent-facing development guidance.
## Prerequisites
diff --git a/packages/cli/src/diagnose/bundle.test.ts b/packages/cli/src/diagnose/bundle.test.ts
index 23d06ff4c..66c91a865 100644
--- a/packages/cli/src/diagnose/bundle.test.ts
+++ b/packages/cli/src/diagnose/bundle.test.ts
@@ -84,6 +84,49 @@ describe('collectBundle — file inventory', () => {
collected.cleanup();
});
+ test('harvests sink + lock from projectDir, not the content sub-folder', async () => {
+ const projectDir = makeTmpDir();
+ const contentDir = join(projectDir, 'docs');
+ mkdirSync(contentDir, { recursive: true });
+
+ const realSpans = '{"resourceSpans":[]}\n';
+ writeAt(projectDir, '.ok/local/telemetry/spans-current.jsonl', realSpans);
+ writeAt(projectDir, '.ok/local/logs/server-current.jsonl', '{"level":30,"msg":"x"}\n');
+ writeAt(projectDir, '.ok/local/server.lock', JSON.stringify({ port: 6111 }));
+ writeAt(contentDir, '.ok/local/telemetry/spans-current.jsonl', '{"resourceSpans":["DECOY"]}\n');
+
+ const collected = await collectBundle({
+ contentDir,
+ projectDir,
+ deps: makeDeterministicDeps(),
+ });
+
+ const paths = collected.manifest.files.map((f) => f.path);
+ expect(paths).toContain('telemetry/spans-current.jsonl');
+ expect(paths).toContain('logs/server-current.jsonl');
+ expect(paths).toContain('state/server.lock');
+ const staged = readFileSync(
+ join(collected.stagingDir, 'telemetry', 'spans-current.jsonl'),
+ 'utf-8',
+ );
+ expect(staged).toBe(realSpans);
+ expect(staged).not.toContain('DECOY');
+ collected.cleanup();
+ });
+
+ test('defaults to contentDir as the project root when projectDir is omitted', async () => {
+ const contentDir = makeTmpDir();
+ writeAt(contentDir, '.ok/local/telemetry/spans-current.jsonl', '{"resourceSpans":[]}\n');
+ writeAt(contentDir, '.ok/local/server.lock', JSON.stringify({ port: 6222 }));
+
+ const collected = await collectBundle({ contentDir, deps: makeDeterministicDeps() });
+
+ const paths = collected.manifest.files.map((f) => f.path);
+ expect(paths).toContain('telemetry/spans-current.jsonl');
+ expect(paths).toContain('state/server.lock');
+ collected.cleanup();
+ });
+
test('lists both spans-current.jsonl and spans-prev.jsonl when both exist', async () => {
const contentDir = makeTmpDir();
writeAt(contentDir, '.ok/local/telemetry/spans-current.jsonl', '{"resourceSpans":[]}\n');
diff --git a/packages/cli/src/diagnose/bundle.ts b/packages/cli/src/diagnose/bundle.ts
index 96e62c99c..22aadd20d 100644
--- a/packages/cli/src/diagnose/bundle.ts
+++ b/packages/cli/src/diagnose/bundle.ts
@@ -124,20 +124,20 @@ const SPANS_PREVIOUS = 'spans-prev.jsonl';
const LOGS_CURRENT = 'server-current.jsonl';
const LOGS_PREVIOUS = 'server-prev.jsonl';
-function spansCurrentPath(contentDir: string): string {
- return join(contentDir, ...TELEMETRY_REL, SPANS_CURRENT);
+function spansCurrentPath(projectDir: string): string {
+ return join(projectDir, ...TELEMETRY_REL, SPANS_CURRENT);
}
-function spansPreviousPath(contentDir: string): string {
- return join(contentDir, ...TELEMETRY_REL, SPANS_PREVIOUS);
+function spansPreviousPath(projectDir: string): string {
+ return join(projectDir, ...TELEMETRY_REL, SPANS_PREVIOUS);
}
-function logsCurrentPath(contentDir: string): string {
- return join(contentDir, ...LOGS_REL, LOGS_CURRENT);
+function logsCurrentPath(projectDir: string): string {
+ return join(projectDir, ...LOGS_REL, LOGS_CURRENT);
}
-function logsPreviousPath(contentDir: string): string {
- return join(contentDir, ...LOGS_REL, LOGS_PREVIOUS);
+function logsPreviousPath(projectDir: string): string {
+ return join(projectDir, ...LOGS_REL, LOGS_PREVIOUS);
}
export const _pathHelpersForTests = {
@@ -323,6 +323,7 @@ function relativeZipPath(stagingDir: string, absPath: string): string {
export async function collectBundle(opts: CollectBundleOpts): Promise<CollectedBundle> {
const contentDir = resolve(opts.contentDir);
+ const projectDir = resolve(opts.projectDir ?? opts.contentDir);
const deps = opts.deps ?? {};
const fetchAgentPresence = deps.fetchAgentPresence ?? defaultFetchAgentPresence;
const readShadowHead = deps.readShadowHead ?? defaultReadShadowHead;
@@ -337,12 +338,12 @@ export async function collectBundle(opts: CollectBundleOpts): Promise<CollectedB
mkdirSync(join(stagingDir, 'logs'), { recursive: true });
mkdirSync(join(stagingDir, 'state'), { recursive: true });
- stageFileIfPresent(spansCurrentPath(contentDir), join(stagingDir, 'telemetry', SPANS_CURRENT));
- stageFileIfPresent(spansPreviousPath(contentDir), join(stagingDir, 'telemetry', SPANS_PREVIOUS));
- stageFileIfPresent(logsCurrentPath(contentDir), join(stagingDir, 'logs', LOGS_CURRENT));
- stageFileIfPresent(logsPreviousPath(contentDir), join(stagingDir, 'logs', LOGS_PREVIOUS));
+ stageFileIfPresent(spansCurrentPath(projectDir), join(stagingDir, 'telemetry', SPANS_CURRENT));
+ stageFileIfPresent(spansPreviousPath(projectDir), join(stagingDir, 'telemetry', SPANS_PREVIOUS));
+ stageFileIfPresent(logsCurrentPath(projectDir), join(stagingDir, 'logs', LOGS_CURRENT));
+ stageFileIfPresent(logsPreviousPath(projectDir), join(stagingDir, 'logs', LOGS_PREVIOUS));
- const lockDir = join(contentDir, '.ok', 'local');
+ const lockDir = join(projectDir, '.ok', 'local');
const lockPath = join(lockDir, 'server.lock');
let serverStatus: BundleServerStatus = 'not-running';
let serverStatusReason = 'no server.lock';
@@ -415,7 +416,7 @@ export async function collectBundle(opts: CollectBundleOpts): Promise<CollectedB
redactionResult = redactStagedBundle({ stagingDir, contentDir });
}
- const localSink = resolveLocalSinkBlock(opts.projectDir ?? contentDir);
+ const localSink = resolveLocalSinkBlock(projectDir);
const stagedFiles = walkStagedFiles(stagingDir);
const files: BundleFileEntry[] = [];
let totalBytes = 0;
diff --git a/packages/server/src/boot.ts b/packages/server/src/boot.ts
index 077c27193..b931eeb7d 100644
--- a/packages/server/src/boot.ts
+++ b/packages/server/src/boot.ts
@@ -152,7 +152,6 @@ const PINO_REDACT_MAX_DEPTH = 5;
export async function bootServer(opts: BootServerOptions): Promise<BootedServer> {
const localSinkConfig = resolveLocalSinkConfig({
projectDir: opts.projectDir ?? opts.contentDir,
- contentDir: opts.contentDir,
});
if (localSinkConfig) {
const denylist = localSinkConfig.telemetry.attributeDenylist;
diff --git a/packages/server/src/local-sink-resolver.test.ts b/packages/server/src/local-sink-resolver.test.ts
index c1c0eb12c..300eb4b0c 100644
--- a/packages/server/src/local-sink-resolver.test.ts
+++ b/packages/server/src/local-sink-resolver.test.ts
@@ -29,13 +29,10 @@ describe('resolveLocalSinkConfig', () => {
}
it('returns the default sink config when no config files set anything', () => {
- const resolved = resolveLocalSinkConfig({
- projectDir,
- contentDir: projectDir,
- });
+ const resolved = resolveLocalSinkConfig({ projectDir });
expect(resolved).not.toBeNull();
if (resolved === null) throw new Error('expected non-null sink');
- expect(resolved.telemetry.contentDir).toBe(projectDir);
+ expect(resolved.telemetry.projectDir).toBe(projectDir);
expect(resolved.telemetry.spansMaxBytes).toBe(52_428_800);
expect(resolved.logs.maxBytes).toBe(26_214_400);
expect(resolved.telemetry.attributeDenylist).toContain('authorization');
@@ -44,29 +41,29 @@ describe('resolveLocalSinkConfig', () => {
it('returns null when OK_DISABLE_LOCAL_SINK=1 — test-only opt-out', () => {
process.env.OK_DISABLE_LOCAL_SINK = '1';
- expect(resolveLocalSinkConfig({ projectDir, contentDir: projectDir })).toBeNull();
+ expect(resolveLocalSinkConfig({ projectDir })).toBeNull();
});
it('returns null when OK_DISABLE_LOCAL_SINK=true', () => {
process.env.OK_DISABLE_LOCAL_SINK = 'true';
- expect(resolveLocalSinkConfig({ projectDir, contentDir: projectDir })).toBeNull();
+ expect(resolveLocalSinkConfig({ projectDir })).toBeNull();
});
it('returns null when project config sets telemetry.localSink.enabled: false', () => {
seedProject({ telemetry: { localSink: { enabled: false } } });
- expect(resolveLocalSinkConfig({ projectDir, contentDir: projectDir })).toBeNull();
+ expect(resolveLocalSinkConfig({ projectDir })).toBeNull();
});
it('returns null when project-local config sets enabled: false (project-local wins)', () => {
seedProject({ telemetry: { localSink: { enabled: true } } });
seedProjectLocal({ telemetry: { localSink: { enabled: false } } });
- expect(resolveLocalSinkConfig({ projectDir, contentDir: projectDir })).toBeNull();
+ expect(resolveLocalSinkConfig({ projectDir })).toBeNull();
});
it('returns the sink when project disables but project-local re-enables (project-local wins)', () => {
seedProject({ telemetry: { localSink: { enabled: false } } });
seedProjectLocal({ telemetry: { localSink: { enabled: true } } });
- const resolved = resolveLocalSinkConfig({ projectDir, contentDir: projectDir });
+ const resolved = resolveLocalSinkConfig({ projectDir });
expect(resolved).not.toBeNull();
});
@@ -77,7 +74,7 @@ describe('resolveLocalSinkConfig', () => {
seedProjectLocal({
telemetry: { localSink: { spans: { maxBytes: 7 } } },
});
- const resolved = resolveLocalSinkConfig({ projectDir, contentDir: projectDir });
+ const resolved = resolveLocalSinkConfig({ projectDir });
expect(resolved).not.toBeNull();
if (resolved === null) throw new Error('expected non-null sink');
expect(resolved.telemetry.spansMaxBytes).toBe(7);
@@ -90,7 +87,7 @@ describe('resolveLocalSinkConfig', () => {
seedProjectLocal({
telemetry: { localSink: { logs: { maxBytes: 17 } } },
});
- const resolved = resolveLocalSinkConfig({ projectDir, contentDir: projectDir });
+ const resolved = resolveLocalSinkConfig({ projectDir });
expect(resolved).not.toBeNull();
if (resolved === null) throw new Error('expected non-null sink');
expect(resolved.logs.maxBytes).toBe(17);
@@ -103,7 +100,7 @@ describe('resolveLocalSinkConfig', () => {
seedProjectLocal({
telemetry: { localSink: { attributeDenylist: ['local-only'] } },
});
- const resolved = resolveLocalSinkConfig({ projectDir, contentDir: projectDir });
+ const resolved = resolveLocalSinkConfig({ projectDir });
expect(resolved).not.toBeNull();
if (resolved === null) throw new Error('expected non-null sink');
expect(resolved.telemetry.attributeDenylist).toEqual(['local-only']);
@@ -119,23 +116,18 @@ describe('resolveLocalSinkConfig', () => {
},
});
seedProjectLocal({});
- const resolved = resolveLocalSinkConfig({ projectDir, contentDir: projectDir });
+ const resolved = resolveLocalSinkConfig({ projectDir });
expect(resolved).not.toBeNull();
if (resolved === null) throw new Error('expected non-null sink');
expect(resolved.telemetry.spansMaxBytes).toBe(555);
expect(resolved.logs.maxBytes).toBe(222);
});
- it('returns the resolved contentDir (not projectDir) in the sink configs', () => {
- const contentDir = mkdtempSync(join(tmpdir(), 'ok-local-sink-content-'));
- try {
- const resolved = resolveLocalSinkConfig({ projectDir, contentDir });
- expect(resolved).not.toBeNull();
- if (resolved === null) throw new Error('expected non-null sink');
- expect(resolved.telemetry.contentDir).toBe(contentDir);
- expect(resolved.logs.contentDir).toBe(contentDir);
- } finally {
- rmSync(contentDir, { recursive: true, force: true });
- }
+ it('anchors both sink configs on projectDir (not content.dir)', () => {
+ const resolved = resolveLocalSinkConfig({ projectDir });
+ expect(resolved).not.toBeNull();
+ if (resolved === null) throw new Error('expected non-null sink');
+ expect(resolved.telemetry.projectDir).toBe(projectDir);
+ expect(resolved.logs.projectDir).toBe(projectDir);
});
});
diff --git a/packages/server/src/local-sink-resolver.ts b/packages/server/src/local-sink-resolver.ts
index 1359e59b0..9046d904c 100644
--- a/packages/server/src/local-sink-resolver.ts
+++ b/packages/server/src/local-sink-resolver.ts
@@ -9,17 +9,16 @@ import { parse as parseYaml } from 'yaml';
export interface ResolveLocalSinkArgs {
projectDir: string;
- contentDir: string;
}
export interface ResolvedLocalSink {
telemetry: {
- contentDir: string;
+ projectDir: string;
spansMaxBytes: number;
attributeDenylist: readonly string[];
};
logs: {
- contentDir: string;
+ projectDir: string;
maxBytes: number;
};
}
@@ -102,12 +101,12 @@ export function resolveLocalSinkConfig(args: ResolveLocalSinkArgs): ResolvedLoca
return {
telemetry: {
- contentDir: args.contentDir,
+ projectDir: args.projectDir,
spansMaxBytes,
attributeDenylist,
},
logs: {
- contentDir: args.contentDir,
+ projectDir: args.projectDir,
maxBytes: logsMaxBytes,
},
};
diff --git a/packages/server/src/logger.test.ts b/packages/server/src/logger.test.ts
index a6a98b4c6..fcf4e73b3 100644
--- a/packages/server/src/logger.test.ts
+++ b/packages/server/src/logger.test.ts
@@ -149,7 +149,7 @@ describe('Logger', () => {
it('writes Pino JSON records to the file destination', async () => {
const logger = new PinoLogger('test', {
options: { level: 'info' },
- fileSink: { contentDir: tmp, maxBytes: 1_000_000 },
+ fileSink: { projectDir: tmp, maxBytes: 1_000_000 },
});
const filePath = logsCurrentPath(tmp);
expect(existsSync(filePath)).toBe(false);
@@ -170,7 +170,7 @@ describe('Logger', () => {
it('creates parent directory lazily on first record', async () => {
const logger = new PinoLogger('test', {
options: { level: 'info' },
- fileSink: { contentDir: tmp, maxBytes: 1_000_000 },
+ fileSink: { projectDir: tmp, maxBytes: 1_000_000 },
});
const logsDir = join(tmp, '.ok', 'local', 'logs');
expect(existsSync(logsDir)).toBe(false);
@@ -185,7 +185,7 @@ describe('Logger', () => {
it('rotates current → prev once file size exceeds maxBytes', async () => {
const logger = new PinoLogger('test', {
options: { level: 'info' },
- fileSink: { contentDir: tmp, maxBytes: 80 },
+ fileSink: { projectDir: tmp, maxBytes: 80 },
});
const currentPath = logsCurrentPath(tmp);
const previousPath = logsPreviousPath(tmp);
@@ -234,7 +234,7 @@ describe('Logger', () => {
const tracer = provider.getTracer('logger-trace-test');
const logger = new PinoLogger('test', {
options: { level: 'info' },
- fileSink: { contentDir: tmp, maxBytes: 1_000_000 },
+ fileSink: { projectDir: tmp, maxBytes: 1_000_000 },
});
const span = tracer.startSpan('parent-span');
@@ -272,7 +272,7 @@ describe('Logger', () => {
it('the file sink rebuilds cleanly across updateOptions / addTransport churn', async () => {
const logger = new PinoLogger('test', {
options: { level: 'info' },
- fileSink: { contentDir: tmp, maxBytes: 1_000_000 },
+ fileSink: { projectDir: tmp, maxBytes: 1_000_000 },
});
logger.info({}, 'first');
await logger.flushFileSink();
@@ -287,7 +287,7 @@ describe('Logger', () => {
it('size cap reads the appender threshold; one above-cap write rotates', async () => {
const logger = new PinoLogger('test', {
options: { level: 'info' },
- fileSink: { contentDir: tmp, maxBytes: 50 },
+ fileSink: { projectDir: tmp, maxBytes: 50 },
});
const currentPath = logsCurrentPath(tmp);
const previousPath = logsPreviousPath(tmp);
@@ -305,7 +305,7 @@ describe('Logger', () => {
loggerFactory.configure({
pinoConfig: {
options: { level: 'info' },
- fileSink: { contentDir: tmp, maxBytes: 1_000_000 },
+ fileSink: { projectDir: tmp, maxBytes: 1_000_000 },
},
});
const a = loggerFactory.getLogger('a');
@@ -337,7 +337,7 @@ describe('Logger', () => {
it('credential-shaped log fields are masked before reaching the file sink', async () => {
const logger = new PinoLogger('cred-test', {
options: { level: 'info' },
- fileSink: { contentDir: tmp, maxBytes: 1_000_000 },
+ fileSink: { projectDir: tmp, maxBytes: 1_000_000 },
redactPaths: [
'authorization',
'*.authorization',
@@ -382,7 +382,7 @@ describe('Logger', () => {
}
const logger = new PinoLogger('deep-cred-test', {
options: { level: 'info' },
- fileSink: { contentDir: tmp, maxBytes: 1_000_000 },
+ fileSink: { projectDir: tmp, maxBytes: 1_000_000 },
redactPaths,
});
logger.info({ authorization: 'TOP-LEVEL-AUTH' }, 'top');
diff --git a/packages/server/src/telemetry-file-sink.test.ts b/packages/server/src/telemetry-file-sink.test.ts
index 87041fc36..fa35c6823 100644
--- a/packages/server/src/telemetry-file-sink.test.ts
+++ b/packages/server/src/telemetry-file-sink.test.ts
@@ -62,7 +62,7 @@ function firstSpanName(envelope: ResourceSpansEnvelope): string {
describe('FileSpanExporter', () => {
test('first export creates spans-current.jsonl lazily with one ResourceSpans JSON line per batch', async () => {
- const exporter = new FileSpanExporter({ contentDir: tmp, maxBytes: 1_000_000 });
+ const exporter = new FileSpanExporter({ projectDir: tmp, maxBytes: 1_000_000 });
const currentPath = spansCurrentPath(tmp);
expect(existsSync(currentPath)).toBe(false);
@@ -83,7 +83,7 @@ describe('FileSpanExporter', () => {
});
test('multiple batches each land as their own JSON line', async () => {
- const exporter = new FileSpanExporter({ contentDir: tmp, maxBytes: 1_000_000 });
+ const exporter = new FileSpanExporter({ projectDir: tmp, maxBytes: 1_000_000 });
const provider = makeProvider(exporter);
const tracer = provider.getTracer('test');
@@ -102,7 +102,7 @@ describe('FileSpanExporter', () => {
});
test('parent directory is created lazily on first export', async () => {
- const exporter = new FileSpanExporter({ contentDir: tmp, maxBytes: 1_000_000 });
+ const exporter = new FileSpanExporter({ projectDir: tmp, maxBytes: 1_000_000 });
const telemetryDir = join(tmp, '.ok', 'local', 'telemetry');
expect(existsSync(telemetryDir)).toBe(false);
@@ -117,7 +117,7 @@ describe('FileSpanExporter', () => {
});
test('rotates current → prev once size exceeds maxBytes', async () => {
- const exporter = new FileSpanExporter({ contentDir: tmp, maxBytes: 50 });
+ const exporter = new FileSpanExporter({ projectDir: tmp, maxBytes: 50 });
const provider = makeProvider(exporter);
const tracer = provider.getTracer('test');
const currentPath = spansCurrentPath(tmp);
@@ -150,7 +150,7 @@ describe('FileSpanExporter', () => {
test('keeps current under threshold across multiple appends before rotating', async () => {
const cap = 2_000;
- const exporter = new FileSpanExporter({ contentDir: tmp, maxBytes: cap });
+ const exporter = new FileSpanExporter({ projectDir: tmp, maxBytes: cap });
const provider = makeProvider(exporter);
const tracer = provider.getTracer('test');
const currentPath = spansCurrentPath(tmp);
@@ -179,7 +179,7 @@ describe('FileSpanExporter', () => {
});
test('appends cleanly even when the existing file has a partial trailing line', async () => {
- const exporter = new FileSpanExporter({ contentDir: tmp, maxBytes: 1_000_000 });
+ const exporter = new FileSpanExporter({ projectDir: tmp, maxBytes: 1_000_000 });
const currentPath = spansCurrentPath(tmp);
await new Promise<void>((resolve, reject) => {
const provider = makeProvider(exporter);
@@ -191,7 +191,7 @@ describe('FileSpanExporter', () => {
});
writeFileSync(currentPath, 'NOT-JSON-AT-ALL', { flag: 'a' });
- const exporter2 = new FileSpanExporter({ contentDir: tmp, maxBytes: 1_000_000 });
+ const exporter2 = new FileSpanExporter({ projectDir: tmp, maxBytes: 1_000_000 });
const provider2 = makeProvider(exporter2);
provider2.getTracer('test').startSpan('after-partial').end();
await provider2.forceFlush();
@@ -214,7 +214,7 @@ describe('FileSpanExporter', () => {
});
test('shutdown drains in-flight writes; further export() is rejected', async () => {
- const exporter = new FileSpanExporter({ contentDir: tmp, maxBytes: 1_000_000 });
+ const exporter = new FileSpanExporter({ projectDir: tmp, maxBytes: 1_000_000 });
const provider = makeProvider(exporter);
provider.getTracer('test').startSpan('pre-shutdown').end();
await provider.forceFlush();
@@ -238,7 +238,7 @@ describe('FileSpanExporter', () => {
});
test('forceFlush waits for in-flight writes to settle', async () => {
- const exporter = new FileSpanExporter({ contentDir: tmp, maxBytes: 1_000_000 });
+ const exporter = new FileSpanExporter({ projectDir: tmp, maxBytes: 1_000_000 });
const provider = makeProvider(exporter);
const tracer = provider.getTracer('test');
tracer.startSpan('to-flush').end();
@@ -495,7 +495,7 @@ describe('ScrubbingSpanProcessor', () => {
});
test('integrated with FileSpanExporter: denylisted values never reach the JSONL', async () => {
- const exporter = new FileSpanExporter({ contentDir: tmp, maxBytes: 1_000_000 });
+ const exporter = new FileSpanExporter({ projectDir: tmp, maxBytes: 1_000_000 });
const proc = new ScrubbingSpanProcessor({
attributeDenylist: ['authorization'],
maxValueBytes: 16,
@@ -612,7 +612,7 @@ describe('ScrubbingSpanProcessor', () => {
});
test('integrated with FileSpanExporter: event + link credentials never reach the JSONL', async () => {
- const exporter = new FileSpanExporter({ contentDir: tmp, maxBytes: 1_000_000 });
+ const exporter = new FileSpanExporter({ projectDir: tmp, maxBytes: 1_000_000 });
const proc = new ScrubbingSpanProcessor({
attributeDenylist: ['authorization'],
maxValueBytes: 16,
diff --git a/packages/server/src/telemetry-file-sink.ts b/packages/server/src/telemetry-file-sink.ts
index 0314dbd61..dfdcfb226 100644
--- a/packages/server/src/telemetry-file-sink.ts
+++ b/packages/server/src/telemetry-file-sink.ts
@@ -62,7 +62,7 @@ export class RotatingAppender {
}
export interface FileSpanExporterOpts {
- contentDir: string;
+ projectDir: string;
maxBytes: number;
}
@@ -70,12 +70,12 @@ const TELEMETRY_SUBDIR = ['.ok', 'local', 'telemetry'] as const;
const CURRENT_FILENAME = 'spans-current.jsonl';
const PREVIOUS_FILENAME = 'spans-prev.jsonl';
-export function spansCurrentPath(contentDir: string): string {
- return join(contentDir, ...TELEMETRY_SUBDIR, CURRENT_FILENAME);
+export function spansCurrentPath(projectDir: string): string {
+ return join(projectDir, ...TELEMETRY_SUBDIR, CURRENT_FILENAME);
}
-export function spansPreviousPath(contentDir: string): string {
- return join(contentDir, ...TELEMETRY_SUBDIR, PREVIOUS_FILENAME);
+export function spansPreviousPath(projectDir: string): string {
+ return join(projectDir, ...TELEMETRY_SUBDIR, PREVIOUS_FILENAME);
}
export class FileSpanExporter implements SpanExporter {
@@ -84,8 +84,8 @@ export class FileSpanExporter implements SpanExporter {
constructor(opts: FileSpanExporterOpts) {
this.#appender = new RotatingAppender({
- currentPath: spansCurrentPath(opts.contentDir),
- previousPath: spansPreviousPath(opts.contentDir),
+ currentPath: spansCurrentPath(opts.projectDir),
+ previousPath: spansPreviousPath(opts.projectDir),
maxBytes: opts.maxBytes,
});
}
@@ -219,16 +219,16 @@ const LOGS_SUBDIR = ['.ok', 'local', 'logs'] as const;
const LOGS_CURRENT_FILENAME = 'server-current.jsonl';
const LOGS_PREVIOUS_FILENAME = 'server-prev.jsonl';
-export function logsCurrentPath(contentDir: string): string {
- return join(contentDir, ...LOGS_SUBDIR, LOGS_CURRENT_FILENAME);
+export function logsCurrentPath(projectDir: string): string {
+ return join(projectDir, ...LOGS_SUBDIR, LOGS_CURRENT_FILENAME);
}
-export function logsPreviousPath(contentDir: string): string {
- return join(contentDir, ...LOGS_SUBDIR, LOGS_PREVIOUS_FILENAME);
+export function logsPreviousPath(projectDir: string): string {
+ return join(projectDir, ...LOGS_SUBDIR, LOGS_PREVIOUS_FILENAME);
}
export interface PinoFileSinkOpts {
- contentDir: string;
+ projectDir: string;
maxBytes: number;
}
@@ -238,8 +238,8 @@ export class PinoFileSink extends Writable {
constructor(opts: PinoFileSinkOpts) {
super({ decodeStrings: false });
this.#appender = new RotatingAppender({
- currentPath: logsCurrentPath(opts.contentDir),
- previousPath: logsPreviousPath(opts.contentDir),
+ currentPath: logsCurrentPath(opts.projectDir),
+ previousPath: logsPreviousPath(opts.projectDir),
maxBytes: opts.maxBytes,
});
}
diff --git a/packages/server/src/telemetry.test.ts b/packages/server/src/telemetry.test.ts
index b1df476d5..89dd15bc6 100644
--- a/packages/server/src/telemetry.test.ts
+++ b/packages/server/src/telemetry.test.ts
@@ -19,9 +19,9 @@ import { spansCurrentPath } from './telemetry-file-sink.ts';
const DEFAULT_DENYLIST = ['authorization', 'cookie'] as const;
-function makeLocalSinkOpts(contentDir: string): LocalSinkOptions {
+function makeLocalSinkOpts(projectDir: string): LocalSinkOptions {
return {
- contentDir,
+ projectDir,
spansMaxBytes: 1_048_576,
attributeDenylist: DEFAULT_DENYLIST,
};
diff --git a/packages/server/src/telemetry.ts b/packages/server/src/telemetry.ts
index 2a80de2d2..3f6f5e143 100644
--- a/packages/server/src/telemetry.ts
+++ b/packages/server/src/telemetry.ts
@@ -31,7 +31,7 @@ function noopResult(): { tracer: Tracer; meter: Meter } {
}
export interface LocalSinkOptions {
- contentDir: string;
+ projectDir: string;
spansMaxBytes: number;
attributeDenylist: readonly string[];
}
@@ -67,7 +67,7 @@ export function initTelemetry(opts: InitTelemetryOptions = {}): { tracer: Tracer
spanProcessors.push(new ScrubbingSpanProcessor({ attributeDenylist }));
if (fileSinkEnabled && opts.localSink !== undefined) {
fileSpanExporter = new FileSpanExporter({
- contentDir: opts.localSink.contentDir,
+ projectDir: opts.localSink.projectDir,
maxBytes: opts.localSink.spansMaxBytes,
});
spanProcessors.push(new SimpleSpanProcessor(fileSpanExporter));