From 5c7a016d4e79b78f7f8da6c7b2d4539a77f1c4d4 Mon Sep 17 00:00:00 2001 From: ryank90 Date: Sun, 6 Sep 2026 09:28:15 +0100 Subject: [PATCH] docs(serverless): restate usage and logs stubs as blocked work Usage is a future billing report, not raw worker-transition rows. Logs cannot stream and the query route still 404s. Co-authored-by: Cursor --- docs/runware_serverless.md | 2 +- docs/runware_serverless_apps.md | 2 +- docs/runware_serverless_apps_logs.md | 9 ++++++++- docs/runware_serverless_apps_usage.md | 12 ++++++++++-- docs/runware_serverless_usage.md | 15 +++++++++++++-- internal/cmd/serverless/apps.go | 21 ++++++++++++++++----- internal/cmd/serverless/usage.go | 15 ++++++++++++--- 7 files changed, 61 insertions(+), 15 deletions(-) diff --git a/docs/runware_serverless.md b/docs/runware_serverless.md index 2f49b40..e50525b 100644 --- a/docs/runware_serverless.md +++ b/docs/runware_serverless.md @@ -29,6 +29,6 @@ Deploy, monitor, and manage Runware serverless applications on the platform * [runware serverless gpus](runware_serverless_gpus.md) - List available GPU types and pricing * [runware serverless open](runware_serverless_open.md) - Open an application in the Runware dashboard * [runware serverless secrets](runware_serverless_secrets.md) - Manage organisation secrets for serverless applications -* [runware serverless usage](runware_serverless_usage.md) - Show serverless usage and billing events +* [runware serverless usage](runware_serverless_usage.md) - Show account-wide usage and cost * [runware serverless use](runware_serverless_use.md) - Set the default serverless application diff --git a/docs/runware_serverless_apps.md b/docs/runware_serverless_apps.md index df6ffda..e3e5c3a 100644 --- a/docs/runware_serverless_apps.md +++ b/docs/runware_serverless_apps.md @@ -40,7 +40,7 @@ runware serverless apps [flags] * [runware serverless apps show](runware_serverless_apps_show.md) - Show details for a serverless application * [runware serverless apps stop](runware_serverless_apps_stop.md) - Stop a serverless application * [runware serverless apps tasks](runware_serverless_apps_tasks.md) - List and inspect application tasks -* [runware serverless apps usage](runware_serverless_apps_usage.md) - Show usage for a serverless application +* [runware serverless apps usage](runware_serverless_apps_usage.md) - Show usage and cost for a serverless application * [runware serverless apps versions](runware_serverless_apps_versions.md) - Manage application versions * [runware serverless apps workers](runware_serverless_apps_workers.md) - List workers for a serverless application diff --git a/docs/runware_serverless_apps_logs.md b/docs/runware_serverless_apps_logs.md index 1f4f452..f989b29 100644 --- a/docs/runware_serverless_apps_logs.md +++ b/docs/runware_serverless_apps_logs.md @@ -2,6 +2,13 @@ Show logs for a serverless application +### Synopsis + +Show application logs. + +This command is not implemented yet. The log-query route exists but currently +answers 404 until a follow-up ADR; live tail is not supported. + ``` runware serverless apps logs [flags] ``` @@ -9,7 +16,7 @@ runware serverless apps logs [flags] ### Examples ``` - # fetch or stream logs for an application + # show application logs (not available yet) runware serverless apps logs my-app ``` diff --git a/docs/runware_serverless_apps_usage.md b/docs/runware_serverless_apps_usage.md index 8ebe4c1..537f4d7 100644 --- a/docs/runware_serverless_apps_usage.md +++ b/docs/runware_serverless_apps_usage.md @@ -1,6 +1,14 @@ ## runware serverless apps usage -Show usage for a serverless application +Show usage and cost for a serverless application + +### Synopsis + +Show an aggregated usage and cost report for one application. + +This command is not implemented yet. Billing rollups are not in the API, so +there is no per-app report to list. When the report API exists, this will be +the account-wide usage command scoped to one appId. ``` runware serverless apps usage [flags] @@ -9,7 +17,7 @@ runware serverless apps usage [flags] ### Examples ``` - # show usage events for an application + # show usage for an application (not available yet) runware serverless apps usage my-app ``` diff --git a/docs/runware_serverless_usage.md b/docs/runware_serverless_usage.md index 7569e38..9ca471b 100644 --- a/docs/runware_serverless_usage.md +++ b/docs/runware_serverless_usage.md @@ -1,6 +1,17 @@ ## runware serverless usage -Show serverless usage and billing events +Show account-wide usage and cost + +### Synopsis + +Show an aggregated usage and cost report for the authenticated organisation. + +This command is not implemented yet. Billing rollups are not in the API, so +there is no report to list. Raw worker-transition rows (GET /v1/usage) are +not this command. + +When the report API exists, this will cover an account-wide window with the +filters that endpoint exposes. ``` runware serverless usage [flags] @@ -9,7 +20,7 @@ runware serverless usage [flags] ### Examples ``` - # list usage events for the authenticated organisation + # show account-wide usage (not available yet) runware serverless usage ``` diff --git a/internal/cmd/serverless/apps.go b/internal/cmd/serverless/apps.go index 36285ba..ba66697 100644 --- a/internal/cmd/serverless/apps.go +++ b/internal/cmd/serverless/apps.go @@ -188,13 +188,18 @@ func newAppsEndpointsCmd(logger *log.Logger) *cobra.Command { } func newAppsLogsCmd() *cobra.Command { - return stubLeaf( + cmd := stubLeaf( "logs ", "Show logs for a serverless application", - ` # fetch or stream logs for an application + ` # show application logs (not available yet) runware serverless apps logs my-app`, cobra.ExactArgs(1), ) + cmd.Long = `Show application logs. + +This command is not implemented yet. The log-query route exists but currently +answers 404 until a follow-up ADR; live tail is not supported.` + return cmd } func newAppsWorkersCmd(logger *log.Logger) *cobra.Command { @@ -349,11 +354,17 @@ func listPageParams(limit int, cursor string) (*serverlessapi.Limit, *serverless } func newAppsUsageCmd() *cobra.Command { - return stubLeaf( + cmd := stubLeaf( "usage ", - "Show usage for a serverless application", - ` # show usage events for an application + "Show usage and cost for a serverless application", + ` # show usage for an application (not available yet) runware serverless apps usage my-app`, cobra.ExactArgs(1), ) + cmd.Long = `Show an aggregated usage and cost report for one application. + +This command is not implemented yet. Billing rollups are not in the API, so +there is no per-app report to list. When the report API exists, this will be +the account-wide usage command scoped to one appId.` + return cmd } diff --git a/internal/cmd/serverless/usage.go b/internal/cmd/serverless/usage.go index eeaed5b..2780b5a 100644 --- a/internal/cmd/serverless/usage.go +++ b/internal/cmd/serverless/usage.go @@ -3,11 +3,20 @@ package serverless import "github.com/spf13/cobra" func newUsageCmd() *cobra.Command { - return stubLeaf( + cmd := stubLeaf( "usage", - "Show serverless usage and billing events", - ` # list usage events for the authenticated organisation + "Show account-wide usage and cost", + ` # show account-wide usage (not available yet) runware serverless usage`, cobra.NoArgs, ) + cmd.Long = `Show an aggregated usage and cost report for the authenticated organisation. + +This command is not implemented yet. Billing rollups are not in the API, so +there is no report to list. Raw worker-transition rows (GET /v1/usage) are +not this command. + +When the report API exists, this will cover an account-wide window with the +filters that endpoint exposes.` + return cmd }