Skip to main content

Manage tenant usage

In this tutorial, you will learn how to manage tenant usage using the EDK CLI, this lesson is applicable if you have been given a cluster_admin role.

To get help with commands for managing usage within tenants, you can use the edk tenant usage --help command.

Usage: edk tenant usage [options]

get data and compute usage for the tenant

Options:
  -s, --server <server>  the server to target
  --from <from>          start of date range to search
  --to <to>              end of date range to search
  -r, --raw              raw output (default: false)
  -h, --help             display help for command

View Usage

If you have been provided the cluster_admin role, you can list the data and compute usage in the current tenant context by running edk tenant usage in the command-line.

Run the following command:

edk tenant usage

Which will result in:

================================================================================
Data and compute usage for tenant
================================================================================
Tenant: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
From: no lower bound
To: no upper bound

Data Usage History
WORKSPACE_NAME    WORKSPACE_UUID                       TOTAL_VERSIONS TOTAL_BYTES GB_HOURS               CREATED_AT               DELETED_AT               FROM                     TO
WorkspaceOne      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX 164            676101026   297.4926261850398842   YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceOne      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX 55             329024600   144.5910308732726680   YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceOne      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX 44             339400564   149.0624633063305284   YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceTwo      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX 3056           6451758807  3644.5054284238827708  YYYY-MM-DDTHH:MM:SS.MSZ                           YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ

Compute Usage History
WORKSPACE_NAME    WORKSPACE_UUID                       TASK_TYPE           COMPUTE_MINUTES        TOTAL_ATTEMPTS TOTAL_SUCCESS TOTAL_WARN TOTAL_FAIL TOTAL_ERROR TOTAL_CANCELLED CREATED_AT               DELETED_AT
WorkspaceOne      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX pipeline            0.52945141666666666667 90             90            0          0          0           0               YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceOne      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX custom_optimization 8.5435721833333333     6              0             0          0          6           0               YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceOne      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX custom_optimization 10.7420537500000000    2              0             0          1          1           0               YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceOne      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX pipeline            0.16538775000000000000 30             30            0          0          0           0               YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceOne      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX custom_optimization 12.7478547500000000    1              1             0          0          0           0               YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceOne      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX pipeline            0.12285060000000000000 18             18            0          0          0           0               YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceTwo      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX pipeline            6.9319830833333333     1258           1252          0          0          6           0               YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceTwo      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX custom_optimization 1615.7886724666666667  131            84            0          8          36          3               YYYY-MM-DDTHH:MM:SS.MSZ
WorkspaceTwo      XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX source              0.02785315000000000000 8              5             0          3          0           0               YYYY-MM-DDTHH:MM:SS.MSZ

Data Usage

Data usage within a tenant is measured per workspace instance, the important metrics are summarised as:

MeasureDefinition
Total VersionsThe total number version changes that the data in the workspace instance has experienced.
Total BytesThe total number of bytes used by the data in the workspace instance.
GB HoursThe total number of GB hours calculate as storage / time the instance exists.

Compute Usage

Compute usage within a tenant is measured per task per workspace instance, the important metrics are summarised as:

MeasureDefinition
Compute MinutesThe total amount of minutes the task spent computing.
Total AttemptsThe total number of attempts to run the task.
Total SuccessThe total number of times the task was successfully run.
Total WarnThe total number of times the task was successfully run with a warning.
Total FailThe total number of times the task failed to run.
Total ErrorThe total number of times the task resulted in a user define error.
Total CancelledThe total number of times the task was cancelled.

Next steps

With the completion of this module, you are equipped with an understanding of setting up a developer environment, and managing users and tenants in Elara.

On this page