2021-08-25 10:47:16 +02:00
|
|
|
import { randomBytes } from 'crypto'
|
|
|
|
import { traceGlobals } from '../shared'
|
|
|
|
import fs from 'fs'
|
|
|
|
import path from 'path'
|
2021-10-05 12:52:45 +02:00
|
|
|
import { PHASE_DEVELOPMENT_SERVER } from '../../shared/lib/constants'
|
2021-08-25 10:47:16 +02:00
|
|
|
|
2021-11-22 20:58:49 +01:00
|
|
|
const localEndpoint = {
|
|
|
|
serviceName: 'nextjs',
|
|
|
|
ipv4: '127.0.0.1',
|
|
|
|
port: 9411,
|
|
|
|
}
|
|
|
|
|
|
|
|
type Event = {
|
|
|
|
traceId: string
|
2022-01-02 22:22:01 +01:00
|
|
|
parentId?: number
|
2021-11-22 20:58:49 +01:00
|
|
|
name: string
|
2022-01-02 22:22:01 +01:00
|
|
|
id: number
|
2021-11-22 20:58:49 +01:00
|
|
|
timestamp: number
|
|
|
|
duration: number
|
|
|
|
localEndpoint?: typeof localEndpoint
|
|
|
|
tags?: Object
|
2022-03-08 17:15:09 +01:00
|
|
|
startTime?: number
|
2021-11-22 20:58:49 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Batch events as zipkin allows for multiple events to be sent in one go
|
|
|
|
export function batcher(reportEvents: (evts: Event[]) => Promise<void>) {
|
|
|
|
const events: Event[] = []
|
|
|
|
// Promise queue to ensure events are always sent on flushAll
|
|
|
|
const queue = new Set()
|
|
|
|
return {
|
|
|
|
flushAll: async () => {
|
|
|
|
await Promise.all(queue)
|
|
|
|
if (events.length > 0) {
|
|
|
|
await reportEvents(events)
|
|
|
|
events.length = 0
|
|
|
|
}
|
|
|
|
},
|
|
|
|
report: (event: Event) => {
|
|
|
|
events.push(event)
|
|
|
|
|
|
|
|
if (events.length > 100) {
|
|
|
|
const evts = events.slice()
|
|
|
|
events.length = 0
|
|
|
|
const report = reportEvents(evts)
|
|
|
|
queue.add(report)
|
|
|
|
report.then(() => queue.delete(report))
|
|
|
|
}
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-10-05 12:52:45 +02:00
|
|
|
let writeStream: RotatingWriteStream
|
2021-08-25 10:47:16 +02:00
|
|
|
let traceId: string
|
|
|
|
let batch: ReturnType<typeof batcher> | undefined
|
|
|
|
|
2021-10-05 12:52:45 +02:00
|
|
|
const writeStreamOptions = {
|
|
|
|
flags: 'a',
|
|
|
|
encoding: 'utf8',
|
|
|
|
}
|
|
|
|
class RotatingWriteStream {
|
|
|
|
file: string
|
|
|
|
writeStream!: fs.WriteStream
|
|
|
|
size: number
|
|
|
|
sizeLimit: number
|
2021-10-13 18:29:52 +02:00
|
|
|
private rotatePromise: Promise<void> | undefined
|
|
|
|
private drainPromise: Promise<void> | undefined
|
2021-10-05 12:52:45 +02:00
|
|
|
constructor(file: string, sizeLimit: number) {
|
|
|
|
this.file = file
|
|
|
|
this.size = 0
|
|
|
|
this.sizeLimit = sizeLimit
|
|
|
|
this.createWriteStream()
|
|
|
|
}
|
|
|
|
private createWriteStream() {
|
|
|
|
this.writeStream = fs.createWriteStream(this.file, writeStreamOptions)
|
|
|
|
}
|
|
|
|
// Recreate the file
|
2021-10-13 18:29:52 +02:00
|
|
|
private async rotate() {
|
|
|
|
await this.end()
|
2021-10-05 12:52:45 +02:00
|
|
|
try {
|
|
|
|
fs.unlinkSync(this.file)
|
|
|
|
} catch (err: any) {
|
|
|
|
// It's fine if the file does not exist yet
|
|
|
|
if (err.code !== 'ENOENT') {
|
|
|
|
throw err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
this.size = 0
|
|
|
|
this.createWriteStream()
|
2021-10-13 18:29:52 +02:00
|
|
|
this.rotatePromise = undefined
|
2021-10-05 12:52:45 +02:00
|
|
|
}
|
|
|
|
async write(data: string): Promise<void> {
|
2021-10-13 18:29:52 +02:00
|
|
|
if (this.rotatePromise) await this.rotatePromise
|
2021-10-05 12:52:45 +02:00
|
|
|
|
2021-10-13 18:29:52 +02:00
|
|
|
this.size += data.length
|
2021-10-05 12:52:45 +02:00
|
|
|
if (this.size > this.sizeLimit) {
|
2021-10-13 18:29:52 +02:00
|
|
|
await (this.rotatePromise = this.rotate())
|
2021-10-05 12:52:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!this.writeStream.write(data, 'utf8')) {
|
2021-10-13 18:29:52 +02:00
|
|
|
if (this.drainPromise === undefined) {
|
|
|
|
this.drainPromise = new Promise<void>((resolve, _reject) => {
|
|
|
|
this.writeStream.once('drain', () => {
|
|
|
|
this.drainPromise = undefined
|
|
|
|
resolve()
|
|
|
|
})
|
|
|
|
})
|
|
|
|
}
|
|
|
|
await this.drainPromise
|
2021-10-05 12:52:45 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-10-13 18:29:52 +02:00
|
|
|
end(): Promise<void> {
|
|
|
|
return new Promise((resolve) => {
|
|
|
|
this.writeStream.end(resolve)
|
|
|
|
})
|
2021-10-05 12:52:45 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-08-25 10:47:16 +02:00
|
|
|
const reportToLocalHost = (
|
|
|
|
name: string,
|
|
|
|
duration: number,
|
|
|
|
timestamp: number,
|
2022-01-02 22:22:01 +01:00
|
|
|
id: number,
|
|
|
|
parentId?: number,
|
2022-03-08 17:15:09 +01:00
|
|
|
attrs?: Object,
|
|
|
|
startTime?: number
|
2021-08-25 10:47:16 +02:00
|
|
|
) => {
|
|
|
|
const distDir = traceGlobals.get('distDir')
|
2021-10-05 12:52:45 +02:00
|
|
|
const phase = traceGlobals.get('phase')
|
|
|
|
if (!distDir || !phase) {
|
2021-08-25 10:47:16 +02:00
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!traceId) {
|
|
|
|
traceId = process.env.TRACE_ID || randomBytes(8).toString('hex')
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!batch) {
|
|
|
|
batch = batcher(async (events) => {
|
|
|
|
if (!writeStream) {
|
2021-09-02 13:28:51 +02:00
|
|
|
await fs.promises.mkdir(distDir, { recursive: true })
|
2021-08-25 10:47:16 +02:00
|
|
|
const file = path.join(distDir, 'trace')
|
2021-10-05 12:52:45 +02:00
|
|
|
writeStream = new RotatingWriteStream(
|
|
|
|
file,
|
|
|
|
// Development is limited to 50MB, production is unlimited
|
|
|
|
phase === PHASE_DEVELOPMENT_SERVER ? 52428800 : Infinity
|
|
|
|
)
|
2021-08-25 10:47:16 +02:00
|
|
|
}
|
|
|
|
const eventsJson = JSON.stringify(events)
|
|
|
|
try {
|
2021-10-05 12:52:45 +02:00
|
|
|
await writeStream.write(eventsJson + '\n')
|
2021-08-25 10:47:16 +02:00
|
|
|
} catch (err) {
|
|
|
|
console.log(err)
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
batch.report({
|
|
|
|
traceId,
|
|
|
|
parentId,
|
|
|
|
name,
|
|
|
|
id,
|
|
|
|
timestamp,
|
|
|
|
duration,
|
|
|
|
tags: attrs,
|
2022-03-08 17:15:09 +01:00
|
|
|
startTime,
|
2021-08-25 10:47:16 +02:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
export default {
|
|
|
|
flushAll: () =>
|
|
|
|
batch
|
|
|
|
? batch.flushAll().then(() => {
|
2021-10-05 12:52:45 +02:00
|
|
|
const phase = traceGlobals.get('phase')
|
|
|
|
// Only end writeStream when manually flushing in production
|
|
|
|
if (phase !== PHASE_DEVELOPMENT_SERVER) {
|
|
|
|
writeStream.end()
|
|
|
|
}
|
2021-08-25 10:47:16 +02:00
|
|
|
})
|
|
|
|
: undefined,
|
|
|
|
report: reportToLocalHost,
|
|
|
|
}
|