Skip to content

Add configurable tool telemetry redaction #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dasmfm wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add configurable tool telemetry redaction #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,33 @@ export LANGFUSE_USER_ID="your-user-id"

If both `LANGFUSE_PUBLIC_KEY` and `LANGFUSE_SECRET_KEY` are set, the plugin uses environment variables instead of reading the config file. Optional values can be supplied either way.

## Redacting tool data

Add `redaction` to `~/.config/opencode/opencode-langfuse.json` (also when credentials come from environment variables):

```json
{
"publicKey": "pk-lf-...",
"secretKey": "sk-lf-...",
"redaction": {
"tools": [
{ "name": "read", "path": "**/.env*", "input": "redact" },
{
"name": "read",
"path": "**/.env.example",
"input": "as-is",
"output": "as-is"
},
{ "name": "bash", "output": "redact" }
]
}
}
```

Rules match the tool name exactly (or `*` for every tool). An optional `path` glob matches the tool input's `filePath`, `path`, or `filename` (with `*` matching within a directory and `**` across directories). The last matching rule wins for each path; when multiple path arguments are present, a redaction on any of them wins. `input` and `output` accept `"as-is"` or `"redact"`; a matching rule defaults to sending the input as-is and replacing the output with `"[REDACTED]"`. Without a matching rule, data is sent as-is. Redaction covers tool observations and tool results copied into later generation inputs in both OpenCode versions. To hide the file path or other tool arguments too, set `"input": "redact"`.

These rules do not redact text that the user or assistant independently includes in messages or reasoning. If a tool call's path is unavailable (including results without their calls), any potentially matching path rule redacts its input and/or output. If the file cannot be read or parsed, tracing stops rather than silently ignoring potentially configured redaction rules. Restart OpenCode after changing the file.

## Contributing

See the [contributing guide](./CONTRIBUTING.md).
Expand Down
102 changes: 86 additions & 16 deletions src/langfuse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,32 @@ import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import { Context as EffectContext, Effect } from "effect";

import { PLUGIN_VERSION } from "./version.js";
import { TelemetryRedaction, type RedactionConfig } from "./redaction.js";

