Skip to content

Update usage report spec def and examples #127

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
jdolle wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update usage report spec def and examples #127

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
71 changes: 71 additions & 0 deletions packages/documentation/content/docs/api-reference/usage-report-v2.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,72 @@
"errorsTotal": {
"type": "integer",
"minimum": 0
},
"fetches": {
"type": ["array", "null"],
"items": {
"title": "OperationSubRequest",
"additionalProperties": false,
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0
},
"duration": {
"type": "integer",
"minimum": 0
},
"status": {
"type": "integer",
"minimum": 0
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "integer",
"minimum": 0
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"coordinate": {
"type": "string"
},
"code": {
"type": "string"
}
},
"required": ["coordinate"]
}
},
"subgraph": {
"type": "string"
},
"paths": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"type": {
"type": "string",
"enum": ["ROOT", "ENTITY"]
}
},
"required": ["start", "duration", "status", "fields", "subgraph", "paths", "type"]
}
}
},
"required": ["ok", "duration", "errorsTotal"]
Expand Down Expand Up @@ -111,6 +177,11 @@
"operationMapKey": {
"type": "string"
},
"persistedDocumentHash": {
"type": "string",
"title": "PersistedDocumentHash",
"pattern": "^[a-zA-Z0-9_-]{1,64}~[a-zA-Z0-9._-]{1,64}~([A-Za-z]|[0-9]|_){1,128}$"
},
"metadata": {
"title": "Metadata",
"additionalProperties": false,
Expand Down
136 changes: 106 additions & 30 deletions packages/documentation/content/docs/api-reference/usage-reports.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,15 @@ reporting permissions. [Learn how to create an access token](/docs/schema-regist
```typescript
export interface Report {
size: number;
map: {
[k: string]: OperationMapRecord;
};
map: OperationMap;
operations?: RequestOperation[];
subscriptionOperations?: SubscriptionOperation[];
}

export interface OperationMap {
[key: string]: OperationMapRecord;
}

export interface OperationMapRecord {
operation: string;
operationName?: string;
Expand All @@ -51,7 +53,13 @@ export interface OperationMapRecord {
}

export interface RequestOperation {
/**
* milliseconds elapsed since January 1, 1970, UTC. must be within retention period of use plan (free/Pro/enterprise)
*/
timestamp: number;
/**
* Used in the Report.map to lookup operation metadata
*/
operationMapKey: string;
execution: Execution;
metadata?: Metadata;
Expand All @@ -60,13 +68,34 @@ export interface RequestOperation {

export interface Execution {
ok: boolean;
/**
* in nanoseconds
*/
duration: number;
errorsTotal: number;
fetches?: OperationSubgraphRequest[] | null;
}

export interface OperationSubgraphRequest {
start: number;
duration: number;
status: number;
fields: { [coordinate: string]: number };
errors?: SubgraphError[];
subgraph: string;
paths: string | string[];
type: 'ROOT' | 'ENTITY';
}

export interface SubgraphError {
coordinate: string;
code?: string;
}

export interface SubscriptionOperation {
timestamp: number;
operationMapKey: string;
persistedDocumentHash?: string;
metadata?: Metadata;
}

Expand Down Expand Up @@ -98,12 +127,12 @@ export interface Metadata {
"c3b6d9b0": {
"operationName": "me",
"operation": "query me { me { id name } }",
"fields": ["Query", "Query.me", "User", "User.id", "User.name"],
"fields": ["Query", "Query.me", "User", "User.id", "User.name"]
},
"762a45e3": {
"operationName": "users",
"operation": "query users { users { id } }",
"fields": ["Query", "Query.users", "User", "User.id"],
"fields": ["Query", "Query.users", "User", "User.id"]
},
"12f3712a": {
"operationName": "liveCoordinates",
Expand All @@ -114,69 +143,116 @@ export interface Metadata {
"User",
"Location",
"Location.x",
"Location.y",
],
},
"Location.y"
]
}
},
"operations": [
{
"operationMapKey": "c3b6d9b0", // points to the 'me' query
"timestamp": 1663158676535, // milliseconds elapsed since January 1, 1970, UTC. must be within retention period of use plan (free/Pro/enterprise)
"operationMapKey": "c3b6d9b0",
"timestamp": 1663158676535,
"execution": {
"ok": true,
"duration": 150000000, // 150ms in nanoseconds
"duration": 150000000,
"errorsTotal": 0,
"fetches": [
{
"start": 1200000,
"duration": 142000000,
"status": 200,
"subgraph": "users-subgraph",
"type": "ROOT",
"paths": "Query",
"fields": {
"Query": 1,
"Query.me": 1,
"User": 1,
"User.id": 1,
"User.name": 1,
"ID": 1
"String": 1
}
}
]
},
"metadata": {
"client": {
"name": "demo",
"version": "0.0.1",
},
"version": "0.0.1"
}
},
"persistedDocumentHash": "sha256~demo-app~a1b2c3d4e5f6g7h8i9j0"
},
{
"operationMapKey": "c3b6d9b0", // points to the 'me' query
"operationMapKey": "c3b6d9b0",
"timestamp": 1663158676589,
"execution": {
"ok": false, // failed operation
"duration": 150000000, // 150ms in nanoseconds
"errorsTotal": 1, // 1 GraphQL error
"ok": false,
"duration": 150000000,
"errorsTotal": 1,
"fetches": [
{
"start": 800000,
"duration": 148000000,
"status": 200,
"subgraph": "users-subgraph",
"type": "ROOT",
"paths": ["Query"],
"fields": {
"Query": 1,
"Query.me": 1,
"User": 1,
"User.id": 1
"User.name": 1,
"ID": 1
},
"errors": [
{
"coordinate": "User.name",
"code": "UNAUTHENTICATED"
}
]
}
]
},
"metadata": {
"client": {
"name": "demo",
"version": "0.0.1",
},
"version": "0.0.1"
}
},
"persistedDocumentHash": "sha256~demo-app~a1b2c3d4e5f6g7h8i9j0"
},
{
"operationMapKey": "762a45e3", // points to the 'users' query
"operationMapKey": "762a45e3",
"timestamp": 1663158676589,
"execution": {
"ok": true,
"duration": 150000000, // 150ms in nanoseconds
"duration": 150000000,
"errorsTotal": 0,
"fetches": null
},
"metadata": {
"client": {
"name": "demo",
"version": "0.0.1",
},
},
},
"version": "0.0.1"
}
}
}
],
"subscriptionOperations": [
{
"operationMapKey": "12f3712a", // points to the 'users' query
"operationMapKey": "12f3712a",
"timestamp": 1663158676589,
"metadata": {
"client": {
"name": "demo",
"version": "0.0.1",
},
"version": "0.0.1"
}
},
},
],
"persistedDocumentHash": "sha256~demo-app~z9y8x7w6v5u4t3s2r1q0"
}
]
}
```

Expand Down
Loading