diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-04-10 03:09:11 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-04-10 03:09:11 +0300 |
commit | 89cb3fa7748cad1d71417bcd5b69bf30b94c25b5 (patch) | |
tree | d1109effbce81cadbb3009b937f629be94113795 /doc/api/usage_data.md | |
parent | 017841e3c03105efd0b94e730652c5774f2c136f (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/usage_data.md')
-rw-r--r-- | doc/api/usage_data.md | 50 |
1 files changed, 49 insertions, 1 deletions
diff --git a/doc/api/usage_data.md b/doc/api/usage_data.md index f54a0808d51..671e60be587 100644 --- a/doc/api/usage_data.md +++ b/doc/api/usage_data.md @@ -20,7 +20,7 @@ Return all of the raw SQL queries used to compute usage ping. Example request: ```shell -curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/usage_data/queries +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/usage_data/queries" ``` Sample response @@ -66,3 +66,51 @@ Sample response "ci_runners": "SELECT COUNT(\"ci_runners\".\"id\") FROM \"ci_runners\"", ... ``` + +## UsageDataNonSqlMetrics API + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57050) in GitLab 13.11. +> - [Deployed behind a feature flag](../user/feature_flags.md), disabled by default. + +Return all non-SQL metrics data used in the usage ping. + +Example request: + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/usage_data/non_sql_metrics" +``` + +Sample response: + +```json +{ + "recorded_at": "2021-03-26T07:04:03.724Z", + "uuid": null, + "hostname": "localhost", + "version": "13.11.0-pre", + "installation_type": "gitlab-development-kit", + "active_user_count": -3, + "edition": "EE", + "license_md5": "bb8cd0d8a6d9569ff3f70b8927a1f949", + "license_id": null, + "historical_max_users": 0, + "licensee": { + "Name": "John Doe1" + }, + "license_user_count": null, + "license_starts_at": "1970-01-01", + "license_expires_at": "2022-02-26", + "license_plan": "starter", + "license_add_ons": { + "GitLab_FileLocks": 1, + "GitLab_Auditor_User": 1 + }, + "license_trial": null, + "license_subscription_id": "0000", + "license": {}, + "settings": { + "ldap_encrypted_secrets_enabled": false, + "operating_system": "mac_os_x-11.2.2" + }, +... +``` |