diff --git a/assets/server-statistics-csv-example.csv b/assets/server-statistics-csv-example.csv new file mode 100644 index 0000000000..f688aef6ae --- /dev/null +++ b/assets/server-statistics-csv-example.csv @@ -0,0 +1,2 @@ +github_connect.features_enabled,host_name,dormant_users.dormancy_threshold,dormant_users.total_dormant_users,ghes_version,server_id,collection_date,schema_version,ghe_stats.comments.total_commit_comments,ghe_stats.comments.total_gist_comments,ghe_stats.comments.total_issue_comments,ghe_stats.comments.total_pull_request_comments,ghe_stats.gists.total_gists,ghe_stats.gists.private_gists,ghe_stats.gists.public_gists,ghe_stats.hooks.total_hooks,ghe_stats.hooks.active_hooks,ghe_stats.hooks.inactive_hooks,ghe_stats.issues.total_issues,ghe_stats.issues.open_issues,ghe_stats.issues.closed_issues,ghe_stats.milestones.total_milestones,ghe_stats.milestones.open_milestones,ghe_stats.milestones.closed_milestones,ghe_stats.orgs.total_orgs,ghe_stats.orgs.disabled_orgs,ghe_stats.orgs.total_teams,ghe_stats.orgs.total_team_members,ghe_stats.pages.total_pages,ghe_stats.pulls.total_pulls,ghe_stats.pulls.merged_pulls,ghe_stats.pulls.mergeable_pulls,ghe_stats.pulls.unmergeable_pulls,ghe_stats.repos.total_repos,ghe_stats.repos.root_repos,ghe_stats.repos.fork_repos,ghe_stats.repos.org_repos,ghe_stats.repos.total_pushes,ghe_stats.repos.total_wikis,ghe_stats.users.total_users,ghe_stats.users.admin_users,ghe_stats.users.suspended_users +,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, \ No newline at end of file diff --git a/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md b/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md index 8dca96d496..a3cb3c1f5b 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md +++ b/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md @@ -50,51 +50,55 @@ You can disable the {% data variables.product.prodname_server_statistics %} feat After you enable {% data variables.product.prodname_server_statistics %}, metrics are collected through a daily job that runs on {% data variables.location.product_location %}. The aggregate metrics are stored on your organization or enterprise account on {% data variables.product.prodname_ghe_cloud %} and are not stored on {% data variables.location.product_location %}. -The following aggregate metrics will be collected and transmitted on a daily basis and represent the total counts for the day: - - `active_hooks` - - `admin_users` - - `closed_issues` - - `closed_milestones` - - `collection_date` - - `disabled_orgs` - - `dormancy_threshold` - - `fork_repos` - - `ghes_version` - - `github_connect_features_enabled` - - `inactive_hooks` - - `mergeable_pulls` - - `merged_pulls` - - `open_issues` - - `open_milestones` - - `org_repos` - - `private_gists` - - `public_gists` - - `root_repos` - - `schema_version` - - `server_id` - - `suspended_users` - - `total_commit_comments` - - `total_dormant_users` - - `total_gist_comments` - - `total_gists` - - `total_hooks` - - `total_issues` - - `total_issue_comments` - - `total_milestones` - - `total_repos` - - `total_orgs` - - `total_pages` - - `total_pull_request_comments` - - `total_pulls` - - `total_pushes` - - `total_team_members` - - `total_teams` - - `total_users` - - `total_wikis` - - `unmergeable_pulls` +The following aggregate metrics will be collected and transmitted on a daily basis and represent the total counts for the day. -## {% data variables.product.prodname_server_statistics %} payload example +CSV column | Name | Description | +---------- | ---- | ----------- | +A | `github_connect.features_enabled` | Array of {% data variables.product.prodname_github_connect %} features that are enabled for your instance (see "[About {% data variables.product.prodname_github_connect %}](/admin/configuration/configuring-github-connect/about-github-connect#github-connect-features)" ) | +B | `host_name` | The hostname for your instance | +C | `dormant_users.dormancy_threshold` | The length of time a user must be inactive to be considered dormant | +D | `dormant_users.total_dormant_users` | Number of dormant user accounts | +E | `ghes_version` | The version of {% data variables.product.product_name %} that your instance is running | +F | `server_id` | The UUID generated for your instance +G | `collection_date` | The date the metrics were collected | +H | `schema_version` | The version of the database schema used to store this data | +I | `ghe_stats.comments.total_commit_comments` | Number of comments on commits | +J | `ghe_stats.comments.total_gist_comments` | Number of comments on gists | +K | `ghe_stats.comments.total_issue_comments` | Number of comments on issues | +L | `ghe_stats.comments.total_pull_request_comments` | Number of comments on pull requests | +M | `ghe_stats.gists.total_gists` | Number of gists (both secret and public) | +N | `ghe_stats.gists.private_gists` | Number of secret gists | +O | `ghe_stats.gists.public_gists` | Number of public gists | +P | `ghe_stats.hooks.total_hooks` | Number of pre-receive hooks (both active and inactive) | +Q | `ghe_stats.hooks.active_hooks` | Number of active pre-receive hooks | +R | `ghe_stats.hooks.inactive_hooks` | Number of inactive pre-receive hooks | +S | `ghe_stats.issues.total_issues` | Number of issues (both open and closed) | +T | `ghe_stats.issues.open_issues` | Number of open issues | +U | `ghe_stats.issues.closed_issues` | Number of closed issues | +V | `ghe_stats.milestones.total_milestones` | Number of milestones (both open and closed) | +W | `ghe_stats.milestones.open_milestones` | Number of open milestones | +X | `ghe_stats.milestones.closed_milestones` | Number of closed milestones | +Y | `ghe_stats.orgs.total_orgs` | Number of organizations (both enabled and disabled) | +Z | `ghe_stats.orgs.disabled_orgs` | Number of disabled organizations | +AA | `ghe_stats.orgs.total_teams` | Number of teams | +AB | `ghe_stats.orgs.total_team_members` | Number of team members | +AC | `ghe_stats.pages.total_pages` | Number of {% data variables.product.prodname_pages %} sites | +AD | `ghe_stats.pulls.total_pulls` | Number of pull requests | +AE | `ghe_stats.pulls.merged_pulls` | Number of merged pull requests | +AF | `ghe_stats.pulls.mergeable_pulls` | Number of pull requests that are currently mergeable | +AG | `ghe_stats.pulls.unmergeable_pulls` | Number of pull requests that are currently unmergeable | +AH | `ghe_stats.repos.total_repos` | Number of repositories (both upstream repositories and forks) | +AI | `ghe_stats.repos.root_repos` | Number of upstream repositories | +AJ | `ghe_stats.repos.fork_repos` | Number of forks | +AK | `ghe_stats.repos.org_repos` | Number of repositories owned by organizations | +AL | `ghe_stats.repos.total_pushes` | Number of pushes to repositories | +AM | `ghe_stats.repos.total_wikis` | Number of wikis | +AN | `ghe_stats.users.total_users` | Number of user accounts | +AO | `ghe_stats.users.admin_users` | Number of user accounts that are site administrators | +AP | `ghe_stats.users.suspended_users` | Number of user accounts that are suspended | -To see an example of the response payload for the {% data variables.product.prodname_server_statistics %} API, see "[Requesting {% data variables.product.prodname_server_statistics %} using the REST API](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api)." +## {% data variables.product.prodname_server_statistics %} data examples -To see a list of the data collected, see "[{% data variables.product.prodname_server_statistics %} data collected](#server-statistics-data-collected)." +To see an example of the headings included in the CSV export for {% data variables.product.prodname_server_statistics %}, download the [{% data variables.product.prodname_server_statistics %} CSV example](/assets/server-statistics-csv-example.csv). + +To see an example of the response payload for the {% data variables.product.prodname_server_statistics %} API, see "[Requesting {% data variables.product.prodname_server_statistics %} using the REST API](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api)." \ No newline at end of file