@runlot/api 0.1.0-rc.162 → 0.1.0-rc.164
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/index.d.ts +476 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +665 -0
- package/dist/index.js.map +1 -1
- package/dist/schema.d.ts +21663 -8459
- package/dist/schema.d.ts.map +1 -1
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -62,7 +62,96 @@ export type ProjectOverview = Schemas["ProjectOverview"];
|
|
|
62
62
|
export type OverviewDeployment = Schemas["OverviewDeployment"];
|
|
63
63
|
export type Manifest = Schemas["Manifest"];
|
|
64
64
|
export type CronOverview = Schemas["CronOverview"];
|
|
65
|
+
export type ErrorIssue = Schemas["ErrorIssue"];
|
|
66
|
+
export type ErrorIssuePage = Schemas["ErrorIssuePage"];
|
|
67
|
+
export type ErrorIssueDetail = Schemas["ErrorIssueDetail"];
|
|
68
|
+
export type ErrorIssueUpdate = Schemas["ErrorIssueUpdate"];
|
|
69
|
+
export type ErrorEvent = Schemas["ErrorEvent"];
|
|
70
|
+
export type ErrorEventSummary = Schemas["ErrorEventSummary"];
|
|
71
|
+
export type ErrorEventPage = Schemas["ErrorEventPage"];
|
|
72
|
+
export type ErrorFrame = Schemas["ErrorFrame"];
|
|
73
|
+
export type ErrorException = Schemas["ErrorException"];
|
|
74
|
+
export type ErrorBreadcrumb = Schemas["ErrorBreadcrumb"];
|
|
75
|
+
export type ErrorActivity = Schemas["ErrorActivity"];
|
|
76
|
+
export type ErrorOwnershipPolicy = Schemas["ErrorOwnershipPolicy"];
|
|
77
|
+
export type ErrorOwnershipPinInput = Schemas["ErrorOwnershipPinInput"];
|
|
78
|
+
export type ErrorOwnershipPin = Schemas["ErrorOwnershipPin"];
|
|
79
|
+
export type ErrorSettings = Schemas["ErrorSettings"];
|
|
80
|
+
export type RelatedErrorEvents = Schemas["RelatedErrorEvents"];
|
|
81
|
+
export type ErrorHistory = Schemas["ErrorHistory"];
|
|
82
|
+
export type UptimeCheck = Schemas["UptimeCheck"];
|
|
83
|
+
export type ObservabilityPermission = Schemas["ObservabilityPermission"];
|
|
84
|
+
export type ObservabilityCaps = Schemas["ObservabilityCaps"];
|
|
85
|
+
export type ObservabilityExport = Schemas["ObservabilityExport"];
|
|
86
|
+
export type ObservabilityRehydration = Schemas["ObservabilityRehydration"];
|
|
87
|
+
export type ObservabilityAuditEntry = Schemas["ObservabilityAuditEntry"];
|
|
88
|
+
export type ObservabilityData = Schemas["ObservabilityData"];
|
|
89
|
+
export type BugReport = Schemas["BugReport"];
|
|
90
|
+
export type UptimeCheckInput = Schemas["UptimeCheckInput"];
|
|
91
|
+
export type UptimeCheckList = Schemas["UptimeCheckList"];
|
|
92
|
+
export type ObsProfilerSettings = Schemas["ObsProfilerSettings"];
|
|
93
|
+
export type ObsSampling = Schemas["ObsSampling"];
|
|
94
|
+
export type ObsProfileList = Schemas["ObsProfileList"];
|
|
95
|
+
export type ObsFlamegraph = Schemas["ObsFlamegraph"];
|
|
96
|
+
export type ObsFlameNode = Schemas["ObsFlameNode"];
|
|
97
|
+
export type ObsProfileTop = Schemas["ObsProfileTop"];
|
|
98
|
+
export type ObsProfileCompare = Schemas["ObsProfileCompare"];
|
|
99
|
+
export type ObsHeapSnapshot = Schemas["ObsHeapSnapshot"];
|
|
100
|
+
export type ObsHeapSnapshotList = Schemas["ObsHeapSnapshotList"];
|
|
101
|
+
export type ObsRUMAggregate = Schemas["ObsRUMAggregate"];
|
|
102
|
+
export type ObsRUMOverview = Schemas["ObsRUMOverview"];
|
|
103
|
+
export type ObsRUMPages = Schemas["ObsRUMPages"];
|
|
104
|
+
export type ObsRUMDevices = Schemas["ObsRUMDevices"];
|
|
105
|
+
export type ObsRUMViewList = Schemas["ObsRUMViewList"];
|
|
106
|
+
export type ObsRUMView = Schemas["ObsRUMView"];
|
|
107
|
+
export type ObsRUMViewSummary = Schemas["ObsRUMViewSummary"];
|
|
108
|
+
export type ObsRUMTiming = Schemas["ObsRUMTiming"];
|
|
109
|
+
/** Filters of the RUM reads (customer-observability.md §17.12). */
|
|
110
|
+
export interface ObsRUMQuery {
|
|
111
|
+
from?: string;
|
|
112
|
+
to?: string;
|
|
113
|
+
step?: string;
|
|
114
|
+
template?: string;
|
|
115
|
+
device?: "mobile" | "tablet" | "desktop";
|
|
116
|
+
}
|
|
117
|
+
/** The window and filters of a profile read (customer-observability.md §17.13). */
|
|
118
|
+
export interface ObsProfileQuery {
|
|
119
|
+
from?: string;
|
|
120
|
+
to?: string;
|
|
121
|
+
version?: number;
|
|
122
|
+
route?: string;
|
|
123
|
+
limit?: number;
|
|
124
|
+
}
|
|
125
|
+
export type UptimeRun = Schemas["UptimeRun"];
|
|
126
|
+
export type ErrorPerformanceThresholds = Schemas["ErrorPerformanceThresholds"];
|
|
127
|
+
export type ErrorCapturePolicy = Schemas["ErrorCapturePolicy"];
|
|
128
|
+
export type ErrorCapturePolicyView = Schemas["ErrorCapturePolicyView"];
|
|
129
|
+
export type ErrorComment = Schemas["ErrorComment"];
|
|
130
|
+
export type ErrorCommentPage = Schemas["ErrorCommentPage"];
|
|
131
|
+
export type ErrorSimilar = Schemas["ErrorSimilar"];
|
|
132
|
+
export type ErrorFingerprintRule = Schemas["ErrorFingerprintRule"];
|
|
133
|
+
export type ErrorFingerprintRules = Schemas["ErrorFingerprintRules"];
|
|
134
|
+
export type ErrorInsights = Schemas["ErrorInsights"];
|
|
135
|
+
export type ErrorInsightSourceContext = Schemas["ErrorInsightSourceContext"];
|
|
136
|
+
export type ErrorSuspectCommit = Schemas["ErrorSuspectCommit"];
|
|
137
|
+
export type ErrorInsightOwners = Schemas["ErrorInsightOwners"];
|
|
138
|
+
export type ErrorDiagnosis = Schemas["ErrorDiagnosis"];
|
|
139
|
+
export type ErrorFixProposal = Schemas["ErrorFixProposal"];
|
|
140
|
+
export type ErrorFixPreview = Schemas["ErrorFixPreview"];
|
|
141
|
+
export type ErrorFixPreviewVerification = Schemas["ErrorFixPreviewVerification"];
|
|
142
|
+
export type ErrorFixPreviewApproval = Schemas["ErrorFixPreviewApproval"];
|
|
143
|
+
export type ErrorFixPreviewVerificationApproval = Schemas["ErrorFixPreviewVerificationApproval"];
|
|
144
|
+
export type ErrorFixApplyResult = Schemas["ErrorFixApplyResult"];
|
|
145
|
+
/** Masked structural replay (not a pixel recording): settings, metadata and one batch. */
|
|
146
|
+
export type ErrorErasureResult = Schemas["ErrorErasureResult"];
|
|
147
|
+
export type BrowserTelemetrySummary = Schemas["BrowserTelemetrySummary"];
|
|
148
|
+
export type BrowserFeedback = Schemas["BrowserFeedback"];
|
|
149
|
+
export type ErrorReplaySettings = Schemas["ErrorReplaySettings"];
|
|
150
|
+
export type ErrorReplay = Schemas["ErrorReplay"];
|
|
151
|
+
export type ErrorReplayBatch = Schemas["ErrorReplayBatch"];
|
|
65
152
|
export type CronSchedule = Schemas["CronSchedule"];
|
|
153
|
+
export type CronMonitor = Schemas["CronMonitor"];
|
|
154
|
+
export type CronMonitorIncident = Schemas["CronMonitorIncident"];
|
|
66
155
|
export type CronRun = Schemas["CronRun"];
|
|
67
156
|
export type CronSummary = Schemas["CronSummary"];
|
|
68
157
|
export type QueueOverview = Schemas["QueueOverview"];
|
|
@@ -96,6 +185,26 @@ export type InviteState = Schemas["InviteState"];
|
|
|
96
185
|
export type SecretMeta = Schemas["SecretMeta"];
|
|
97
186
|
export type SecretList = Schemas["SecretList"];
|
|
98
187
|
export type LogEvent = Schemas["LogEvent"];
|
|
188
|
+
export type LogRecord = Schemas["LogRecord"];
|
|
189
|
+
export type ObsQuery = Schemas["ObsQuery"];
|
|
190
|
+
export type ObsFilter = Schemas["ObsFilter"];
|
|
191
|
+
export type ObsQueryResult = Schemas["ObsQueryResult"];
|
|
192
|
+
export type ObsInvocation = Schemas["ObsInvocation"];
|
|
193
|
+
export type ObsEvent = Schemas["ObsEvent"];
|
|
194
|
+
export type ObsRequestView = Schemas["ObsRequestView"];
|
|
195
|
+
export type SavedQuery = Schemas["SavedQuery"];
|
|
196
|
+
export type SavedQueryInput = Schemas["SavedQueryInput"];
|
|
197
|
+
export type ObsProcessor = Schemas["ObsProcessor"];
|
|
198
|
+
export type ObsScannerConfig = Schemas["ObsScannerConfig"];
|
|
199
|
+
export type ObsLogMetric = Schemas["ObsLogMetric"];
|
|
200
|
+
export type ObsLogsConfig = Schemas["ObsLogsConfig"];
|
|
201
|
+
/** Live-tail filters, applied on the node before a line is sent. */
|
|
202
|
+
export type LogTailFilter = {
|
|
203
|
+
level?: "debug" | "log" | "info" | "warn" | "error";
|
|
204
|
+
source?: "stdout" | "stderr" | "runlot";
|
|
205
|
+
q?: string;
|
|
206
|
+
requestId?: string;
|
|
207
|
+
};
|
|
99
208
|
export type LogHistoryLine = {
|
|
100
209
|
ts: string;
|
|
101
210
|
seq: number;
|
|
@@ -499,6 +608,341 @@ export declare class Client {
|
|
|
499
608
|
* caller never learns its name.
|
|
500
609
|
*/
|
|
501
610
|
getDeployment(org: string, name: string, deploymentId: string): Promise<Ok<"getDeployment">>;
|
|
611
|
+
/** Completed-front HTTP outcomes only; native crash-free health is unknown. */
|
|
612
|
+
getReleaseHealth(org: string, name: string): Promise<Ok<"getReleaseHealth">>;
|
|
613
|
+
/** Historical first transition per issue; never substitutes a latest occurrence. */
|
|
614
|
+
listReleaseIssues(org: string, name: string, version: number, opts: {
|
|
615
|
+
kind: "new" | "regressed";
|
|
616
|
+
windowStart: string;
|
|
617
|
+
windowEnd: string;
|
|
618
|
+
cursor?: string;
|
|
619
|
+
}): Promise<Ok<"listReleaseIssues">>;
|
|
620
|
+
/** Runlot Errors: the issue stream (docs/customer-error-tracking.md). */
|
|
621
|
+
listErrorIssues(org: string, name: string, opts?: {
|
|
622
|
+
status?: "unresolved" | "resolved" | "archived" | "all";
|
|
623
|
+
query?: string;
|
|
624
|
+
cursor?: string;
|
|
625
|
+
limit?: number;
|
|
626
|
+
}): Promise<Ok<"listErrorIssues">>;
|
|
627
|
+
getErrorIssue(org: string, name: string, issueId: string): Promise<Ok<"getErrorIssue">>;
|
|
628
|
+
updateErrorIssue(org: string, name: string, issueId: string, update: ErrorIssueUpdate): Promise<Ok<"updateErrorIssue">>;
|
|
629
|
+
/** Source context, suspects and owners for the selected stored occurrence, or latest when omitted. */
|
|
630
|
+
getErrorInsights(org: string, name: string, issueId: string, opts?: {
|
|
631
|
+
eventId?: string;
|
|
632
|
+
}): Promise<Ok<"getErrorInsights">>;
|
|
633
|
+
listErrorEvents(org: string, name: string, issueId: string, opts?: {
|
|
634
|
+
cursor?: string;
|
|
635
|
+
limit?: number;
|
|
636
|
+
}): Promise<Ok<"listErrorEvents">>;
|
|
637
|
+
getErrorEvent(org: string, name: string, issueId: string, eventId: string): Promise<Ok<"getErrorEvent">>;
|
|
638
|
+
/**
|
|
639
|
+
* Other events of the project joined to this one by front's request ID or a
|
|
640
|
+
* browser-minted trace ID (§12). Correlation only: issues are never merged.
|
|
641
|
+
*/
|
|
642
|
+
getRelatedErrorEvents(org: string, name: string, issueId: string, eventId: string): Promise<Ok<"getRelatedErrorEvents">>;
|
|
643
|
+
/** An issue's hourly history from the ClickHouse store; `available: false` where there is none. */
|
|
644
|
+
getErrorHistory(org: string, name: string, issueId: string, days?: number): Promise<Ok<"getErrorHistory">>;
|
|
645
|
+
/** Assign an issue to an org member, or clear it with null. */
|
|
646
|
+
assignErrorIssue(org: string, name: string, issueId: string, userId: string | null): Promise<Ok<"assignErrorIssue">>;
|
|
647
|
+
listErrorComments(org: string, name: string, issueId: string): Promise<Ok<"listErrorComments">>;
|
|
648
|
+
/** Plain text, at most 4000 characters; the author is the signed-in user. */
|
|
649
|
+
addErrorComment(org: string, name: string, issueId: string, body: string): Promise<Ok<"addErrorComment">>;
|
|
650
|
+
/** Merge up to ten issues of the same origin into `targetIssueId`. */
|
|
651
|
+
mergeErrorIssues(org: string, name: string, targetIssueId: string, sourceIssueIds: string[]): Promise<Ok<"mergeErrorIssues">>;
|
|
652
|
+
/** Take a merged source back out of the issue it was merged into. */
|
|
653
|
+
unmergeErrorIssue(org: string, name: string, issueId: string): Promise<Ok<"unmergeErrorIssue">>;
|
|
654
|
+
/** Shared stack hints: frame overlap, never a merge or a causal claim. */
|
|
655
|
+
similarErrorIssues(org: string, name: string, issueId: string): Promise<Ok<"similarErrorIssues">>;
|
|
656
|
+
getErrorFingerprintRules(org: string, name: string): Promise<Ok<"getErrorFingerprintRules">>;
|
|
657
|
+
putErrorFingerprintRules(org: string, name: string, rules: ErrorFingerprintRule[]): Promise<Ok<"putErrorFingerprintRules">>;
|
|
658
|
+
getErrorAlerts(org: string, name: string): Promise<Ok<"getErrorAlerts">>;
|
|
659
|
+
putErrorAlertRule(org: string, name: string, id: string, rule: components["schemas"]["ErrorAlertRule"]): Promise<Ok<"putErrorAlertRule">>;
|
|
660
|
+
deleteErrorAlertRule(org: string, name: string, id: string): Promise<void>;
|
|
661
|
+
putErrorAlertDestination(org: string, name: string, id: string, input: components["schemas"]["ErrorAlertDestinationInput"]): Promise<Ok<"putErrorAlertDestination">>;
|
|
662
|
+
deleteErrorAlertDestination(org: string, name: string, id: string): Promise<void>;
|
|
663
|
+
getErrorAlertMail(org: string, name: string): Promise<Ok<"getErrorAlertMail">>;
|
|
664
|
+
putErrorAlertMail(org: string, name: string, preference: components["schemas"]["ErrorAlertMailPreference"]): Promise<Ok<"putErrorAlertMail">>;
|
|
665
|
+
listErrorAlertDeliveries(org: string, name: string): Promise<Ok<"listErrorAlertDeliveries">>;
|
|
666
|
+
listMonitors(org: string, name: string): Promise<Ok<"listMonitors">>;
|
|
667
|
+
exportMonitors(org: string, name: string): Promise<Ok<"exportMonitors">>;
|
|
668
|
+
getMonitor(org: string, name: string, id: string): Promise<Ok<"getMonitor">>;
|
|
669
|
+
putMonitor(org: string, name: string, id: string, monitor: components["schemas"]["Monitor"]): Promise<Ok<"putMonitor">>;
|
|
670
|
+
deleteMonitor(org: string, name: string, id: string): Promise<void>;
|
|
671
|
+
getMonitorHistory(org: string, name: string, id: string, limit?: number): Promise<Ok<"getMonitorHistory">>;
|
|
672
|
+
testMonitor(org: string, name: string, id: string): Promise<Ok<"testMonitor">>;
|
|
673
|
+
listDowntimes(org: string, name: string): Promise<Ok<"listDowntimes">>;
|
|
674
|
+
putDowntime(org: string, name: string, id: string, downtime: components["schemas"]["Downtime"]): Promise<Ok<"putDowntime">>;
|
|
675
|
+
deleteDowntime(org: string, name: string, id: string): Promise<void>;
|
|
676
|
+
listSLOs(org: string, name: string): Promise<Ok<"listSLOs">>;
|
|
677
|
+
getSLO(org: string, name: string, id: string): Promise<Ok<"getSLO">>;
|
|
678
|
+
putSLO(org: string, name: string, id: string, slo: components["schemas"]["SLO"]): Promise<Ok<"putSLO">>;
|
|
679
|
+
deleteSLO(org: string, name: string, id: string): Promise<void>;
|
|
680
|
+
/**
|
|
681
|
+
* Observability access and governance (customer-observability.md §12, §16, §17.15):
|
|
682
|
+
* the caller's grants, per-project role overrides, the audit trail, the data page,
|
|
683
|
+
* caps, export destinations and rehydration.
|
|
684
|
+
*/
|
|
685
|
+
getObservabilityPermissions(org: string, name: string): Promise<Ok<"getObservabilityPermissions">>;
|
|
686
|
+
listObservabilityRoles(org: string, name: string): Promise<Ok<"listObservabilityRoles">>;
|
|
687
|
+
putObservabilityRole(org: string, name: string, userId: string, grants: ObservabilityPermission[]): Promise<Ok<"putObservabilityRole">>;
|
|
688
|
+
deleteObservabilityRole(org: string, name: string, userId: string): Promise<void>;
|
|
689
|
+
listObservabilityAudit(org: string, name: string, opts?: {
|
|
690
|
+
limit?: number;
|
|
691
|
+
before?: string;
|
|
692
|
+
}): Promise<Ok<"listObservabilityAudit">>;
|
|
693
|
+
getObservabilityData(org: string, name: string): Promise<Ok<"getObservabilityData">>;
|
|
694
|
+
getObservabilityCaps(org: string, name: string): Promise<Ok<"getObservabilityCaps">>;
|
|
695
|
+
/** Named meters only: a number, -1 (no cap, Pro) or null (the plan's included amount). */
|
|
696
|
+
putObservabilityCaps(org: string, name: string, caps: Schemas["ObservabilityCapsUpdate"]): Promise<Ok<"putObservabilityCaps">>;
|
|
697
|
+
listObservabilityExports(org: string, name: string): Promise<Ok<"listObservabilityExports">>;
|
|
698
|
+
getObservabilityExport(org: string, name: string, exportId: string): Promise<Ok<"getObservabilityExport">>;
|
|
699
|
+
createObservabilityExport(org: string, name: string, input: Schemas["ObservabilityExportCreate"]): Promise<Ok<"createObservabilityExport">>;
|
|
700
|
+
updateObservabilityExport(org: string, name: string, exportId: string, input: Schemas["ObservabilityExportUpdate"]): Promise<Ok<"updateObservabilityExport">>;
|
|
701
|
+
deleteObservabilityExport(org: string, name: string, exportId: string): Promise<void>;
|
|
702
|
+
listObservabilityRehydrations(org: string, name: string): Promise<Ok<"listObservabilityRehydrations">>;
|
|
703
|
+
getObservabilityRehydration(org: string, name: string, jobId: string): Promise<Ok<"getObservabilityRehydration">>;
|
|
704
|
+
/** Loads an archived range back for seven days; the answer is the queued job. */
|
|
705
|
+
createObservabilityRehydration(org: string, name: string, input: {
|
|
706
|
+
exportId: string;
|
|
707
|
+
from: string;
|
|
708
|
+
to: string;
|
|
709
|
+
}): Promise<Ok<"createObservabilityRehydration">>;
|
|
710
|
+
/** `runlot bug-report` (customer-observability.md §14): the CP snapshots what the references name. */
|
|
711
|
+
createBugReport(org: string, input: Schemas["BugReportCreate"]): Promise<Ok<"createBugReport">>;
|
|
712
|
+
listBugReports(org: string): Promise<Ok<"listBugReports">>;
|
|
713
|
+
getBugReport(org: string, reportId: string, opts?: {
|
|
714
|
+
snapshot?: boolean;
|
|
715
|
+
}): Promise<Ok<"getBugReport">>;
|
|
716
|
+
deleteBugReport(org: string, reportId: string): Promise<void>;
|
|
717
|
+
/** Synthetic HTTP checks of the project's own addresses (customer-observability.md §17.11). */
|
|
718
|
+
listUptimeChecks(org: string, name: string): Promise<Ok<"listUptimeChecks">>;
|
|
719
|
+
putUptimeCheck(org: string, name: string, id: string, input: components["schemas"]["UptimeCheckInput"]): Promise<Ok<"putUptimeCheck">>;
|
|
720
|
+
deleteUptimeCheck(org: string, name: string, id: string): Promise<void>;
|
|
721
|
+
listUptimeRuns(org: string, name: string, id: string, limit?: number): Promise<Ok<"listUptimeRuns">>;
|
|
722
|
+
/** Dashboards (customer-observability.md §17.7). A built-in's id is `builtin:<key>`. */
|
|
723
|
+
listDashboards(org: string, name: string): Promise<Ok<"listDashboards">>;
|
|
724
|
+
createDashboard(org: string, name: string, input: Schemas["DashboardInput"]): Promise<Ok<"createDashboard">>;
|
|
725
|
+
getDashboard(org: string, name: string, id: string): Promise<Ok<"getDashboard">>;
|
|
726
|
+
putDashboard(org: string, name: string, id: string, input: Schemas["DashboardInput"]): Promise<Ok<"putDashboard">>;
|
|
727
|
+
deleteDashboard(org: string, name: string, id: string): Promise<void>;
|
|
728
|
+
/** The `.runlot/dashboards/<key>.json` form of a dashboard. */
|
|
729
|
+
exportDashboard(org: string, name: string, id: string): Promise<Ok<"exportDashboard">>;
|
|
730
|
+
/** Make (or rotate) the public link; the token is shown once. */
|
|
731
|
+
shareDashboard(org: string, name: string, id: string, isPublic?: boolean): Promise<Ok<"shareDashboard">>;
|
|
732
|
+
unshareDashboard(org: string, name: string, id: string): Promise<void>;
|
|
733
|
+
getDashboardWidgetData(org: string, name: string, id: string, widgetId: string, req?: Schemas["WidgetDataRequest"]): Promise<Ok<"getDashboardWidgetData">>;
|
|
734
|
+
getDashboardSettings(org: string, name: string): Promise<Ok<"getDashboardSettings">>;
|
|
735
|
+
putDashboardSettings(org: string, name: string, settings: Schemas["DashboardSettings"]): Promise<Ok<"putDashboardSettings">>;
|
|
736
|
+
/** Deploy and OOM markers for every time series. */
|
|
737
|
+
getObservabilityMarkers(org: string, name: string, range?: {
|
|
738
|
+
from?: string;
|
|
739
|
+
to?: string;
|
|
740
|
+
}): Promise<Ok<"getObservabilityMarkers">>;
|
|
741
|
+
/** Watchdog insights (§17.10). Free: deploy regressions only. */
|
|
742
|
+
listInsights(org: string, name: string, opts?: {
|
|
743
|
+
state?: "open" | "resolved" | "all";
|
|
744
|
+
limit?: number;
|
|
745
|
+
}): Promise<Ok<"listInsights">>;
|
|
746
|
+
resolveInsight(org: string, name: string, id: string): Promise<void>;
|
|
747
|
+
/** Synthetic checks (§17.11): the uptime checks, including multi-step API checks. */
|
|
748
|
+
listSynthetics(org: string, name: string): Promise<Ok<"listSynthetics">>;
|
|
749
|
+
putSynthetic(org: string, name: string, id: string, input: Schemas["UptimeCheckInput"]): Promise<Ok<"putSynthetic">>;
|
|
750
|
+
deleteSynthetic(org: string, name: string, id: string): Promise<void>;
|
|
751
|
+
listSyntheticRuns(org: string, name: string, id: string, limit?: number): Promise<Ok<"listSyntheticRuns">>;
|
|
752
|
+
/** A public dashboard link. Needs no credential. */
|
|
753
|
+
getSharedDashboard(token: string): Promise<Ok<"getSharedDashboard">>;
|
|
754
|
+
getSharedDashboardWidgetData(token: string, widgetId: string, req?: Schemas["WidgetDataRequest"]): Promise<Ok<"getSharedDashboardWidgetData">>;
|
|
755
|
+
private obsApmPath;
|
|
756
|
+
getObsMetricsOverview(org: string, name: string, opts?: ObsRangeQuery & ObsRedQuery & {
|
|
757
|
+
groupBy?: "version";
|
|
758
|
+
}): Promise<Ok<"getObsMetricsOverview">>;
|
|
759
|
+
getObsMetricsMemory(org: string, name: string, opts?: ObsRangeQuery): Promise<Ok<"getObsMetricsMemory">>;
|
|
760
|
+
getObsMetricsInfrastructure(org: string, name: string, opts?: ObsRangeQuery): Promise<Ok<"getObsMetricsInfrastructure">>;
|
|
761
|
+
getObsMetricsCustom(org: string, name: string, opts: ObsRangeQuery & {
|
|
762
|
+
name: string;
|
|
763
|
+
agg?: string;
|
|
764
|
+
tags?: string;
|
|
765
|
+
groupBy?: string;
|
|
766
|
+
}): Promise<Ok<"getObsMetricsCustom">>;
|
|
767
|
+
getObsMetricsCustomNames(org: string, name: string): Promise<Ok<"getObsMetricsCustomNames">>;
|
|
768
|
+
listObsRoutes(org: string, name: string): Promise<Ok<"listObsRoutes">>;
|
|
769
|
+
putObsRoute(org: string, name: string, input: components["schemas"]["ObsRouteStateInput"]): Promise<Ok<"putObsRoute">>;
|
|
770
|
+
getObsAPMRoutes(org: string, name: string, opts?: ObsRangeQuery & ObsRedQuery): Promise<Ok<"getObsAPMRoutes">>;
|
|
771
|
+
getObsAPMBreakdown(org: string, name: string, route: string, opts?: ObsRangeQuery & {
|
|
772
|
+
version?: number;
|
|
773
|
+
}): Promise<Ok<"getObsAPMBreakdown">>;
|
|
774
|
+
getObsAPMServiceMap(org: string, name: string, opts?: ObsRangeQuery & {
|
|
775
|
+
version?: number;
|
|
776
|
+
}): Promise<Ok<"getObsAPMServiceMap">>;
|
|
777
|
+
getObsAPMCompare(org: string, name: string, a: number, b: number, opts?: ObsRangeQuery): Promise<Ok<"getObsAPMCompare">>;
|
|
778
|
+
listObsAPMTraces(org: string, name: string, opts?: {
|
|
779
|
+
from?: string;
|
|
780
|
+
to?: string;
|
|
781
|
+
before?: string;
|
|
782
|
+
route?: string;
|
|
783
|
+
status?: string;
|
|
784
|
+
minDuration?: number;
|
|
785
|
+
hasError?: boolean;
|
|
786
|
+
version?: number;
|
|
787
|
+
}): Promise<Ok<"listObsAPMTraces">>;
|
|
788
|
+
getObsAPMTrace(org: string, name: string, traceId: string): Promise<Ok<"getObsAPMTrace">>;
|
|
789
|
+
listObsTraceFilters(org: string, name: string): Promise<Ok<"listObsTraceFilters">>;
|
|
790
|
+
createObsTraceFilter(org: string, name: string, input: components["schemas"]["ObsTraceFilterInput"]): Promise<Ok<"createObsTraceFilter">>;
|
|
791
|
+
updateObsTraceFilter(org: string, name: string, id: string, input: components["schemas"]["ObsTraceFilterInput"]): Promise<Ok<"updateObsTraceFilter">>;
|
|
792
|
+
deleteObsTraceFilter(org: string, name: string, id: string): Promise<void>;
|
|
793
|
+
listObsDBQueries(org: string, name: string, opts?: {
|
|
794
|
+
from?: string;
|
|
795
|
+
to?: string;
|
|
796
|
+
}): Promise<Ok<"listObsDBQueries">>;
|
|
797
|
+
getObsDBQuery(org: string, name: string, fingerprint: string, opts?: {
|
|
798
|
+
from?: string;
|
|
799
|
+
to?: string;
|
|
800
|
+
}): Promise<Ok<"getObsDBQuery">>;
|
|
801
|
+
getObsDBHealth(org: string, name: string): Promise<Ok<"getObsDBHealth">>;
|
|
802
|
+
/** The continuous profiler's switch (customer-observability.md §17.13). */
|
|
803
|
+
getObsProfilerSettings(org: string, name: string): Promise<ObsProfilerSettings>;
|
|
804
|
+
/** On, off, or null for the default. Applies from the next deployment or restart. Admin. */
|
|
805
|
+
putObsProfilerSettings(org: string, name: string, enabled: boolean | null): Promise<ObsProfilerSettings>;
|
|
806
|
+
/** The logs/traces sampling override; a null field is the manifest's. */
|
|
807
|
+
getObsSampling(org: string, name: string): Promise<ObsSampling>;
|
|
808
|
+
/** Replaces the override (null = the manifest's). Admin. */
|
|
809
|
+
putObsSampling(org: string, name: string, body: ObsSampling): Promise<ObsSampling>;
|
|
810
|
+
listObsProfiles(org: string, name: string, q?: ObsProfileQuery): Promise<ObsProfileList>;
|
|
811
|
+
/** The windows within a minute of `ts` — the profile of a slow trace's minute. */
|
|
812
|
+
nearObsProfiles(org: string, name: string, ts: string): Promise<ObsProfileList>;
|
|
813
|
+
getObsFlamegraph(org: string, name: string, q?: Omit<ObsProfileQuery, "limit">): Promise<ObsFlamegraph>;
|
|
814
|
+
getObsProfileTop(org: string, name: string, q?: ObsProfileQuery): Promise<ObsProfileTop>;
|
|
815
|
+
/** Self-time share per function, version a against version b. */
|
|
816
|
+
compareObsProfiles(org: string, name: string, a: number, b: number, q?: Pick<ObsProfileQuery, "from" | "to">): Promise<ObsProfileCompare>;
|
|
817
|
+
/** RUM: page views, sessions and p75 vitals over time (Pro). */
|
|
818
|
+
getObsRUMOverview(org: string, name: string, q?: ObsRUMQuery): Promise<ObsRUMOverview>;
|
|
819
|
+
/** RUM by page template, with vitals, long tasks and resource/fetch timings (Pro). */
|
|
820
|
+
listObsRUMPages(org: string, name: string, q?: ObsRUMQuery & {
|
|
821
|
+
sort?: "views" | "lcp" | "inp" | "cls";
|
|
822
|
+
}): Promise<ObsRUMPages>;
|
|
823
|
+
/** RUM by device class (Pro). */
|
|
824
|
+
listObsRUMDevices(org: string, name: string, q?: ObsRUMQuery): Promise<ObsRUMDevices>;
|
|
825
|
+
/** RUM page views, newest (or slowest LCP) first (Pro). */
|
|
826
|
+
listObsRUMViews(org: string, name: string, q?: ObsRUMQuery & {
|
|
827
|
+
session?: string;
|
|
828
|
+
sort?: "recent" | "slowest";
|
|
829
|
+
limit?: number;
|
|
830
|
+
}): Promise<ObsRUMViewList>;
|
|
831
|
+
/** One page view and the server requests it caused (Pro). */
|
|
832
|
+
getObsRUMView(org: string, name: string, viewId: string): Promise<ObsRUMView>;
|
|
833
|
+
/** Starts one heap snapshot (Pro, admin; pauses the app while taken). Poll the list. */
|
|
834
|
+
createObsHeapSnapshot(org: string, name: string): Promise<ObsHeapSnapshot>;
|
|
835
|
+
listObsHeapSnapshots(org: string, name: string): Promise<ObsHeapSnapshotList>;
|
|
836
|
+
/** The download URL of a ready snapshot (a `.heapsnapshot` file). */
|
|
837
|
+
obsHeapSnapshotURL(org: string, name: string, snapshotId: string): string;
|
|
838
|
+
/** A ready snapshot's text (Chrome DevTools heap snapshot JSON). */
|
|
839
|
+
downloadObsHeapSnapshot(org: string, name: string, snapshotId: string): Promise<string>;
|
|
840
|
+
getErrorOwnership(org: string, name: string): Promise<Ok<"getErrorOwnership">>;
|
|
841
|
+
createErrorOwnershipPin(org: string, name: string, input: Schemas["ErrorOwnershipPinInput"]): Promise<Ok<"createErrorOwnershipPin">>;
|
|
842
|
+
revokeErrorOwnershipPin(org: string, name: string, deploymentId: string, selector: string): Promise<void>;
|
|
843
|
+
getErrorCapturePolicy(org: string, name: string): Promise<Ok<"getErrorCapturePolicy">>;
|
|
844
|
+
putErrorCapturePolicy(org: string, name: string, policy: ErrorCapturePolicy, acknowledgePII?: boolean): Promise<Ok<"putErrorCapturePolicy">>;
|
|
845
|
+
private obsPath;
|
|
846
|
+
getObservabilityCapabilities(org: string, name: string): Promise<Ok<"getObservabilityCapabilities">>;
|
|
847
|
+
/** Runs a query; `{ available: false }` where there is no event store. */
|
|
848
|
+
queryObservability(org: string, name: string, query: ObsQuery): Promise<Ok<"queryObservability">>;
|
|
849
|
+
listObservabilityKeys(org: string, name: string, opts?: {
|
|
850
|
+
since?: string;
|
|
851
|
+
until?: string;
|
|
852
|
+
view?: "events" | "invocations" | "spans";
|
|
853
|
+
}): Promise<Ok<"listObservabilityKeys">>;
|
|
854
|
+
listObservabilityValues(org: string, name: string, key: string, opts?: {
|
|
855
|
+
since?: string;
|
|
856
|
+
until?: string;
|
|
857
|
+
view?: "events" | "invocations" | "spans";
|
|
858
|
+
}): Promise<Ok<"listObservabilityValues">>;
|
|
859
|
+
listObservabilityPatterns(org: string, name: string, opts?: {
|
|
860
|
+
since?: string;
|
|
861
|
+
until?: string;
|
|
862
|
+
level?: string;
|
|
863
|
+
}): Promise<Ok<"listObservabilityPatterns">>;
|
|
864
|
+
getObservabilityRequest(org: string, name: string, requestId: string): Promise<Ok<"getObservabilityRequest">>;
|
|
865
|
+
listSavedQueries(org: string, name: string): Promise<Ok<"listSavedQueries">>;
|
|
866
|
+
getSavedQuery(org: string, name: string, queryId: string): Promise<Ok<"getSavedQuery">>;
|
|
867
|
+
createSavedQuery(org: string, name: string, input: SavedQueryInput): Promise<Ok<"createSavedQuery">>;
|
|
868
|
+
updateSavedQuery(org: string, name: string, queryId: string, input: SavedQueryInput): Promise<Ok<"updateSavedQuery">>;
|
|
869
|
+
deleteSavedQuery(org: string, name: string, queryId: string): Promise<void>;
|
|
870
|
+
starSavedQuery(org: string, name: string, queryId: string): Promise<Ok<"starSavedQuery">>;
|
|
871
|
+
unstarSavedQuery(org: string, name: string, queryId: string): Promise<Ok<"unstarSavedQuery">>;
|
|
872
|
+
getObservabilityPipeline(org: string, name: string): Promise<Ok<"getObservabilityPipeline">>;
|
|
873
|
+
putObservabilityPipeline(org: string, name: string, processors: ObsProcessor[]): Promise<Ok<"putObservabilityPipeline">>;
|
|
874
|
+
getObservabilityScanner(org: string, name: string): Promise<Ok<"getObservabilityScanner">>;
|
|
875
|
+
putObservabilityScanner(org: string, name: string, scanner: ObsScannerConfig): Promise<Ok<"putObservabilityScanner">>;
|
|
876
|
+
/** Runs a scanner (the project's, or `scanner`) over a sample; nothing is stored. */
|
|
877
|
+
testObservabilityScanner(org: string, name: string, text: string, scanner?: ObsScannerConfig): Promise<Ok<"testObservabilityScanner">>;
|
|
878
|
+
/** The whole ingest configuration, shaped as `.runlot/logs.json`. */
|
|
879
|
+
exportObservabilityLogsConfig(org: string, name: string): Promise<Ok<"exportObservabilityLogsConfig">>;
|
|
880
|
+
listObservabilityLogMetrics(org: string, name: string): Promise<Ok<"listObservabilityLogMetrics">>;
|
|
881
|
+
putObservabilityLogMetric(org: string, name: string, metric: string, def: ObsLogMetric): Promise<Ok<"putObservabilityLogMetric">>;
|
|
882
|
+
deleteObservabilityLogMetric(org: string, name: string, metric: string): Promise<void>;
|
|
883
|
+
getErrorEventPII(org: string, name: string, issueId: string, eventId: string): Promise<Ok<"getErrorEvent">>;
|
|
884
|
+
getErrorSettings(org: string, name: string): Promise<Ok<"getErrorSettings">>;
|
|
885
|
+
putErrorSettings(org: string, name: string,
|
|
886
|
+
/** Omitted writable fields preserve their values; ownership assignment defaults off. */
|
|
887
|
+
settings: Schemas["ErrorSettingsUpdate"]): Promise<Ok<"putErrorSettings">>;
|
|
888
|
+
/**
|
|
889
|
+
* One AI diagnosis of an issue, billed to the org's AI credit. There is no
|
|
890
|
+
* prompt to pass: the control plane builds it from the issue's stored event.
|
|
891
|
+
* The same `idempotencyKey` again returns the stored answer without a second
|
|
892
|
+
* charge, so a caller retrying after a timeout must reuse its key.
|
|
893
|
+
*/
|
|
894
|
+
diagnoseErrorIssue(org: string, name: string, issueId: string, body: {
|
|
895
|
+
model: string;
|
|
896
|
+
idempotencyKey: string;
|
|
897
|
+
}): Promise<Ok<"diagnoseErrorIssue">>;
|
|
898
|
+
listErrorDiagnoses(org: string, name: string, issueId: string): Promise<Ok<"listErrorDiagnoses">>;
|
|
899
|
+
private fixPath;
|
|
900
|
+
/**
|
|
901
|
+
* Ask a model to propose a fix for an issue. Billed to the org's AI credit and
|
|
902
|
+
* writes nothing: the repository, base commit and files are chosen by the control
|
|
903
|
+
* plane. Reuse `idempotencyKey` on a retry so it is not charged twice.
|
|
904
|
+
*/
|
|
905
|
+
proposeErrorFix(org: string, name: string, issueId: string, body: {
|
|
906
|
+
model: string;
|
|
907
|
+
idempotencyKey: string;
|
|
908
|
+
}): Promise<Ok<"proposeErrorFix">>;
|
|
909
|
+
listErrorFixProposals(org: string, name: string, issueId: string): Promise<Ok<"listErrorFixProposals">>;
|
|
910
|
+
getErrorFixProposal(org: string, name: string, issueId: string, proposalId: string): Promise<Ok<"getErrorFixProposal">>;
|
|
911
|
+
/**
|
|
912
|
+
* Write a ready proposal as one commit on its own `runlot/autofix/` branch. It
|
|
913
|
+
* builds, deploys and merges nothing. `proposalSha` must be the proposal's exactly.
|
|
914
|
+
*/
|
|
915
|
+
applyErrorFix(org: string, name: string, issueId: string, proposalId: string, proposalSha: string): Promise<Ok<"applyErrorFix">>;
|
|
916
|
+
lookupErrorFixProposal(org: string, name: string, issueId: string, key: string): Promise<ErrorFixProposal>;
|
|
917
|
+
lookupErrorFixPreview(org: string, name: string, issueId: string, proposalId: string, key: string): Promise<ErrorFixPreview>;
|
|
918
|
+
lookupErrorFixVerification(org: string, name: string, issueId: string, proposalId: string, jobId: string, key: string): Promise<ErrorFixPreviewVerification>;
|
|
919
|
+
approveErrorFixPreview(org: string, name: string, issueId: string, proposalId: string, body: ErrorFixPreviewApproval): Promise<Ok<"approveErrorFixPreview">>;
|
|
920
|
+
getErrorFixPreview(org: string, name: string, issueId: string, proposalId: string, jobId: string): Promise<Ok<"getErrorFixPreview">>;
|
|
921
|
+
approveErrorFixPreviewVerification(org: string, name: string, issueId: string, proposalId: string, jobId: string, body: ErrorFixPreviewVerificationApproval): Promise<Ok<"approveErrorFixPreviewVerification">>;
|
|
922
|
+
/** Erase captured issue data, after explicit review. Admin; unmerge first. */
|
|
923
|
+
deleteErrorIssue(org: string, name: string, issueId: string): Promise<Ok<"deleteErrorIssue">>;
|
|
924
|
+
/** Erase an exact application user ID; anonymous aggregates remain. Admin. */
|
|
925
|
+
eraseErrorUser(org: string, name: string, userId: string): Promise<Ok<"eraseErrorUser">>;
|
|
926
|
+
/** Untrusted browser histograms and technical-fuse counters, not billed usage. Viewer. */
|
|
927
|
+
getBrowserTelemetry(org: string, name: string): Promise<Ok<"getBrowserTelemetry">>;
|
|
928
|
+
/** Unverified feedback whose exact browser error anchor belongs to this issue. Never includes email. */
|
|
929
|
+
listBrowserFeedback(org: string, name: string, issueId: string): Promise<Ok<"listBrowserFeedback">>;
|
|
930
|
+
/** Explicit sensitive read. Admin + errors:pii; optional unverified email only while feedback-email retention is on. */
|
|
931
|
+
listBrowserFeedbackWithPII(org: string, name: string, issueId: string): Promise<Ok<"listBrowserFeedback">>;
|
|
932
|
+
/** The masked structural replay switch, cap and this month's count. Viewer. */
|
|
933
|
+
getErrorReplaySettings(org: string, name: string): Promise<Ok<"getErrorReplaySettings">>;
|
|
934
|
+
/**
|
|
935
|
+
* Both fields are required: `monthlyCap` null is the plan's amount, `0` stops collection,
|
|
936
|
+
* `-1` removes the cap (Pro). Admin.
|
|
937
|
+
*/
|
|
938
|
+
putErrorReplaySettings(org: string, name: string, settings: {
|
|
939
|
+
enabled: boolean;
|
|
940
|
+
monthlyCap: number | null;
|
|
941
|
+
}): Promise<Ok<"putErrorReplaySettings">>;
|
|
942
|
+
/** An issue's complete masked structural replays. Admin, until a granular PII scope exists. */
|
|
943
|
+
listErrorReplays(org: string, name: string, issueId: string): Promise<Ok<"listErrorReplays">>;
|
|
944
|
+
/** One replay and its re-validated batches, for the sandboxed player. Admin. */
|
|
945
|
+
getErrorReplay(org: string, name: string, issueId: string, replayId: string): Promise<Ok<"getErrorReplay">>;
|
|
502
946
|
/**
|
|
503
947
|
* Scheduled runs: what the live deployment declares, when each fires next, and
|
|
504
948
|
* the recent history (docs/cron.md §8). `limit` bounds the history rows only —
|
|
@@ -701,7 +1145,17 @@ export declare class Client {
|
|
|
701
1145
|
tail?: number;
|
|
702
1146
|
follow?: boolean;
|
|
703
1147
|
signal?: AbortSignal;
|
|
704
|
-
}): AsyncGenerator<LogEvent, void, undefined>;
|
|
1148
|
+
} & LogTailFilter): AsyncGenerator<LogEvent, void, undefined>;
|
|
1149
|
+
/**
|
|
1150
|
+
* The live tail as `LogRecord`s — the stored event's shape (`--format json`).
|
|
1151
|
+
* Pings and the end event still arrive as `LogEvent`s.
|
|
1152
|
+
*/
|
|
1153
|
+
tailLogRecords(org: string, name: string, opts?: {
|
|
1154
|
+
tail?: number;
|
|
1155
|
+
follow?: boolean;
|
|
1156
|
+
signal?: AbortSignal;
|
|
1157
|
+
} & LogTailFilter): AsyncGenerator<LogRecord | LogEvent, void, undefined>;
|
|
1158
|
+
private tailStream;
|
|
705
1159
|
/**
|
|
706
1160
|
* The stored lane (0062). It is a plain JSON page, not a stream: the history
|
|
707
1161
|
* does not reach a node, so it answers for a project that is cold, parked, or
|
|
@@ -1134,4 +1588,25 @@ export declare class Client {
|
|
|
1134
1588
|
private repoPath;
|
|
1135
1589
|
rollback(org: string, name: string, version: number): Promise<Ok<"rollback">>;
|
|
1136
1590
|
}
|
|
1591
|
+
/** A metric read's range (customer-observability.md §8). */
|
|
1592
|
+
export type ObsRangeQuery = {
|
|
1593
|
+
from?: string;
|
|
1594
|
+
to?: string;
|
|
1595
|
+
step?: string;
|
|
1596
|
+
};
|
|
1597
|
+
/** RED filters shared by the overview and the APM routes. */
|
|
1598
|
+
export type ObsRedQuery = {
|
|
1599
|
+
version?: number;
|
|
1600
|
+
handler?: string;
|
|
1601
|
+
route?: string;
|
|
1602
|
+
synthetic?: "exclude" | "include" | "only";
|
|
1603
|
+
};
|
|
1604
|
+
export type ObsMetricsOverview = components["schemas"]["ObsMetricsOverview"];
|
|
1605
|
+
export type ObsAPMRoutes = components["schemas"]["ObsAPMRoutes"];
|
|
1606
|
+
export type ObsTrace = components["schemas"]["ObsTrace"];
|
|
1607
|
+
export type ObsTraceFilter = components["schemas"]["ObsTraceFilter"];
|
|
1608
|
+
export type ReleaseIssuePage = components["schemas"]["ReleaseIssuePage"];
|
|
1609
|
+
export type ReleaseIssueTransition = components["schemas"]["ReleaseIssueTransition"];
|
|
1610
|
+
export type ReleaseHealthSummary = components["schemas"]["ReleaseHealthSummary"];
|
|
1611
|
+
export type ReleaseHealthRelease = components["schemas"]["ReleaseHealthRelease"];
|
|
1137
1612
|
//# sourceMappingURL=index.d.ts.map
|