@arizeai/phoenix-client 6.0.0 → 6.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/__generated__/api/v1.d.ts +131 -3
- package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
- package/dist/esm/sessions/getSession.d.ts +21 -0
- package/dist/esm/sessions/getSession.d.ts.map +1 -0
- package/dist/esm/sessions/getSession.js +29 -0
- package/dist/esm/sessions/getSession.js.map +1 -0
- package/dist/esm/sessions/index.d.ts +2 -0
- package/dist/esm/sessions/index.d.ts.map +1 -1
- package/dist/esm/sessions/index.js +2 -0
- package/dist/esm/sessions/index.js.map +1 -1
- package/dist/esm/sessions/listSessions.d.ts +22 -0
- package/dist/esm/sessions/listSessions.d.ts.map +1 -0
- package/dist/esm/sessions/listSessions.js +47 -0
- package/dist/esm/sessions/listSessions.js.map +1 -0
- package/dist/esm/sessions/sessionUtils.d.ts +9 -0
- package/dist/esm/sessions/sessionUtils.d.ts.map +1 -0
- package/dist/esm/sessions/sessionUtils.js +19 -0
- package/dist/esm/sessions/sessionUtils.js.map +1 -0
- package/dist/esm/spans/getSpanAnnotations.d.ts +2 -2
- package/dist/esm/spans/getSpanAnnotations.d.ts.map +1 -1
- package/dist/esm/spans/getSpanAnnotations.js +2 -1
- package/dist/esm/spans/getSpanAnnotations.js.map +1 -1
- package/dist/esm/spans/getSpans.d.ts +12 -3
- package/dist/esm/spans/getSpans.d.ts.map +1 -1
- package/dist/esm/spans/getSpans.js +13 -2
- package/dist/esm/spans/getSpans.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/esm/types/projects.d.ts +12 -3
- package/dist/esm/types/projects.d.ts.map +1 -1
- package/dist/esm/types/projects.js +11 -1
- package/dist/esm/types/projects.js.map +1 -1
- package/dist/esm/types/sessions.d.ts +28 -0
- package/dist/esm/types/sessions.d.ts.map +1 -0
- package/dist/esm/types/sessions.js +2 -0
- package/dist/esm/types/sessions.js.map +1 -0
- package/dist/esm/utils/formatPromptMessages.d.ts.map +1 -1
- package/dist/esm/utils/getPromptBySelector.d.ts +1 -1
- package/dist/esm/utils/getPromptBySelector.d.ts.map +1 -1
- package/dist/src/__generated__/api/v1.d.ts +131 -3
- package/dist/src/__generated__/api/v1.d.ts.map +1 -1
- package/dist/src/sessions/getSession.d.ts +21 -0
- package/dist/src/sessions/getSession.d.ts.map +1 -0
- package/dist/src/sessions/getSession.js +35 -0
- package/dist/src/sessions/getSession.js.map +1 -0
- package/dist/src/sessions/index.d.ts +2 -0
- package/dist/src/sessions/index.d.ts.map +1 -1
- package/dist/src/sessions/index.js +2 -0
- package/dist/src/sessions/index.js.map +1 -1
- package/dist/src/sessions/listSessions.d.ts +22 -0
- package/dist/src/sessions/listSessions.d.ts.map +1 -0
- package/dist/src/sessions/listSessions.js +54 -0
- package/dist/src/sessions/listSessions.js.map +1 -0
- package/dist/src/sessions/sessionUtils.d.ts +9 -0
- package/dist/src/sessions/sessionUtils.d.ts.map +1 -0
- package/dist/src/sessions/sessionUtils.js +22 -0
- package/dist/src/sessions/sessionUtils.js.map +1 -0
- package/dist/src/spans/getSpanAnnotations.d.ts +2 -2
- package/dist/src/spans/getSpanAnnotations.d.ts.map +1 -1
- package/dist/src/spans/getSpanAnnotations.js +2 -1
- package/dist/src/spans/getSpanAnnotations.js.map +1 -1
- package/dist/src/spans/getSpans.d.ts +12 -3
- package/dist/src/spans/getSpans.d.ts.map +1 -1
- package/dist/src/spans/getSpans.js +13 -2
- package/dist/src/spans/getSpans.js.map +1 -1
- package/dist/src/types/projects.d.ts +12 -3
- package/dist/src/types/projects.d.ts.map +1 -1
- package/dist/src/types/projects.js +12 -0
- package/dist/src/types/projects.js.map +1 -1
- package/dist/src/types/sessions.d.ts +28 -0
- package/dist/src/types/sessions.d.ts.map +1 -0
- package/dist/src/types/sessions.js +3 -0
- package/dist/src/types/sessions.js.map +1 -0
- package/dist/src/utils/formatPromptMessages.d.ts.map +1 -1
- package/dist/src/utils/getPromptBySelector.d.ts +1 -1
- package/dist/src/utils/getPromptBySelector.d.ts.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/__generated__/api/v1.ts +131 -3
- package/src/sessions/getSession.ts +44 -0
- package/src/sessions/index.ts +2 -0
- package/src/sessions/listSessions.ts +64 -0
- package/src/sessions/sessionUtils.ts +23 -0
- package/src/spans/getSpanAnnotations.ts +4 -4
- package/src/spans/getSpans.ts +18 -4
- package/src/types/projects.ts +20 -3
- package/src/types/sessions.ts +29 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sessions/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sessions/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { ClientFn } from "../types/core.js";
|
|
2
|
+
import type { ProjectIdentifier } from "../types/projects.js";
|
|
3
|
+
import type { Session } from "../types/sessions.js";
|
|
4
|
+
export type ListSessionsParams = ClientFn & ProjectIdentifier;
|
|
5
|
+
/**
|
|
6
|
+
* List all sessions for a project with automatic pagination handling.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* import { listSessions } from "@arizeai/phoenix-client/sessions";
|
|
11
|
+
*
|
|
12
|
+
* const sessions = await listSessions({
|
|
13
|
+
* project: "my-project",
|
|
14
|
+
* });
|
|
15
|
+
*
|
|
16
|
+
* for (const session of sessions) {
|
|
17
|
+
* console.log(`Session: ${session.sessionId}, Traces: ${session.traces.length}`);
|
|
18
|
+
* }
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
export declare function listSessions(params: ListSessionsParams): Promise<Session[]>;
|
|
22
|
+
//# sourceMappingURL=listSessions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"listSessions.d.ts","sourceRoot":"","sources":["../../../src/sessions/listSessions.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAGjD,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,iBAAiB,CAAC;AAM9D;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,OAAO,EAAE,CAAC,CA6BpB"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import invariant from "tiny-invariant";
|
|
2
|
+
import { createClient } from "../client.js";
|
|
3
|
+
import { resolveProjectIdentifier } from "../types/projects.js";
|
|
4
|
+
import { toSession } from "./sessionUtils.js";
|
|
5
|
+
const DEFAULT_PAGE_SIZE = 100;
|
|
6
|
+
/**
|
|
7
|
+
* List all sessions for a project with automatic pagination handling.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* import { listSessions } from "@arizeai/phoenix-client/sessions";
|
|
12
|
+
*
|
|
13
|
+
* const sessions = await listSessions({
|
|
14
|
+
* project: "my-project",
|
|
15
|
+
* });
|
|
16
|
+
*
|
|
17
|
+
* for (const session of sessions) {
|
|
18
|
+
* console.log(`Session: ${session.sessionId}, Traces: ${session.traces.length}`);
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
export async function listSessions(params) {
|
|
23
|
+
const client = params.client || createClient();
|
|
24
|
+
const projectIdentifier = resolveProjectIdentifier(params);
|
|
25
|
+
const sessions = [];
|
|
26
|
+
let cursor = null;
|
|
27
|
+
do {
|
|
28
|
+
const response = await client.GET("/v1/projects/{project_identifier}/sessions", {
|
|
29
|
+
params: {
|
|
30
|
+
path: {
|
|
31
|
+
project_identifier: projectIdentifier,
|
|
32
|
+
},
|
|
33
|
+
query: {
|
|
34
|
+
cursor,
|
|
35
|
+
limit: DEFAULT_PAGE_SIZE,
|
|
36
|
+
},
|
|
37
|
+
},
|
|
38
|
+
});
|
|
39
|
+
if (response.error)
|
|
40
|
+
throw response.error;
|
|
41
|
+
invariant(response.data?.data, "Failed to list sessions");
|
|
42
|
+
cursor = response.data.next_cursor ?? null;
|
|
43
|
+
sessions.push(...response.data.data.map(toSession));
|
|
44
|
+
} while (cursor != null);
|
|
45
|
+
return sessions;
|
|
46
|
+
}
|
|
47
|
+
//# sourceMappingURL=listSessions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"listSessions.js","sourceRoot":"","sources":["../../../src/sessions/listSessions.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAGvC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAM3C,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAA0B;IAE1B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC;IAC/C,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAE3D,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,IAAI,MAAM,GAA8B,IAAI,CAAC;IAE7C,GAAG,CAAC;QACF,MAAM,QAAQ,GACZ,MAAM,MAAM,CAAC,GAAG,CAAC,4CAA4C,EAAE;YAC7D,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,kBAAkB,EAAE,iBAAiB;iBACtC;gBACD,KAAK,EAAE;oBACL,MAAM;oBACN,KAAK,EAAE,iBAAiB;iBACzB;aACF;SACF,CAAC,CAAC;QAEL,IAAI,QAAQ,CAAC,KAAK;YAAE,MAAM,QAAQ,CAAC,KAAK,CAAC;QACzC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,yBAAyB,CAAC,CAAC;QAE1D,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC;QAC3C,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IACtD,CAAC,QAAQ,MAAM,IAAI,IAAI,EAAE;IAEzB,OAAO,QAAQ,CAAC;AAClB,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { components } from "../__generated__/api/v1.js";
|
|
2
|
+
import type { Session } from "../types/sessions.js";
|
|
3
|
+
type SessionData = components["schemas"]["SessionData"];
|
|
4
|
+
/**
|
|
5
|
+
* Convert an API SessionData response to a user-facing Session object.
|
|
6
|
+
*/
|
|
7
|
+
export declare function toSession(data: SessionData): Session;
|
|
8
|
+
export {};
|
|
9
|
+
//# sourceMappingURL=sessionUtils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessionUtils.d.ts","sourceRoot":"","sources":["../../../src/sessions/sessionUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjD,KAAK,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;AAExD;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAcpD"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Convert an API SessionData response to a user-facing Session object.
|
|
3
|
+
*/
|
|
4
|
+
export function toSession(data) {
|
|
5
|
+
return {
|
|
6
|
+
id: data.id,
|
|
7
|
+
sessionId: data.session_id,
|
|
8
|
+
projectId: data.project_id,
|
|
9
|
+
startTime: data.start_time,
|
|
10
|
+
endTime: data.end_time,
|
|
11
|
+
traces: data.traces.map((trace) => ({
|
|
12
|
+
id: trace.id,
|
|
13
|
+
traceId: trace.trace_id,
|
|
14
|
+
startTime: trace.start_time,
|
|
15
|
+
endTime: trace.end_time,
|
|
16
|
+
})),
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
//# sourceMappingURL=sessionUtils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessionUtils.js","sourceRoot":"","sources":["../../../src/sessions/sessionUtils.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,IAAiB;IACzC,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,SAAS,EAAE,IAAI,CAAC,UAAU;QAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;QAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;QAC1B,OAAO,EAAE,IAAI,CAAC,QAAQ;QACtB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAClC,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,OAAO,EAAE,KAAK,CAAC,QAAQ;YACvB,SAAS,EAAE,KAAK,CAAC,UAAU;YAC3B,OAAO,EAAE,KAAK,CAAC,QAAQ;SACxB,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC"}
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { operations } from "../__generated__/api/v1.js";
|
|
2
2
|
import type { ClientFn } from "../types/core.js";
|
|
3
|
-
import type {
|
|
3
|
+
import type { ProjectIdentifier } from "../types/projects.js";
|
|
4
4
|
/**
|
|
5
5
|
* Parameters to get span annotations from a project using auto-generated types
|
|
6
6
|
*/
|
|
7
7
|
export interface GetSpanAnnotationsParams extends ClientFn {
|
|
8
8
|
/** The project to get span annotations from */
|
|
9
|
-
project:
|
|
9
|
+
project: ProjectIdentifier;
|
|
10
10
|
/** One or more span IDs to fetch annotations for */
|
|
11
11
|
spanIds: string[];
|
|
12
12
|
/** Optional list of annotation names to include. If provided, only annotations with these names will be returned. 'note' annotations are excluded by default unless explicitly included in this list. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getSpanAnnotations.d.ts","sourceRoot":"","sources":["../../../src/spans/getSpanAnnotations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"getSpanAnnotations.d.ts","sourceRoot":"","sources":["../../../src/spans/getSpanAnnotations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,QAAQ;IACxD,+CAA+C;IAC/C,OAAO,EAAE,iBAAiB,CAAC;IAC3B,oDAAoD;IACpD,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,yMAAyM;IACzM,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAClC,iEAAiE;IACjE,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAClC,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,8BAA8B,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC;AAEjE,MAAM,MAAM,wBAAwB,GAAG;IACrC,WAAW,EAAE,0BAA0B,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC/E,UAAU,EAAE,0BAA0B,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,aAAa,CAAC,CAAC;CACtF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,EACP,OAAO,EACP,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,EACN,KAAW,GACZ,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAwC9D"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { createClient } from "../client.js";
|
|
2
|
+
import { resolveProjectIdentifier } from "../types/projects.js";
|
|
2
3
|
/**
|
|
3
4
|
* Get span annotations for a list of span IDs.
|
|
4
5
|
*
|
|
@@ -51,7 +52,7 @@ import { createClient } from "../client.js";
|
|
|
51
52
|
*/
|
|
52
53
|
export async function getSpanAnnotations({ client: _client, project, spanIds, includeAnnotationNames, excludeAnnotationNames, cursor, limit = 100, }) {
|
|
53
54
|
const client = _client ?? createClient();
|
|
54
|
-
const projectIdentifier =
|
|
55
|
+
const projectIdentifier = resolveProjectIdentifier(project);
|
|
55
56
|
const params = {
|
|
56
57
|
span_ids: spanIds,
|
|
57
58
|
limit,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getSpanAnnotations.js","sourceRoot":"","sources":["../../../src/spans/getSpanAnnotations.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"getSpanAnnotations.js","sourceRoot":"","sources":["../../../src/spans/getSpanAnnotations.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AA4B7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,EACP,OAAO,EACP,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,EACN,KAAK,GAAG,GAAG,GACc;IACzB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAE5D,MAAM,MAAM,GAER;QACF,QAAQ,EAAE,OAAO;QACjB,KAAK;KACN,CAAC;IAEF,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,IAAI,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,CAAC,wBAAwB,GAAG,sBAAsB,CAAC;IAC3D,CAAC;IAED,IAAI,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,CAAC,wBAAwB,GAAG,sBAAsB,CAAC;IAC3D,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CACtC,oDAAoD,EACpD;QACE,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,kBAAkB,EAAE,iBAAiB;aACtC;YACD,KAAK,EAAE,MAAM;SACd;KACF,CACF,CAAC;IAEF,IAAI,KAAK;QAAE,MAAM,KAAK,CAAC;IACvB,OAAO;QACL,WAAW,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE;QAC7B,UAAU,EAAE,IAAI,EAAE,WAAW,IAAI,IAAI;KACtC,CAAC;AACJ,CAAC"}
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { operations } from "../__generated__/api/v1.js";
|
|
2
2
|
import type { ClientFn } from "../types/core.js";
|
|
3
|
-
import type {
|
|
3
|
+
import type { ProjectIdentifier } from "../types/projects.js";
|
|
4
4
|
/**
|
|
5
5
|
* Parameters to get spans from a project using auto-generated types
|
|
6
6
|
*/
|
|
7
7
|
export interface GetSpansParams extends ClientFn {
|
|
8
8
|
/** The project to get spans from */
|
|
9
|
-
project:
|
|
9
|
+
project: ProjectIdentifier;
|
|
10
10
|
/** Inclusive lower bound time. Must be a valid ISO 8601 string or Date object. */
|
|
11
11
|
startTime?: Date | string | null;
|
|
12
12
|
/** Exclusive upper bound time. Must be a valid ISO 8601 string or Date object. */
|
|
@@ -15,6 +15,8 @@ export interface GetSpansParams extends ClientFn {
|
|
|
15
15
|
cursor?: string | null;
|
|
16
16
|
/** Maximum number of spans to return */
|
|
17
17
|
limit?: number;
|
|
18
|
+
/** Filter spans by one or more trace IDs */
|
|
19
|
+
traceIds?: string[] | null;
|
|
18
20
|
}
|
|
19
21
|
export type GetSpansResponse = operations["getSpans"]["responses"]["200"];
|
|
20
22
|
export type GetSpansResult = {
|
|
@@ -53,6 +55,13 @@ export type GetSpansResult = {
|
|
|
53
55
|
* limit: 100
|
|
54
56
|
* });
|
|
55
57
|
|
|
58
|
+
*
|
|
59
|
+
* // Get all spans for specific traces (requires Phoenix server >= 13.9.0)
|
|
60
|
+
* const result = await getSpans({
|
|
61
|
+
* client,
|
|
62
|
+
* project: { projectName: "my-project" },
|
|
63
|
+
* traceIds: ["trace-abc-123", "trace-def-456"],
|
|
64
|
+
* });
|
|
56
65
|
*
|
|
57
66
|
* // Paginate through results
|
|
58
67
|
* let cursor: string | undefined;
|
|
@@ -73,5 +82,5 @@ export type GetSpansResult = {
|
|
|
73
82
|
* } while (cursor);
|
|
74
83
|
* ```
|
|
75
84
|
*/
|
|
76
|
-
export declare function getSpans({ client: _client, project, cursor, limit, startTime, endTime, }: GetSpansParams): Promise<GetSpansResult>;
|
|
85
|
+
export declare function getSpans({ client: _client, project, cursor, limit, startTime, endTime, traceIds, }: GetSpansParams): Promise<GetSpansResult>;
|
|
77
86
|
//# sourceMappingURL=getSpans.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getSpans.d.ts","sourceRoot":"","sources":["../../../src/spans/getSpans.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"getSpans.d.ts","sourceRoot":"","sources":["../../../src/spans/getSpans.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC9C,oCAAoC;IACpC,OAAO,EAAE,iBAAiB,CAAC;IAC3B,kFAAkF;IAClF,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,kFAAkF;IAClF,OAAO,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IAC/B,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC;AAE1E,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC/D,UAAU,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,aAAa,CAAC,CAAC;CAC5E,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,wBAAsB,QAAQ,CAAC,EAC7B,MAAM,EAAE,OAAO,EACf,OAAO,EACP,MAAM,EACN,KAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,GACT,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CA0C1C"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { createClient } from "../client.js";
|
|
2
|
+
import { resolveProjectIdentifier } from "../types/projects.js";
|
|
2
3
|
/**
|
|
3
4
|
* Get spans from a project with filtering criteria.
|
|
4
5
|
*
|
|
@@ -31,6 +32,13 @@ import { createClient } from "../client.js";
|
|
|
31
32
|
* limit: 100
|
|
32
33
|
* });
|
|
33
34
|
|
|
35
|
+
*
|
|
36
|
+
* // Get all spans for specific traces (requires Phoenix server >= 13.9.0)
|
|
37
|
+
* const result = await getSpans({
|
|
38
|
+
* client,
|
|
39
|
+
* project: { projectName: "my-project" },
|
|
40
|
+
* traceIds: ["trace-abc-123", "trace-def-456"],
|
|
41
|
+
* });
|
|
34
42
|
*
|
|
35
43
|
* // Paginate through results
|
|
36
44
|
* let cursor: string | undefined;
|
|
@@ -51,9 +59,9 @@ import { createClient } from "../client.js";
|
|
|
51
59
|
* } while (cursor);
|
|
52
60
|
* ```
|
|
53
61
|
*/
|
|
54
|
-
export async function getSpans({ client: _client, project, cursor, limit = 100, startTime, endTime, }) {
|
|
62
|
+
export async function getSpans({ client: _client, project, cursor, limit = 100, startTime, endTime, traceIds, }) {
|
|
55
63
|
const client = _client ?? createClient();
|
|
56
|
-
const projectIdentifier =
|
|
64
|
+
const projectIdentifier = resolveProjectIdentifier(project);
|
|
57
65
|
const params = {
|
|
58
66
|
limit,
|
|
59
67
|
};
|
|
@@ -67,6 +75,9 @@ export async function getSpans({ client: _client, project, cursor, limit = 100,
|
|
|
67
75
|
if (endTime) {
|
|
68
76
|
params.end_time = endTime instanceof Date ? endTime.toISOString() : endTime;
|
|
69
77
|
}
|
|
78
|
+
if (traceIds) {
|
|
79
|
+
params.trace_id = traceIds;
|
|
80
|
+
}
|
|
70
81
|
const { data, error } = await client.GET("/v1/projects/{project_identifier}/spans", {
|
|
71
82
|
params: {
|
|
72
83
|
path: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getSpans.js","sourceRoot":"","sources":["../../../src/spans/getSpans.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"getSpans.js","sourceRoot":"","sources":["../../../src/spans/getSpans.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AA2B7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,EAC7B,MAAM,EAAE,OAAO,EACf,OAAO,EACP,MAAM,EACN,KAAK,GAAG,GAAG,EACX,SAAS,EACT,OAAO,EACP,QAAQ,GACO;IACf,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAE5D,MAAM,MAAM,GAA+D;QACzE,KAAK;KACN,CAAC;IAEF,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,CAAC,UAAU;YACf,SAAS,YAAY,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACpE,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,CAAC,QAAQ,GAAG,OAAO,YAAY,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IAC9E,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CACtC,yCAAyC,EACzC;QACE,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,kBAAkB,EAAE,iBAAiB;aACtC;YACD,KAAK,EAAE,MAAM;SACd;KACF,CACF,CAAC;IAEF,IAAI,KAAK;QAAE,MAAM,KAAK,CAAC;IACvB,OAAO;QACL,KAAK,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE;QACvB,UAAU,EAAE,IAAI,EAAE,WAAW,IAAI,IAAI;KACtC,CAAC;AACJ,CAAC"}
|