Developer Portal for YouTrack and Hub 2021.3 Help

Telemetry data

This resource lets you get telemetry data of your YouTrack service.

Resource

/api/admin/telemetry

Returned entity

Telemetry. For the description of the entity attributes, see Supported Fields section.

Supported methods

Telemetry attributes

Telemetry data of the YouTrack installation.

This table describes attributes of the Telemetry entity.

  • To receive an attribute in the response from server, specify it explicitly in the request parameter fields.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

installationFolder

String

Installation folder of YouTrack. Read-only. Can be null.

databaseLocation

String

Location of the YouTrack database. Read-only. Can be null.

logsLocation

String

Location of the logs. Read-only. Can be null.

availableProcessors

Int

Number of available processors. Read-only. Can be null.

availableMemory

String

Available memory. Read-only. Can be null.

allocatedMemory

String

Allocated memory. Read-only. Can be null.

usedMemory

String

Used memory. Read-only. Can be null.

uptime

String

Uptime of the YouTrack application. Read-only.

startedTime

Long

Date and time when YouTrack was started. Read-only.

databaseBackgroundThreads

Int

Number of database background threads. Read-only.

pendingAsyncJobs

Int

Number of pending asynchronous jobs. Read-only.

cachedResultsCountInDBQueriesCache

Int

Size of the database queries cache. Read-only.

databaseQueriesCacheHitRate

String

Queries cache hit rate. Read-only.

blobStringsCacheHitRate

String

Blobs cache hit rate. Read-only.

totalTransactions

Long

Number of transactions. Read-only.

transactionsPerSecond

String

Number of transactions per second. Read-only.

requestsPerSecond

String

Number of requests per second. Read-only.

databaseSize

String

Size of the database (without blobs). Read-only.

fullDatabaseSize

String

Full size of the database. Read-only.

textIndexSize

String

Size of the text index. Read-only.

onlineUsers

OnlineUsers

Online users. Read-only.

reportCalculatorThreads

Int

Number of report calculator threads. Read-only.

notificationAnalyzerThreads

Int

Number of notification analyzer threads. Read-only.

Get Telemetry Data

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.

Required permissions

Requires Low-level Admin Read permission.

Request syntax

GET /api/admin/telemetry?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of Telemetry attributes that should be returned in the response. If no field is specified,only the entityID is returned

Sample

Sample request

curl -L -X GET 'https://example.myjetbrains.com/youtrack/api/admin/telemetry?fields=databaseSize,uptime,startedTime,textIndexSize' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer perm:am9obi5kb2U=.UG9zdG1hbiBKb2huIERvZQ==.jJe0eYhhkV271j1lCpfknNYOEakNk7'

Sample response body

{ "startedTime": 1610613083628, "databaseSize": "5.0 MB", "textIndexSize": "0.1 MB", "uptime": "644 hours, 19 minutes, 10 seconds and 121 milliseconds", "$type": "Telemetry" }
Last modified: 13 July 2021