Operations with Specific Telemetry data
This resource lets you get telemetry data of your YouTrack service.
Resource | |
|---|---|
Returned entity | Telemetry. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Telemetry data of the YouTrack installation.
Below you can find the list of resources that let you work with this entity.
This table describes attributes of the Telemetry entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the Telemetry. |
installationFolder | String | Installation folder of YouTrack. |
databaseLocation | String | Location of the YouTrack database. |
logsLocation | String | Location of the logs. |
availableProcessors | Int | Number of available processors. |
availableMemory | String | Available memory. |
allocatedMemory | String | Allocated memory. |
usedMemory | String | Used memory. |
uptime | String | Uptime of the YouTrack application. |
startedTime | Long | The timestamp in milliseconds indicating the moment when YouTrack was started. Stored as a unix timestamp at UTC. |
databaseBackgroundThreads | Int | Number of database background threads. |
pendingAsyncJobs | Int | Number of pending asynchronous jobs. |
cachedResultsCountInDBQueriesCache | Int | Size of the database queries cache. |
databaseQueriesCacheHitRate | String | Queries cache hit rate. |
blobStringsCacheHitRate | String | Blobs cache hit rate. |
totalTransactions | Long | Number of transactions. |
transactionsPerSecond | String | Number of transactions per second. |
requestsPerSecond | String | Number of requests per second. |
databaseSize | String | Size of the database (without blobs). |
fullDatabaseSize | String | Full size of the database. |
textIndexSize | String | Size of the text index. |
onlineUsers | Online users. | |
reportCalculatorThreads | Int | Number of report calculator threads. |
notificationAnalyzerThreads | Int | Number of notification analyzer threads. |
Read available telemetry data of the YouTrack service. Please note that the list of returned attributes depends on whether you use on-premise or InCloud edition. For attributes that are unsupported, YouTrack returns null.
Requires permissions: Low-level Admin Read
GET /api/admin/telemetry?{fields}null | Database ID of Telemetry |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Telemetry attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/telemetry?fields=databaseSize,uptime,startedTime,textIndexSize{
"startedTime": 1610613083628,
"databaseSize": "5.0 MB",
"textIndexSize": "0.1 MB",
"uptime": "644 hours, 19 minutes, 10 seconds and 121 milliseconds",
"$type": "Telemetry"
}