Enterprise Accounts Usage
Last updated November 07, 2024
Table of Contents
The Heroku Enterprise Usage dashboard provides detailed data about your account’s license and usage data so you can make informed, data-driven business decisions. To access the personalized dashboard insights, the account must be on an Enterprise plan and the user must have the Billing
permission enabled.
View Usage on the Heroku Dashboard
There are four sections in the Heroku Enterprise usage dashboard:
Plan
The Plan
section provides important details about your account’s current license information. This information includes the Heroku products you have licenses for and the quantity, and the start and end dates of your active contracts.
Downloadable Usage
The Downloadable Usage
section lets you export detailed usage information by Heroku team and application name. Select any given month within the past 12 months from the dropdown menu and click Download as CSV
.
To retrieve daily usage data for specific dates, up to 31 days within the past 6 months, check the Daily usage over a custom time period (up to 31 days)
box and choose your preferred date range for mid-month usage.
Daily usage data is calculated by dividing the monthly run rate by thirty days to display the average usage across the month. As of November 2024, daily usage is only an estimate. Download the monthly usage to get the true detailed usage data.
The .csv file provides usage information about the following Heroku products:
- Dyno units
- Heroku Connect rows (only in monthly report)
- Third party add-ons
- Data add-ons
- Private Spaces
- Shield Private Spaces
General Add-on Credit Usage
General add-on credits are credits you can apply across Heroku services and premium features. Customers can adjust resource allocations as needed without modifying their contract.
General add-on credits apply in the following order:
- Third-party add-ons: use for add-on services in the Elements Marketplace
- Data add-ons: use for Heroku data services, such as Heroku Postgres, Heroku Key-Value Store, or Apache Kafka on Heroku
- Private Spaces
- Shield Private Spaces
Private Spaces Credits
The .csv file displays the consumption of Private Spaces and Shield Private Spaces in two ways:
- Number of Private and Shield spaces used
- Number of Private Spaces credits and Shield Private Spaces credits used
Licensing one Private space equates to 1,000 Private Space credits. Licensing one Shield space equates to 3,000 Shield Space credits. We display spaces usage in credits because you can use general add-on credits to cover Private Spaces and Shield Private Spaces consumption.
For example, if a Private space runs for half of the month, it consumes 0.5 Private spaces, equivalent to 500 Private Spaces credits.
The Spaces
field in the .csv file refers to the total count of Private and Shield spaces used throughout the month.
Current Usage
The Current Usage
section shows your usage for the current month relative to your licensed amounts. Each row in the table represents a product in use. The Usage column displays the quantity used compared to your licenses. If there are no active licenses, this column only shows the quantity of products used.
The Contract and Overage columns include a visual breakdown of product usage, indicating what is covered by licensed amounts, general add-on credits, or what represents an overage. This data refreshes every 24 hours.
Usage History
The Usage History
section shows your Heroku usage over the past 12 months. Each vertical bar represents the total usage for a specific month, color-coded to clarify your resource allocation and remaining balances. This visualization helps you track and understand your monthly resource consumption.
- Light purple: unused licensed amounts
- Dark purple: usage covered by licensed amounts
- Yellow: usage covered by general add-on credits
- Red: usage exceeding your licensed amounts
Private Spaces and Shield Private Spaces usage for March 2024 and earlier is only available as a combined total. You can’t view them separately.
Export via the Heroku CLI
The Heroku CLI is an essential tool for using Heroku effectively. It supports various CLI plugins that extend the functionality of the standard CLI installation. One particularly useful plugin is the Enterprise plugin, which allows you to manage Enterprise Accounts directly from the CLI and download all available reports, including usage reports.
To get started, visit the Enterprise Accounts CLI Plugin article for instructions on installing the Heroku CLI and the Enterprise Accounts CLI Plugin. After installing, follow the guidelines to export your usage reports.
Monthly Usage
$ heroku enterprise:usage:monthly
Options
-e, --enterprise-account=enterprise-account enterprise account name
-t, --team=team team name
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--end-date=end-date end date of the usage period, inclusive (YYYY-MM)
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--sort=sort property to sort by (prepend '-' for descending)
--start-date=start-date start date of the usage period, defaults to current month if not provided (YYYY-MM)
Examples
$ heroku enterprise:usage:monthly --enterprise-account=account-name
$ heroku enterprise:usage:monthly --enterprise-account=account-name --columns='team,app,dyno,data'
$ heroku enterprise:usage:monthly --enterprise-account=account-name --columns='team,app,dyno,data' --sort='-data,app'
$ heroku enterprise:usage:monthly --enterprise-account=account-name --columns='team,app,dyno,data' --filter='app=myapp'
$ heroku enterprise:usage:monthly --enterprise-account=account-name --csv
$ heroku enterprise:usage:monthly --team=team-name --start-date 2019-01
$ heroku enterprise:usage:monthly --team=team-name --start-date 2019-01 --end-date 2019-03
$ heroku enterprise:usage:monthly --team=team-name --columns='app,dyno,data' --sort='-data,app'
$ heroku enterprise:usage:monthly --team=team-name --csv
Daily Usage
$ heroku enterprise:usage:daily
Options
-e, --enterprise-account=enterprise-account enterprise account name
-t, --team=team team name
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--end-date=end-date (required) end date of the usage period, inclusive, cannot be more than 31 days after the start date (YYYY-MM-DD)
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--sort=sort property to sort by (prepend '-' for descending)
--start-date=start-date (required) start date of the usage period, cannot be more than 6 months prior to today (YYYY-MM-DD)
Examples
$ heroku enterprise:usage:daily --enterprise-account=account-name --start-date=2019-01-01 --end-date=2019-01-15
$ heroku enterprise:usage:daily --enterprise-account=account-name --start-date=2019-01-01 --end-date=2019-01-15 --columns='team,app,dyno,data'
$ heroku enterprise:usage:daily --enterprise-account=account-name --start-date=2019-01-01 --end-date=2019-01-15 --columns='team,app,dyno,data' --sort='-data,app'
$ heroku enterprise:usage:daily --enterprise-account=account-name --start-date=2019-01-01 --end-date=2019-01-15 --columns='team,app,dyno,data' --filter='app=myapp'
$ heroku enterprise:usage:daily --enterprise-account=account-name --start-date=2019-01-01 --end-date=2019-01-15 --csv
$ heroku enterprise:usage:daily --team=team-name --start-date=2019-01-01 --end-date=2019-01-15
$ heroku enterprise:usage:daily --team=team-name --start-date=2019-01-01 --end-date=2019-01-15 --columns='app,dyno,data' --sort='-data,app'
$ heroku enterprise:usage:daily --team=team-name --start-date=2019-01-01 --end-date=2019-01-15 --csv