Telemetry
This resource lets you read telemetry data of YouTrack Standalone service. In the UI, the data returned by this resource is displayed on the Statistics page.
Telemetry Data
Resource | api/admin/telemetry |
Returned entity | Telemetry |
Supported methods | GET |
Fields
The returned entity contains the following attributes that you can use in the fields
parameter of a request.
Field | Type | Description |
---|---|---|
allocatedMemory | String? | Stores the peak amount of memory that has been allocated to the JVM that runs your YouTrack service. |
availableMemory | String? | Stores the total amount of free JVM heap memory that is currently available to your YouTrack service. |
availableProcessors | Int? | Stores the number of cores that are capable of running YouTrack. |
blobStringsCacheHitRate | String | Stores the percentage of text-based data that is served from the BLOB strings cache. |
cachedResultsCountInDBQueriesCache | Int | Stores the number of records that are held in the cache for search query results. |
databaseBackgroundThreads | Int | Stores the number of dedicated threads that populate the database queries cache. |
databaseLocation | String? | Stores the path to the current location of your YouTrack database. |
databaseQueriesCacheHitRate | String | Stores the percentage of search queries that are satisfied by results that are stored in the cache. |
databaseSize | String | The total size of the database, excluding binary large objects (BLOBs). |
fullDatabaseSize | String | Stores the total amount of space on the server that is currently occupied by your YouTrack database. |
installationFolder | String? | Stores the path to the location where your YouTrack application files are installed. For ZIP and MSI installations, this is also referenced as the |
jobs | Jobs | Stores the number of user-initiated transactions that are waiting for execution. This is an alternative technical metric that shows pending asynchronous jobs that were initiated by user actions. |
logsLocation | String? | Stores the path to the current location of your YouTrack log files. |
onlineUsers | Stores the number of users who are currently using the application. | |
pendingAsyncJobs | Int | Stores the number of tasks that are waiting to be executed, usually background tasks that populate the database queries cache. |
requestsPerSecond | String | Stores the average number of requests that are processed each second. |
startedTime | Long | Stores the date and time of the last YouTrack service start. |
textIndexSize | String | Stores the amount of space in the database that is used by the text index. |
totalTransactions | Long | Stores the number of database transactions that have been processed since the last service start time. |
transactionsPerSecond | String | Stores the average number of database transactions that are processed each second. Measures the immediate server load. |
uptime | String | Stores the total amount of running time since the last YouTrack service start. |
usedMemory | String? | Stores the amount of JVM heap memory currently being used by your YouTrack service. |
id | String | Stores the unique identifier of the resource. |
Read Telemetry Data
Request syntax: | GET /api/admin/telemetry?fields=<string> |
Response
Response Code | Meaning |
---|---|
200 OK | Successful request. |
400 Bad Request | Parameters of the request are invalid. For example, required fields in the passed JSON object are missing. The response contains message describing the error. |
403 Forbidden | Requester has no access to the request. |
404 Not Found | Requested resource wasn't found. |
500 Internal Server Error | Failed to process request because of the server error. The response contains message describing the error. |
Method sample
Request
GET /api/admin/telemetry?fields=installationFolder,databaseLocation,logsLocation,availableProcessors,uptime,onlineUsers(sessions,users,windows),allocatedMemory,availableMemory HTTP/1.1
Host: munit-087.labs.intellij.net:8080
Authorization: Bearer perm:YWRtaW4=.UG9zdG1hbg==.oVCSLKlWh4WkBBLvLryMScl4iIiWwt
Accept: application/json
Content-Type: application/json
Cache-Control: no-cache
Response body
{
"onlineUsers": {
"users": 1,
"sessions": 1,
"windows": 0
},
"installationFolder": "/Users/jetbrains/youtrack-standalone",
"logsLocation": "/Users/jetbrains/youtrack-standalone/logs/youtrack/logs",
"availableMemory": "910.5 MB",
"allocatedMemory": "591.5 MB",
"uptime": "13 minutes, 3 seconds and 919 milliseconds",
"availableProcessors": 8,
"databaseLocation": "/Users/jetbrains/youtrack-standalone/data"
}