@tailglow/cli 0.5.0 → 0.5.1
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/package.json +1 -1
- package/src/commands.generated.js +109 -2
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tailglow/cli",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "The Tailglow command line. Every command is generated from the Tailglow API reference, so the CLI and the documentation can never describe different APIs.",
|
|
6
6
|
"bin": {
|
|
@@ -463,6 +463,97 @@ export const CLI_COMMANDS = [
|
|
|
463
463
|
"query_params": [],
|
|
464
464
|
"body_fields": []
|
|
465
465
|
},
|
|
466
|
+
{
|
|
467
|
+
"resource": "projects",
|
|
468
|
+
"command": "usage",
|
|
469
|
+
"operation_id": "getProjectUsage",
|
|
470
|
+
"summary": "Retrieve Project Usage",
|
|
471
|
+
"description": "Retrieve how much the project stored over a time range.",
|
|
472
|
+
"method": "GET",
|
|
473
|
+
"path": "/v1/projects/:project_id/usage",
|
|
474
|
+
"alternate_paths": [],
|
|
475
|
+
"scopes": [
|
|
476
|
+
"projects:read"
|
|
477
|
+
],
|
|
478
|
+
"notes": [
|
|
479
|
+
"Readings are taken hourly and are the same measurements the project is billed on. Gigabytes are logical (uncompressed) bytes.",
|
|
480
|
+
"`interval=day` returns the last reading of each UTC day rather than an average, so a row is what the project held when the day closed. Its `sampled_at` is that reading's own hour.",
|
|
481
|
+
"Readings start when Tailglow began recording them, so a range reaching further back returns nothing for the hours before that.",
|
|
482
|
+
"`start_at` must be earlier than `end_at`, and the range cannot be longer than 400 days."
|
|
483
|
+
],
|
|
484
|
+
"path_params": [
|
|
485
|
+
{
|
|
486
|
+
"name": "project_id",
|
|
487
|
+
"type": "string",
|
|
488
|
+
"required": true,
|
|
489
|
+
"description": "Unique identifier of the project.",
|
|
490
|
+
"allowed_values": [],
|
|
491
|
+
"deprecated": null
|
|
492
|
+
}
|
|
493
|
+
],
|
|
494
|
+
"query_params": [
|
|
495
|
+
{
|
|
496
|
+
"name": "start_at",
|
|
497
|
+
"type": "ISODateString",
|
|
498
|
+
"required": true,
|
|
499
|
+
"description": "Start of the range, inclusive (ISO format).",
|
|
500
|
+
"allowed_values": [],
|
|
501
|
+
"deprecated": null
|
|
502
|
+
},
|
|
503
|
+
{
|
|
504
|
+
"name": "end_at",
|
|
505
|
+
"type": "ISODateString",
|
|
506
|
+
"required": false,
|
|
507
|
+
"description": "End of the range, inclusive (ISO format, default: now). Optional.",
|
|
508
|
+
"allowed_values": [],
|
|
509
|
+
"deprecated": null
|
|
510
|
+
},
|
|
511
|
+
{
|
|
512
|
+
"name": "interval",
|
|
513
|
+
"type": "string",
|
|
514
|
+
"required": false,
|
|
515
|
+
"description": "Reading cadence returned: every hourly reading, or one reading per UTC day. Optional. Defaults to `\"hour\"`.",
|
|
516
|
+
"allowed_values": [
|
|
517
|
+
"hour",
|
|
518
|
+
"day"
|
|
519
|
+
],
|
|
520
|
+
"deprecated": null
|
|
521
|
+
}
|
|
522
|
+
],
|
|
523
|
+
"body_fields": []
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"resource": "projects",
|
|
527
|
+
"command": "attention",
|
|
528
|
+
"operation_id": "getProjectAttention",
|
|
529
|
+
"summary": "Retrieve Project Attention",
|
|
530
|
+
"description": "Retrieve everything in the project that is asking for a human right now.",
|
|
531
|
+
"method": "GET",
|
|
532
|
+
"path": "/v1/projects/:project_id/attention",
|
|
533
|
+
"alternate_paths": [],
|
|
534
|
+
"scopes": [
|
|
535
|
+
"projects:read"
|
|
536
|
+
],
|
|
537
|
+
"notes": [
|
|
538
|
+
"An item appears only when Tailglow entered a state on its own. Anything a project chose, such as a paused pull, a paused drain, or a paused monitor, is never reported here.",
|
|
539
|
+
"`tier` orders the list. `losing_data` means requests are being refused right now, within the last 5 minutes: for a reason a retry cannot fix, or for capacity after at least 5 minutes of unbroken refusals. `firing` means a monitor or check the project set up is currently triggered, or a server has run under sustained heavy load. `stalled` means a pipeline stopped making progress and its data is going stale. `suspended` means Tailglow switched something off and it stays off until it is fixed. `resolved` means refusals that lost data have stopped; `ended_at` says when.",
|
|
540
|
+
"Items disappear the moment their condition clears, with one exception so a loss is not missed: refusals that stop stay as `resolved`, for up to 24 hours for a key or payload refusal and up to an hour for capacity. A refusal item's `count` covers that whole window, not only the current spell. Refusals only count as stopped once every running server that was refusing has reported since; until then the item stays `losing_data`. Readings from the project's servers are cached briefly, so a condition that just started can take up to a minute to appear.",
|
|
541
|
+
"Items cover only resources the caller's key or role can read: without a resource's read permission, its conditions are left out. Refusal and server load items need `servers:read`, and firing monitors need `alerts:read`.",
|
|
542
|
+
"Items are already ranked, most urgent first. One item covers each firing monitor, and each view's failing transforms, joins, or shape waits. The response is capped per condition so a project in a bad state returns a readable list rather than every affected resource."
|
|
543
|
+
],
|
|
544
|
+
"path_params": [
|
|
545
|
+
{
|
|
546
|
+
"name": "project_id",
|
|
547
|
+
"type": "string",
|
|
548
|
+
"required": true,
|
|
549
|
+
"description": "Unique identifier of the project.",
|
|
550
|
+
"allowed_values": [],
|
|
551
|
+
"deprecated": null
|
|
552
|
+
}
|
|
553
|
+
],
|
|
554
|
+
"query_params": [],
|
|
555
|
+
"body_fields": []
|
|
556
|
+
},
|
|
466
557
|
{
|
|
467
558
|
"resource": "sources",
|
|
468
559
|
"command": "list",
|
|
@@ -6749,6 +6840,7 @@ export const CLI_COMMANDS = [
|
|
|
6749
6840
|
"At least one field must be provided.",
|
|
6750
6841
|
"Only team Owners can change billing, security, or account settings. Other members can update `name` and `logo_url` only.",
|
|
6751
6842
|
"`status`, `max_servers_per_project`, and `deleted_at` are managed by Tailglow and cannot be set by team members.",
|
|
6843
|
+
"`status` requires `expected_status`, the status you loaded; the change is refused with a conflict if the team's status has changed since.",
|
|
6752
6844
|
"Changing `is_mfa_required` requires a recently verified multi-factor sign-in.",
|
|
6753
6845
|
"Moving to a plan that bills a payment method requires a valid payment method on the team.",
|
|
6754
6846
|
"`billing_email` cannot use the `@tailglow.io` domain.",
|
|
@@ -6806,6 +6898,19 @@ export const CLI_COMMANDS = [
|
|
|
6806
6898
|
],
|
|
6807
6899
|
"deprecated": null
|
|
6808
6900
|
},
|
|
6901
|
+
{
|
|
6902
|
+
"name": "expected_status",
|
|
6903
|
+
"type": "TeamStatus",
|
|
6904
|
+
"required": false,
|
|
6905
|
+
"description": "The status the team had when you loaded it. Required with `status`; the change is refused if the status has changed since. Optional.",
|
|
6906
|
+
"allowed_values": [
|
|
6907
|
+
"active",
|
|
6908
|
+
"restricted",
|
|
6909
|
+
"delinquent",
|
|
6910
|
+
"blocked"
|
|
6911
|
+
],
|
|
6912
|
+
"deprecated": null
|
|
6913
|
+
},
|
|
6809
6914
|
{
|
|
6810
6915
|
"name": "is_mfa_required",
|
|
6811
6916
|
"type": "boolean",
|
|
@@ -10374,7 +10479,8 @@ export const CLI_COMMANDS = [
|
|
|
10374
10479
|
"alternate_paths": [],
|
|
10375
10480
|
"scopes": [],
|
|
10376
10481
|
"notes": [
|
|
10377
|
-
"You can retrieve your own authentication logs without `logs:read`.
|
|
10482
|
+
"You can retrieve your own authentication logs without `logs:read`. Billing logs require `billing:read`; all other log reads require `logs:read`.",
|
|
10483
|
+
"Without `type`, the list includes every type you can read. `admin_auth` logs exist only on Tailglow's own admin team.",
|
|
10378
10484
|
"`after` and `before` are mutually exclusive."
|
|
10379
10485
|
],
|
|
10380
10486
|
"path_params": [],
|
|
@@ -10429,7 +10535,8 @@ export const CLI_COMMANDS = [
|
|
|
10429
10535
|
"allowed_values": [
|
|
10430
10536
|
"auth",
|
|
10431
10537
|
"admin_auth",
|
|
10432
|
-
"audit"
|
|
10538
|
+
"audit",
|
|
10539
|
+
"billing"
|
|
10433
10540
|
],
|
|
10434
10541
|
"deprecated": null
|
|
10435
10542
|
},
|