Enabling Usage Statistics
Server v2.x Server Admin | CircleCI Server version 2.x is no longer a supported release. Please consult your account team for help in upgrading to a supported release. |
This chapter is for System Administrators who want to automatically send some aggregate usage statistics to CircleCI. Usage statistics data enhances visibility into CircleCI installations.
To opt-in to this feature, navigate to your Management Console settings (e.g. circleci-hostname.com:8800/settings) and scroll down to Usage Statistics. Enable the radio button labeled Automatically send some usage statistics to CircleCI, as shown below.
Detailed Usage Statistics
The following sections provide information about the usage statistics CircleCI will gather when this setting is enabled.
Weekly Account Usage
| Name | Type | Purpose |
|---|---|---|
account_id | UUID | Uniquely identifies each vcs account |
usage_current_macos | minutes | For each account, track weekly builds performed in minutes. |
usage_legacy_macos | minutes | |
usage_current_linux | minutes | |
usage_legacy_linux | minutes |
Weekly Job Activity
| Name | Type | Purpose |
|---|---|---|
utc_week | date | Identifies which week the data below applies to |
usage_oss_macos_legacy | minutes | Track builds performed by week |
usage_oss_macos_current | minutes | |
usage_oss_linux_legacy | minutes | |
usage_oss_linux_current | minutes | |
usage_private_macos_legacy | minutes | |
usage_private_macos_current | minutes | |
usage_private_linux_legacy | minutes | |
usage_private_linux_current | minutes | |
new_projects_oss_macos_legacy | sum | Captures new Builds performed on 1.0. Observe if users are starting new projects on 1.0. |
new_projects_oss_macos_current | sum | |
new_projects_oss_linux_legacy | sum | |
new_projects_oss_linux_current | sum | |
new_projects_private_macos_legacy | sum | |
new_projects_private_macos_current | sum | |
new_projects_private_linux_legacy | sum | |
new_projects_private_linux_current | sum | |
projects_oss_macos_legacy | sum | Captures Builds performed on 1.0 and 2.0. Observe if users are moving towards 2.0 or staying with 1.0. |
projects_oss_macos_current | sum | |
projects_oss_linux_legacy | sum | |
projects_oss_linux_current | sum | |
projects_private_macos_legacy | sum | |
projects_private_macos_current | sum | |
projects_private_linux_legacy | sum | |
projects_private_linux_current | sum |
Accessing Usage Data
If you would like programatic access to this data in order to better understand your users you may run this command from the Services VM.
docker exec usage-stats /src/builds/extractSecurity and Privacy
Please reference exhibit C within your terms of contract and our standard license agreement for our complete security and privacy disclosures.
Help make this document better
This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.
- Suggest an edit to this page (please read the contributing guide first).
- To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
- CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.
Need support?
Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.
You can also visit our support site to find support articles, community forums, and training resources.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
