Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 67 additions & 24 deletions content/manuals/offload/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,20 @@

> [!NOTE]
>
> All free trial usage granted for the Docker Offload Beta expire after 90 days from the time they are granted. To
> continue using Docker Offload Beta after your usage expires, you can enable on-demand usage at [Docker Home
> All free trial usage granted for the Docker Offload Beta expire after 90 days
> from the time they are granted. To continue using Docker Offload Beta after
> your usage expires, you can enable on-demand usage at [Docker Home
> Billing](https://app.docker.com/billing).

## Understand usage and billing models

Docker Offload offers two usage models to fit different team needs and usage patterns:
Docker Offload offers two usage models to fit different team needs and usage
patterns:

- Committed usage: This provides a committed amount of cloud compute time for your organization.
- On-demand usage: This provides pay-as-you-go flexibility. You can enable or disable on-demand usage in
[Billing](#manage-billing).
- Committed usage: This provides a committed amount of cloud compute time for
your organization.
- On-demand usage: This provides pay-as-you-go flexibility. You can enable or
disable on-demand usage in [Billing](#manage-billing).

## Manage billing

Expand All @@ -34,35 +37,75 @@
- Track your organization's Docker Offload usage
- Add or change payment methods

You must be an organization owner to manage billing. For more general information about billing, see
[Billing](../billing/_index.md).
You must be an organization owner to manage billing. For more general
information about billing, see [Billing](../billing/_index.md).

## Monitor your usage

The **Offload overview** page in Docker Home provides visibility into
how you are using cloud resources to build and run containers.
The **Offload activity** page in Docker Home provides visibility into how you
are using cloud resources to run containers.

To monitor your usage:

1. Sign in to [Docker Home](https://app.docker.com/).
2. Select the account for which you want to monitor usage.
3. Select **Offload** > **Offload overview**.
3. Select **Offload** > **Offload activity**.

The following widgets are available:
### Overview metrics

- My recent sessions: This widget shows your total session time as well as a break down of your most recent sessions'
duration.
- My top 10 images: This widget shows the top 10 images used in Docker Offload in run sessions. It provides insight into
which images are most frequently used, helping you understand your container usage patterns.
- My active sessions: This widget displays any currently active Docker Offload sessions.
Key metrics at the top of the page summarize your Docker Offload usage:

### View recent activity
- **Total duration**: The total time spent in Offload sessions
- **Average duration**: The average time per Offload session
- **Total sessions**: The total number of Offload sessions
- **Unique images used**: The number of distinct container images used across
sessions
- **Unique users**: The number of different users in Docker Offload sessions

The **Recent activity** page in Docker Home provides detailed information about your recent Docker Offload sessions.
This includes session ID, start date and time, duration, and number of containers.
### Filter and export your data

To view the **Recent activity** page:
You can filter the Offload activity data by:

1. Sign in to [Docker Home](https://app.docker.com/).
2. Select the account for which you want to manage Docker Offload.
3. Select **Offload** > **Recent activity**.
- **Period**: Select a preset time period or choose a custom date range
- **Users**: Organization owners and members with analytics permissions can
filter by specific users

Export your session data by selecting the **Download CSV** button. The exported
file includes:

- Session ID
- Username
- Image
- Started time
- Ended time
- Duration (in seconds)
- Status
- Container count

The CSV export includes data for your selected date range and user filters,
letting you download exactly what you're viewing.

### Activity cards

The following cards provide insights into your Docker Offload usage:

- **Offload usage**: Shows your usage trends over time and cloud resource
consumption patterns. If you have billing permissions, you can select the card
to view detailed billing information.
- **Popular images**: Shows the top 4 most frequently used container images in
your Docker Offload sessions. Select the card to see more images.
- **Top users**: Shows the top 4 users by session count and duration. Select
the card to see more users.

### Offload sessions

A detailed list of Offload sessions appears below the activity cards. The list:

Check warning on line 102 in content/manuals/offload/usage.md

View workflow job for this annotation

GitHub Actions / validate (vale)

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'following' instead of 'below' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'following' instead of 'below'", "location": {"path": "content/manuals/offload/usage.md", "range": {"start": {"line": 102, "column": 45}}}, "severity": "INFO"}

- Starts with any currently active sessions
- Shows session details including start time, duration, images used, and user
information
- Can be filtered using the date and user filters described above

Check warning on line 107 in content/manuals/offload/usage.md

View workflow job for this annotation

GitHub Actions / validate (vale)

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'previous' instead of 'above' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'previous' instead of 'above'", "location": {"path": "content/manuals/offload/usage.md", "range": {"start": {"line": 107, "column": 61}}}, "severity": "INFO"}
- Displays **Offload sessions** if you have organization-wide analytics
permissions, or **My Offload sessions** if viewing only your own data

Select any session to view more details in a side panel.