-
Notifications
You must be signed in to change notification settings - Fork 1
add application inspector tool #5
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.
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
HarshCasper
wants to merge
2
commits into
main
Choose a base branch
from
feature/add-eventstudio-tool
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
82 changes: 82 additions & 0 deletions
82
src/lib/application-inspector/application-inspector.client.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
import { ApplicationInspectorApiClient } from "./application-inspector.client"; | ||
|
||
jest.mock("../../core/http-client", () => { | ||
return { | ||
httpClient: { | ||
request: jest.fn(), | ||
}, | ||
HttpError: class HttpError extends Error { | ||
status: number; | ||
statusText: string; | ||
body: string; | ||
constructor(status: number, statusText: string, body: string, message: string) { | ||
super(message); | ||
this.status = status; | ||
this.statusText = statusText; | ||
this.body = body; | ||
} | ||
}, | ||
}; | ||
}); | ||
|
||
const { httpClient } = require("../../core/http-client"); | ||
|
||
describe("ApplicationInspectorApiClient", () => { | ||
beforeEach(() => { | ||
(httpClient.request as jest.Mock).mockReset(); | ||
}); | ||
|
||
test("getSpans constructs query params from filters including errors_only (maps to status_code=2)", async () => { | ||
const client = new ApplicationInspectorApiClient(); | ||
(httpClient.request as jest.Mock).mockResolvedValueOnce({ spans: [], next_token: null }); | ||
|
||
await client.getSpans({ | ||
limit: 50, | ||
pagination_token: "abc", | ||
service_name: "s3", | ||
operation_name: "PutObject", | ||
trace_id: "t1", | ||
errors_only: true, | ||
region: "us-east-1", | ||
}); | ||
|
||
expect(httpClient.request).toHaveBeenCalledTimes(1); | ||
const [url, options] = (httpClient.request as jest.Mock).mock.calls[0]; | ||
expect(String(url)).toContain("/_localstack/eventstudio/v1/spans?"); | ||
expect(String(url)).toContain("limit=50"); | ||
expect(String(url)).toContain("pagination_token=abc"); | ||
expect(String(url)).toContain("service_name=s3"); | ||
expect(String(url)).toContain("operation_name=PutObject"); | ||
expect(String(url)).toContain("trace_id=t1"); | ||
expect(String(url)).toContain("region=us-east-1"); | ||
// errors_only => status_code=2 | ||
expect(String(url)).toContain("status_code=2"); | ||
expect(options.method).toBe("GET"); | ||
}); | ||
|
||
test("clearEvents sends DELETE with body when spanIds provided", async () => { | ||
const client = new ApplicationInspectorApiClient(); | ||
(httpClient.request as jest.Mock).mockResolvedValueOnce({ deleted_count: 2 }); | ||
|
||
const res = await client.clearEvents(["a", "b"]); | ||
expect(res.deleted_count).toBe(2); | ||
|
||
expect(httpClient.request).toHaveBeenCalledTimes(1); | ||
const [url, options] = (httpClient.request as jest.Mock).mock.calls[0]; | ||
expect(url).toBe("/_localstack/eventstudio/v1/spans"); | ||
expect(options.method).toBe("DELETE"); | ||
expect(options.headers["Content-Type"]).toBe("application/json"); | ||
expect(JSON.parse(options.body)).toEqual({ span_ids: ["a", "b"] }); | ||
}); | ||
|
||
test("clearEvents sends DELETE without body when no spanIds provided", async () => { | ||
const client = new ApplicationInspectorApiClient(); | ||
(httpClient.request as jest.Mock).mockResolvedValueOnce({ deleted_count: 0 }); | ||
|
||
await client.clearEvents(); | ||
const [url, options] = (httpClient.request as jest.Mock).mock.calls[0]; | ||
expect(url).toBe("/_localstack/eventstudio/v1/spans"); | ||
expect(options.method).toBe("DELETE"); | ||
expect(options.body).toBeUndefined(); | ||
}); | ||
}); |
89 changes: 89 additions & 0 deletions
89
src/lib/application-inspector/application-inspector.client.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
import { httpClient, HttpError } from "../../core/http-client"; | ||
|
||
export interface InspectorEvent { | ||
event_id: string; | ||
name: string; | ||
timestamp_unix_nano: number; | ||
attributes: Record<string, any> | null; | ||
} | ||
|
||
export interface InspectorSpan { | ||
span_id: string; | ||
trace_id: string; | ||
parent_span_id: string | null; | ||
start_time_unix_nano: number; | ||
end_time_unix_nano: number; | ||
status_code: number; | ||
status_message: string | null; | ||
service_name: string; | ||
operation_name: string; | ||
is_write_operation: boolean; | ||
events: InspectorEvent[]; | ||
attributes: Record<string, any> | null; | ||
parent_span?: { service_name: string }; | ||
} | ||
|
||
export interface SpanPage { | ||
spans: InspectorSpan[]; | ||
next_token: string | null; | ||
} | ||
|
||
export interface SpanFilters { | ||
limit?: number; | ||
pagination_token?: string; | ||
service_name?: string; | ||
operation_name?: string; | ||
trace_id?: string; | ||
errors_only?: boolean; | ||
account_id?: string; | ||
region?: string; | ||
status_code?: number; | ||
parent_span_id?: string; | ||
span_id?: string; | ||
arn?: string; | ||
resource_name?: string; | ||
start_time_unix_nano?: number; | ||
end_time_unix_nano?: number; | ||
version?: number; | ||
} | ||
|
||
export class ApplicationInspectorApiClient { | ||
async getSpans(filters: SpanFilters = {}): Promise<SpanPage> { | ||
const queryParams = new URLSearchParams(); | ||
|
||
if (typeof filters.limit === "number") { | ||
queryParams.set("limit", String(filters.limit)); | ||
} | ||
|
||
for (const [key, value] of Object.entries(filters)) { | ||
if (value === undefined || value === null) continue; | ||
if (key === "errors_only") continue; | ||
if (key === "limit") continue; | ||
queryParams.set(key, String(value as any)); | ||
} | ||
|
||
if (filters.errors_only) { | ||
queryParams.set("status_code", "2"); | ||
} | ||
|
||
const qs = queryParams.toString(); | ||
const primary = `/_localstack/eventstudio/v1/spans?${qs}`; | ||
return httpClient.request<SpanPage>(primary, { method: "GET" }); | ||
} | ||
|
||
async clearEvents(spanIds?: string[]): Promise<{ deleted_count: number }> { | ||
const hasIds = Array.isArray(spanIds) && spanIds.length > 0; | ||
const options: RequestInit = hasIds | ||
? { | ||
method: "DELETE", | ||
headers: { "Content-Type": "application/json" }, | ||
body: JSON.stringify({ span_ids: spanIds }), | ||
} | ||
: { method: "DELETE" }; | ||
|
||
return httpClient.request<{ deleted_count: number }>( | ||
"/_localstack/eventstudio/v1/spans", | ||
options | ||
); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
import { formatTraceSummaryTable, formatDetailedTraceView } from "./inspector-reporter"; | ||
import { type SpanPage, type InspectorSpan } from "./application-inspector.client"; | ||
|
||
function ns(nowMs: number) { | ||
return nowMs * 1_000_000; | ||
} | ||
|
||
describe("Inspector Reporter", () => { | ||
const baseTimeMs = 1700000000000; | ||
|
||
const spanA: InspectorSpan = { | ||
span_id: "A", | ||
trace_id: "T1", | ||
parent_span_id: null, | ||
start_time_unix_nano: ns(baseTimeMs), | ||
end_time_unix_nano: ns(baseTimeMs + 120), | ||
status_code: 0, | ||
status_message: null, | ||
service_name: "apigateway", | ||
operation_name: "POST /users", | ||
is_write_operation: true, | ||
events: [ | ||
{ | ||
event_id: "E1", | ||
name: "http.request", | ||
timestamp_unix_nano: ns(baseTimeMs + 10), | ||
attributes: { path: "/users", method: "POST" }, | ||
}, | ||
], | ||
attributes: { http_status: 201 }, | ||
}; | ||
|
||
const spanB: InspectorSpan = { | ||
span_id: "B", | ||
trace_id: "T1", | ||
parent_span_id: "A", | ||
start_time_unix_nano: ns(baseTimeMs + 20), | ||
end_time_unix_nano: ns(baseTimeMs + 60), | ||
status_code: 0, | ||
status_message: null, | ||
service_name: "lambda", | ||
operation_name: "InvokeFunction", | ||
is_write_operation: false, | ||
events: [], | ||
attributes: null, | ||
parent_span: { service_name: "apigateway" }, | ||
}; | ||
|
||
const spanCError: InspectorSpan = { | ||
span_id: "C", | ||
trace_id: "T2", | ||
parent_span_id: null, | ||
start_time_unix_nano: ns(baseTimeMs + 5), | ||
end_time_unix_nano: ns(baseTimeMs + 8), | ||
status_code: 2, | ||
status_message: "Boom", | ||
service_name: "s3", | ||
operation_name: "PutObject", | ||
is_write_operation: true, | ||
events: [ | ||
{ | ||
event_id: "E2", | ||
name: "sdk.error", | ||
timestamp_unix_nano: ns(baseTimeMs + 7), | ||
attributes: { code: "AccessDenied" }, | ||
}, | ||
], | ||
attributes: null, | ||
}; | ||
|
||
test("formatTraceSummaryTable returns table with grouped traces and status", () => { | ||
const page: SpanPage = { | ||
spans: [spanA, spanB, spanCError], | ||
next_token: null, | ||
}; | ||
|
||
const table = formatTraceSummaryTable(page); | ||
expect(table).toContain( | ||
"| Trace Start Time | Root Operation | Services | Duration | Status | Trace ID |" | ||
); | ||
expect(table).toContain("apigateway:POST /users"); | ||
expect(table).toContain("lambda"); | ||
expect(table).toContain("T1"); | ||
expect(table).toContain("❌"); | ||
}); | ||
|
||
test("formatDetailedTraceView snapshot", () => { | ||
const view = formatDetailedTraceView([spanA, spanB]); | ||
expect(view).toMatchSnapshot(); | ||
}); | ||
}); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
import { type InspectorSpan, type SpanPage } from "./application-inspector.client"; | ||
|
||
function formatNsToMs(ns: number): string { | ||
const ms = ns / 1_000_000; | ||
return `${ms.toFixed(2)} ms`; | ||
} | ||
|
||
function formatUnixNanoToIso(ns: number): string { | ||
const ms = Math.floor(ns / 1_000_000); | ||
return new Date(ms).toISOString(); | ||
} | ||
|
||
export function formatTraceSummaryTable(spanPage: SpanPage): string { | ||
const spans = spanPage.spans || []; | ||
if (spans.length === 0) { | ||
return "No spans found."; | ||
} | ||
|
||
const byTrace = new Map<string, InspectorSpan[]>(); | ||
for (const s of spans) { | ||
const arr = byTrace.get(s.trace_id) || []; | ||
arr.push(s); | ||
byTrace.set(s.trace_id, arr); | ||
} | ||
|
||
const lines: string[] = []; | ||
lines.push("| Trace Start Time | Root Operation | Services | Duration | Status | Trace ID |"); | ||
lines.push("|---|---|---|---|---|---|"); | ||
|
||
for (const [traceId, tSpans] of byTrace.entries()) { | ||
let root = tSpans.find((s) => !s.parent_span_id) || tSpans[0]; | ||
|
||
let earliest = Number.POSITIVE_INFINITY; | ||
let latest = 0; | ||
let hasError = false; | ||
const services = new Set<string>(); | ||
|
||
for (const s of tSpans) { | ||
services.add(s.service_name); | ||
if (s.start_time_unix_nano < earliest) earliest = s.start_time_unix_nano; | ||
if (s.end_time_unix_nano > latest) latest = s.end_time_unix_nano; | ||
// OpenTelemetry status codes: 0=UNSET, 1=OK, 2=ERROR | ||
if (s.status_code === 2) hasError = true; | ||
} | ||
|
||
const startIso = formatUnixNanoToIso(root.start_time_unix_nano); | ||
const rootOp = `${root.service_name}:${root.operation_name}`; | ||
const duration = latest > earliest ? formatNsToMs(latest - earliest) : "0.00 ms"; | ||
const status = hasError ? "❌" : "✅"; | ||
const servicesList = Array.from(services).sort().join(", "); | ||
|
||
lines.push( | ||
`| ${startIso} | ${rootOp} | ${servicesList} | ${duration} | ${status} | ${traceId} |` | ||
); | ||
} | ||
|
||
return lines.join("\n"); | ||
} | ||
|
||
export function formatDetailedTraceView(traceSpans: InspectorSpan[]): string { | ||
if (!traceSpans || traceSpans.length === 0) return "No spans for this trace."; | ||
|
||
// Build index | ||
const nodeById = new Map<string, { span: InspectorSpan; children: InspectorSpan[] }>(); | ||
for (const s of traceSpans) { | ||
nodeById.set(s.span_id, { span: s, children: [] }); | ||
} | ||
const roots: InspectorSpan[] = []; | ||
for (const s of traceSpans) { | ||
if (s.parent_span_id && nodeById.has(s.parent_span_id)) { | ||
nodeById.get(s.parent_span_id)!.children.push(s); | ||
} else { | ||
roots.push(s); | ||
} | ||
} | ||
|
||
for (const node of nodeById.values()) { | ||
node.children.sort((a, b) => a.start_time_unix_nano - b.start_time_unix_nano); | ||
} | ||
roots.sort((a, b) => a.start_time_unix_nano - b.start_time_unix_nano); | ||
|
||
const lines: string[] = []; | ||
|
||
function renderSpan(span: InspectorSpan, indent: number) { | ||
const pad = " ".repeat(indent); | ||
const ok = span.status_code !== 2; | ||
const emoji = ok ? "✅" : "❌"; | ||
const durationNs = Math.max(0, span.end_time_unix_nano - span.start_time_unix_nano); | ||
const duration = formatNsToMs(durationNs); | ||
const op = `${span.service_name}:${span.operation_name}`; | ||
const parentInfo = span.parent_span?.service_name | ||
? ` (parent: ${span.parent_span.service_name})` | ||
: ""; | ||
|
||
lines.push(`${pad}- [${emoji} ${op}] - ${duration}${parentInfo}`); | ||
|
||
if (span.events && span.events.length > 0) { | ||
for (const ev of span.events) { | ||
const evPad = " ".repeat(indent + 1); | ||
const evTime = formatUnixNanoToIso(ev.timestamp_unix_nano); | ||
lines.push(`${evPad}- event: ${ev.name} @ ${evTime}`); | ||
if (ev.attributes && Object.keys(ev.attributes).length > 0) { | ||
const json = JSON.stringify(ev.attributes, null, 2); | ||
lines.push(`${evPad}\n${evPad}\u0060\u0060\u0060json`); | ||
for (const line of json.split("\n")) { | ||
lines.push(`${evPad}${line}`); | ||
} | ||
lines.push(`${evPad}\u0060\u0060\u0060`); | ||
} | ||
} | ||
} | ||
|
||
const children = nodeById.get(span.span_id)?.children || []; | ||
for (const child of children) { | ||
renderSpan(child, indent + 1); | ||
} | ||
} | ||
|
||
for (const r of roots) renderSpan(r, 0); | ||
|
||
return lines.join("\n"); | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this makes not so much sense, since spans are much more interesting to the llm and user - I would not define them as traces with trace start time but as spans - the table should hold spans, maybe grouped by trace_id - for now i would not group them but just sort them based on span start time