-
Notifications
You must be signed in to change notification settings - Fork 33
Expand file tree
/
Copy pathotel.ts
More file actions
203 lines (194 loc) · 8.17 KB
/
Copy pathotel.ts
File metadata and controls
203 lines (194 loc) · 8.17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
import { logs } from "@opentelemetry/api-logs"
import { metrics, trace } from "@opentelemetry/api"
import { LoggerProvider, BatchLogRecordProcessor } from "@opentelemetry/sdk-logs"
import { MeterProvider, PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics"
import { BasicTracerProvider, BatchSpanProcessor } from "@opentelemetry/sdk-trace-base"
import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc"
import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-grpc"
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc"
import { OTLPLogExporter as OTLPHttpLogExporter } from "@opentelemetry/exporter-logs-otlp-http"
import { OTLPMetricExporter as OTLPHttpMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http"
import { OTLPTraceExporter as OTLPHttpTraceExporter } from "@opentelemetry/exporter-trace-otlp-http"
import { resourceFromAttributes } from "@opentelemetry/resources"
import { ATTR_SERVICE_NAME } from "@opentelemetry/semantic-conventions"
import { ATTR_HOST_ARCH } from "@opentelemetry/semantic-conventions/incubating"
import type { Instruments } from "./types.ts"
import {
createGrpcMetadata,
DynamicHeaders,
parseOtlpHeaders,
RefreshingLogExporter,
RefreshingMetricExporter,
RefreshingSpanExporter,
type HeadersMap,
} from "./headers.ts"
/**
* Builds an OTel `Resource` seeded with `service.name`, `app.version`, `os.type`, and
* `host.arch`. When `endUserId` is provided, `enduser.id` is seeded too. Additional
* attributes from `OTEL_RESOURCE_ATTRIBUTES` are merged in last and may override the
* defaults (including `enduser.id`).
*/
export function buildResource(version: string, endUserId?: string) {
const attrs: Record<string, string> = {
[ATTR_SERVICE_NAME]: "opencode",
"app.version": version,
"os.type": process.platform,
[ATTR_HOST_ARCH]: process.arch,
}
if (endUserId) attrs["enduser.id"] = endUserId
const raw = process.env["OTEL_RESOURCE_ATTRIBUTES"]
if (raw) {
for (const pair of raw.split(",")) {
const idx = pair.indexOf("=")
if (idx > 0) {
const key = pair.slice(0, idx).trim()
const val = pair.slice(idx + 1).trim()
if (key) attrs[key] = val
}
}
}
return resourceFromAttributes(attrs)
}
/** Handles returned by `setupOtel`, used for graceful shutdown. */
export type OtelProviders = {
meterProvider: MeterProvider
loggerProvider: LoggerProvider
tracerProvider: BasicTracerProvider
}
export function buildHttpSignalUrl(endpoint: string, signal: "traces" | "metrics" | "logs") {
const url = new URL(endpoint)
const normalizedPath = url.pathname.endsWith("/") ? url.pathname.slice(0, -1) : url.pathname
url.pathname = `${normalizedPath}/v1/${signal}`
return url.toString()
}
/**
* Initialises the OTel SDK — creates a `MeterProvider`, `LoggerProvider`, and
* `BasicTracerProvider` backed by OTLP exporters (gRPC or HTTP/protobuf)
* pointed at `endpoint`, and registers them as the global providers.
*/
export async function setupOtel(
endpoint: string,
protocol: "grpc" | "http/protobuf",
metricsInterval: number,
logsInterval: number,
version: string,
otlpHeaders?: string,
otlpHeadersHelper?: string,
endUserId?: string,
): Promise<OtelProviders> {
const resource = buildResource(version, endUserId)
const staticHeaders = parseOtlpHeaders(otlpHeaders)
const dynamicHeaders = new DynamicHeaders(staticHeaders, otlpHeadersHelper)
if (otlpHeadersHelper) {
try {
await dynamicHeaders.refresh()
} catch (error) {
console.warn("[opencode-plugin-otel] Failed to prewarm OTLP headers helper. Falling back to refresh-on-auth-failure.", error)
}
}
const makeMetricExporter = (headers: HeadersMap) => protocol === "http/protobuf"
? new OTLPHttpMetricExporter({ url: buildHttpSignalUrl(endpoint, "metrics"), headers })
: new OTLPMetricExporter({ url: endpoint, metadata: createGrpcMetadata(headers) })
const makeLogExporter = (headers: HeadersMap) => protocol === "http/protobuf"
? new OTLPHttpLogExporter({ url: buildHttpSignalUrl(endpoint, "logs"), headers })
: new OTLPLogExporter({ url: endpoint, metadata: createGrpcMetadata(headers) })
const makeTraceExporter = (headers: HeadersMap) => protocol === "http/protobuf"
? new OTLPHttpTraceExporter({ url: buildHttpSignalUrl(endpoint, "traces"), headers })
: new OTLPTraceExporter({ url: endpoint, metadata: createGrpcMetadata(headers) })
const metricExporter = otlpHeadersHelper
? new RefreshingMetricExporter(makeMetricExporter, dynamicHeaders)
: makeMetricExporter(staticHeaders)
const logExporter = otlpHeadersHelper
? new RefreshingLogExporter(makeLogExporter, dynamicHeaders)
: makeLogExporter(staticHeaders)
const traceExporter = otlpHeadersHelper
? new RefreshingSpanExporter(makeTraceExporter, dynamicHeaders)
: makeTraceExporter(staticHeaders)
const meterProvider = new MeterProvider({
resource,
readers: [
new PeriodicExportingMetricReader({
exporter: metricExporter,
exportIntervalMillis: metricsInterval,
}),
],
})
metrics.setGlobalMeterProvider(meterProvider)
const loggerProvider = new LoggerProvider({
resource,
processors: [
new BatchLogRecordProcessor(logExporter, {
scheduledDelayMillis: logsInterval,
}),
],
})
logs.setGlobalLoggerProvider(loggerProvider)
const tracerProvider = new BasicTracerProvider({
resource,
spanProcessors: [new BatchSpanProcessor(traceExporter)],
})
trace.setGlobalTracerProvider(tracerProvider)
return { meterProvider, loggerProvider, tracerProvider }
}
/** Creates all metric instruments using the global `MeterProvider`. Metric names are prefixed with `prefix`. */
export function createInstruments(prefix: string): Instruments {
const meter = metrics.getMeter("com.opencode")
return {
sessionCounter: meter.createCounter(`${prefix}session.count`, {
unit: "{session}",
description: "Count of opencode sessions started",
}),
tokenCounter: meter.createCounter(`${prefix}token.usage`, {
unit: "tokens",
description: "Number of tokens used",
}),
costCounter: meter.createCounter(`${prefix}cost.usage`, {
unit: "USD",
description: "Cost of the opencode session in USD",
}),
linesCounter: meter.createCounter(`${prefix}lines_of_code.count`, {
unit: "{line}",
description: "Count of lines of code added or removed",
}),
commitCounter: meter.createCounter(`${prefix}commit.count`, {
unit: "{commit}",
description: "Number of git commits created",
}),
toolDurationHistogram: meter.createHistogram(`${prefix}tool.duration`, {
unit: "ms",
description: "Duration of tool executions in milliseconds",
}),
cacheCounter: meter.createCounter(`${prefix}cache.count`, {
unit: "{request}",
description: "Token cache activity (cacheRead/cacheCreation) per completed assistant message",
}),
sessionDurationHistogram: meter.createHistogram(`${prefix}session.duration`, {
unit: "ms",
description: "Duration of a session from created to idle in milliseconds",
}),
messageCounter: meter.createCounter(`${prefix}message.count`, {
unit: "{message}",
description: "Number of completed assistant messages per session",
}),
sessionTokenGauge: meter.createHistogram(`${prefix}session.token.total`, {
unit: "tokens",
description: "Total tokens consumed per session, recorded as a histogram on session idle",
}),
sessionCostGauge: meter.createHistogram(`${prefix}session.cost.total`, {
unit: "USD",
description: "Total cost per session in USD, recorded as a histogram on session idle",
}),
modelUsageCounter: meter.createCounter(`${prefix}model.usage`, {
unit: "{request}",
description: "Number of completed assistant messages per model and provider",
}),
retryCounter: meter.createCounter(`${prefix}retry.count`, {
unit: "{retry}",
description: "Number of API retries observed via session.status events",
}),
subtaskCounter: meter.createCounter(`${prefix}subtask.count`, {
unit: "{subtask}",
description: "Number of sub-agent invocations observed via subtask message parts",
}),
}
}