overlane ci usage | Overlane Docs

Shows the minutes metered for the team this month, the cost at the runner rates, tests marked flaky in the last 7 days (two marks in a week open an issue), and for the last 7 days the share of jobs with a database on each placement and the most common reasons a database ran in the job’s container.

Usage

overlane ci usage

Examples

overlane ci usage

Behavior

Effect: read (changes nothing).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: no. Accepts --force: no.
Machine-readable description: overlane schema ci usage.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
      "description": "tenant identifier"
    },
    "month": {
      "type": "string"
    },
    "minutes": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "costMicros": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "runs": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "flaky": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "test": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "test",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "databases": {
      "type": "object",
      "properties": {
        "since": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "jobs": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "placements": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "runtime": {
                "type": "string",
                "enum": [
                  "durable-object-sqlite",
                  "pglite",
                  "external",
                  "container"
                ]
              },
              "jobs": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "percent": {
                "type": "number",
                "minimum": 0,
                "maximum": 100
              }
            },
            "required": [
              "runtime",
              "jobs",
              "percent"
            ],
            "additionalProperties": false
          }
        },
        "containerReasons": {
          "maxItems": 5,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "reason": {
                "type": "string"
              },
              "jobs": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "reason",
              "jobs"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "since",
        "jobs",
        "placements",
        "containerReasons"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "tenantId",
    "month",
    "minutes",
    "costMicros",
    "runs",
    "flaky",
    "databases"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.