export class LangfuseClient {
readonly baseUrl: string;
readonly forceFlush: Effect.Effect<void, unknown>;
private readonly traceState: LangfuseTraceState;
private readonly redaction: TelemetryRedaction;

constructor(input: {
baseUrl: string;
traceState: LangfuseTraceState;
forceFlush: Effect.Effect<void, unknown>;
redaction?: RedactionConfig;
}) {
this.baseUrl = input.baseUrl;
this.traceState = input.traceState;
this.forceFlush = input.forceFlush;
this.redaction = new TelemetryRedaction(input.redaction);
}

private serialize(value: unknown, sessionID?: string) {
return JSON.stringify(this.redaction.sanitize(value, sessionID));
}

clearTraceState() {
this.redaction.clear();
this.traceState.assistantParts.clear();
this.traceState.abortedSessions.clear();
this.traceState.tracedEventIds.clear();
Expand All @@ -50,6 +59,7 @@ export class LangfuseClient {
}

clearSessionTraceState(sessionID: string) {
this.redaction.clearSession(sessionID);
const sessionMessageIds = new Set<string>();

for (const [messageID, parts] of this.traceState.assistantParts) {
Expand Down Expand Up @@ -236,11 +246,24 @@ export class LangfuseClient {
"session.id": input.sessionID,
...(input.input === undefined
? {}
: { "langfuse.observation.input": JSON.stringify(input.input) }),
: {
"langfuse.observation.input": this.serialize(
input.input,
input.sessionID,
),
}),
...(input.output === undefined
? {}
: { "langfuse.observation.output": JSON.stringify(input.output) }),
"langfuse.observation.metadata": JSON.stringify(input.metadata),
: {
"langfuse.observation.output": this.serialize(
input.output,
input.sessionID,
),
}),
"langfuse.observation.metadata": this.serialize(
input.metadata,
input.sessionID,
),
},
startTime: new Date(input.timestamp),
});
Expand Down Expand Up @@ -443,7 +466,10 @@ export class LangfuseClient {
"langfuse.observation.model.name": input.model.id,
...(generationInput
? {
"langfuse.observation.input": JSON.stringify(generationInput),
"langfuse.observation.input": this.serialize(
generationInput,
input.sessionID,
),
}
: {}),
"langfuse.observation.metadata": JSON.stringify({
Expand Down Expand Up @@ -573,7 +599,10 @@ export class LangfuseClient {
"langfuse.observation.type": "agent",
"langfuse.internal.is_app_root": !parentSpan,
"session.id": input.sessionID,
"langfuse.observation.input": JSON.stringify([formattedMessage]),
"langfuse.observation.input": this.serialize(
[formattedMessage],
input.sessionID,
),
"langfuse.observation.metadata": JSON.stringify({
messageID: input.messageID,
agent: input.agent,
Expand Down Expand Up @@ -613,7 +642,10 @@ export class LangfuseClient {
attributes: {
"langfuse.observation.type": "event",
"session.id": input.sessionID,
"langfuse.observation.input": JSON.stringify([formattedMessage]),
"langfuse.observation.input": this.serialize(
[formattedMessage],
input.sessionID,
),
"langfuse.observation.metadata": JSON.stringify({
messageID: input.messageID,
agent: input.agent,
Expand Down Expand Up @@ -660,6 +692,12 @@ export class LangfuseClient {
tool: string;
args: Record<string, unknown>;
}) {
this.redaction.register(
input.callID,
input.tool,
input.args,
input.sessionID,
);
this.traceState.toolMessageIdsByCallId.set(input.callID, input.messageID);

const parts =
Expand Down Expand Up @@ -714,7 +752,7 @@ export class LangfuseClient {
if (input.mode !== "compaction") {
turn?.span.setAttribute(
"langfuse.observation.output",
JSON.stringify(output),
this.serialize(output, input.sessionID),
);
}
const activeStep = this.traceState.activeGenerationSteps.get(
Expand All @@ -731,7 +769,7 @@ export class LangfuseClient {
step.span.setAttribute("langfuse.observation.model.name", input.modelID);
step.span.setAttribute(
"langfuse.observation.output",
JSON.stringify(output),
this.serialize(output, input.sessionID),
);
step.span.setAttribute(
"langfuse.observation.usage_details",
Expand Down Expand Up @@ -795,10 +833,16 @@ export class LangfuseClient {
"langfuse.observation.model.name": input.modelID,
...(generationInput
? {
"langfuse.observation.input": JSON.stringify(generationInput),
"langfuse.observation.input": this.serialize(
generationInput,
input.sessionID,
),
}
: {}),
"langfuse.observation.output": JSON.stringify(output),
"langfuse.observation.output": this.serialize(
output,
input.sessionID,
),
"langfuse.observation.usage_details": JSON.stringify({
input: input.tokens.input,
output: input.tokens.output,
Expand Down Expand Up @@ -976,6 +1020,13 @@ export class LangfuseClient {
return;
}

this.redaction.register(
input.callID,
input.tool,
input.args,
input.sessionID,
);

this.ensureGenerationParent(input.sessionID);

this.withObservationParent(
Expand All @@ -985,7 +1036,10 @@ export class LangfuseClient {
attributes: {
"langfuse.observation.type": "tool",
"session.id": input.sessionID,
"langfuse.observation.input": JSON.stringify(input.args),
"langfuse.observation.input": this.serialize(
this.redaction.toolInput(input.tool, input.args),
input.sessionID,
),
"langfuse.observation.metadata": JSON.stringify({
callID: input.callID,
tool: input.tool,
Expand Down Expand Up @@ -1041,7 +1095,13 @@ export class LangfuseClient {

span.setAttribute(
"langfuse.observation.output",
JSON.stringify({ title: input.title, output: input.output }),
this.serialize(
{
title: this.redaction.toolOutput(input.callID, input.title),
output: this.redaction.toolOutput(input.callID, input.output),
},
input.sessionID,
),
);
span.setAttribute(
"langfuse.observation.metadata",
Expand Down Expand Up @@ -1106,13 +1166,18 @@ export class LangfuseClient {

span.setAttribute(
"langfuse.observation.output",
JSON.stringify({ error: input.error }),
this.serialize(
{ error: this.redaction.toolOutput(input.callID, input.error) },
observation.sessionID,
),
);
span.setStatus({
code: SpanStatusCode.ERROR,
message: input.error,
message: String(this.redaction.toolOutput(input.callID, input.error)),
});
span.recordException({
message: String(this.redaction.toolOutput(input.callID, input.error)),
});
span.recordException({ message: input.error });
span.end(new Date(input.completed));
this.rememberToolResult({
sessionID: observation.sessionID,
Expand Down Expand Up @@ -1146,7 +1211,10 @@ export class LangfuseClient {
"session.id": sessionID,
...(generationInput
? {
"langfuse.observation.input": JSON.stringify(generationInput),
"langfuse.observation.input": this.serialize(
generationInput,
sessionID,
),
}
: {}),
},
Expand Down Expand Up @@ -1733,6 +1801,7 @@ export const createLangfuseClient = (input: {
userId?: string;
serviceName?: string;
opencodeVersion?: string;
redaction?: RedactionConfig;
}) =>
Effect.gen(function* () {
const tracerName = "opencode-langfuse-plugin";
Expand Down Expand Up @@ -1802,5 +1871,6 @@ export const createLangfuseClient = (input: {
baseUrl: input.baseUrl,
traceState,
forceFlush: Effect.tryPromise(() => processor.forceFlush()),
redaction: input.redaction,
});
});
Loading