Visualizing data from Yandex Tracker

Visualizing data from Tracker to DataLens allows you to build more advanced analytics than when using the Tracker tools.

To visualize data from Tracker to DataLens:

• Set up regular export of data to external storage.
• Visualize the required metrics and data using DataLens.

To visualize the data, follow these steps:

1. Prepare your cloud.
2. Create a DB for storing the Tracker data.
3. Create an OAuth token for Tracker access.
4. Create a Cloud Functions function for importing the data.
5. Create a connection to DataLens.
6. Create a dataset.
7. Create a chart.
8. Create a dashboard in DataLens and add charts to it.

Getting started

Sign up for Yandex Cloud and create a billing account:

1. Go to the management console and log in to Yandex Cloud or create an account if you do not have one yet.
2. On the Billing page, make sure you have a billing account activated and its status is ACTIVE or TRIAL_ACTIVE. If you do not have a billing account, create one.

If you have an active billing account, you can create or select a folder on the cloud page to host your infrastructure.

Learn more about clouds and folders.

Required paid resources

• A paid service plan that grants full access to Tracker.
• A continuously running Managed Service for ClickHouse® cluster (see Managed Service for ClickHouse® pricing).
• Cloud Functions function usage (see Cloud Functions pricing).

If you no longer need the resources you created, delete them.

Create a DB for storing the Tracker data

1. Go to the management console.
2. In the top-left corner, click  All services.
3. Select Data platform → Managed Service for ClickHouse.
4. Click Create ClickHouse cluster.
5. Specify the cluster parameters:
   • Basic parameters:
     • Environment: PRODUCTION.
     • Version: 24.8 LTS.
   • Resources:
     • Platform: Intel Ice Lake.
     • Type: Standard.
     • Host class: s3-c2-m8 (2 vCPU, 8 GB).
   • Storage size: 30 GB.
   • Hosts:
     • Public access: Enabled.
   • DBMS settings:
     • User management via SQL: Disabled.
     • Database management via SQL: Disabled.
     • Username: tracker_data.
     • DB name: db1.
   • Service settings:
     • DataLens access: Enabled.
     • Access from Serverless: Enabled.
       For a full list of settings, see Managed Service for ClickHouse® settings.
6. Click Create cluster. Wait for the created cluster status to change to Alive.
7. Copy and save the host name for further Cloud Functions setup.

Create an OAuth token for Tracker access

To access Yandex Tracker API, you need to obtain an OAuth token. Use the obtained token in the Authorization header when making requests to Yandex Tracker API.

This token grants the same permissions as the user account in Yandex Tracker. For example, if the user is not allowed to change queue settings, API requests to change queue settings will not be available using this token.

To get a token:

1. Click the link https://oauth.yandex.com/.

2. On the Your apps page, click Create.

3. In the window that opens, select For API access or debugging and click Create new token.

4. Enter the app name and your contact email.

5. Add permissions for accessing user data. To select a permission, start typing its name in the Permission name field:

   • Write in tracker (tracker:write): Users with this permission can create, delete, and edit data.
   • Read from tracker (tracker:read): Users with this permission can only read data.

6. Click Create app.

7. In your Yandex OAuth account, select the previously created application and copy its ID from the ClientID field.

8. Next, generate a link to request a token:

   https://oauth.yandex.com/authorize?response_type=token&client_id=<application_ID>
   

9. Log in to the account which you'll be using to access the API, then follow the generated link.

   You'll see a sequence of characters appear on the page — that's your OAuth token. Copy and save it.

See how to set up your app in Yandex ID Help:

• How to create an OAuth app for accessing the API.
• How to obtain a token.

To check if you have access to the API, request information about the current user. If no access permission is granted, you will get a response with the 401 Unauthorized code.

Sample curl request for retrieving information about the current user:

curl -X GET 'api.tracker.yandex.net/v3/myself' \
     -H 'Authorization: OAuth ABC-def12GH_******' \
     -H 'X-Cloud-Org-Id: abcd12******'

curl -X GET "api.tracker.yandex.net/v3/myself" ^
     -H "Authorization: OAuth ABC-def12GH_******" ^
     -H "X-Cloud-Org-Id: abcd12******"

Create a Cloud Functions function for importing the data

1. Go to the management console.
2. In the top-left corner, click  All services.
3. Select Serverless computing → Cloud Functions.
4. Click Create function.
5. Specify a name for the function and click Create.
6. In the Editor window that opens, select Python / 3.9 runtime environment.
7. Click Next.
8. In the Method field, click ZIP archive.
9. Attach a test archive.
10. In the Entry point field, specify tracker_import.handler.
11. Under Parameters, specify:
    • Timeout, sec: 60.
    • RAM: 1024.
    • Environment variables:

      • TRACKER_ORG_ID: Yandex 360 for Business organization ID

        To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

      • TRACKER_OAUTH_TOKEN: OAuth token of the Tracker account

      • CH_HOST: Host name

      • CH_DB: Database name

      • CH_USER: Username

      • CH_PASSWORD: Password

      • CH_ISSUES_TABLE: tracker_issues

      • CH_CHANGELOG_TABLE: tracker_changelog

      • TRACKER_INITIAL_HISTORY_DEPTH: 1d

      • CH_STATUSES_VIEW: v_tracker_statuses

12. Click Save changes.
13. In the Testing tab, click Run test.
14. The test result is a data import log:

    {
        "statusCode": 200,
        "headers": {
        "Content-Type": "text/plain"
        },
        "isBase64Encoded": false,
        "body": "OK"
    }
    
15. Create a trigger for regular exports of new data to the database:
    1. Go to the Cloud Functions section.
    2. Click → Create trigger.
    3. Set the trigger type to Timer.
    4. In the Cron expression field, select Every day.
    5. Under Function settings, click Create new.
    6. Enter the account name. By default, the account is assigned the functions.functionInvoker role to use the trigger.
    7. Click Create.
    8. Click Create trigger.

Create a connection in DataLens

1. Open your Managed Service for ClickHouse® cluster.

2. On the left side of the window, select  DataLens.

3. Click Create connection.

4. Specify the connection settings:

   • Connection: Select in a folder.

   • Cluster: Cluster specified when creating a database.

   • Hostname: Host specified when creating a database.

   • HTTP interface port: 8443.

   • Username: Username specified when creating a database.

   • Password: Password specified when creating a database.

   • Cache TTL in seconds: Default.

   • Raw SQL level: Forbid.

   • HTTPS: Enabled.

     

5. Click Create connection.

Create a dataset

1. Go to the connections page.
2. Select a connection.
3. In the top-right corner, click Create dataset.
4. Drag one or more tables to the workspace:
   • db1.v_tracker_issues: Current (most recent) issue cross-section.
   • db1.v_tracker_changelog: Issue parameter change history.
   • Db1.v_tracker_statuses: Status transition time based on the issue change history.
5. Click Save.

Create a chart

1. Go to the DataLens home page.
2. Click Create chart.
3. In the top left corner, click  Select dataset.
4. In the Datasets drop-down list, select the dataset you created in the previous step.
5. On the top panel, select a visualization type. By default, the Column chart type is selected.

Create a dashboard and add charts to it

1. On the DataLens home page, click Create dashboard.

2. At the top of the dashboard page, click Add → Chart.

3. Fill in the widget parameters. Pay close attention to the following fields:

   • Name: Sets the name of the widget. It is displayed at the top of the widget.
   • Chart: Sets the widget to add.
   • Description: Sets the description of the widget. It is displayed at the bottom of the widget.
   • Auto height: Sets the automatic height for Table and Markdown widgets. If this parameter is disabled, you can set the height of the widget on the page using the mouse.

4. Click Add. The widget will be displayed on the dashboard.

5. Save the dashboard:

   1. In the top-right corner of the dashboard, click Save.
   2. Enter a name for the dashboard and click Create.

   For more information about setting up dashboards, see DataLens dashboard.

How to delete the resources you created

To stop paying for the resources you created:

• Delete the ClickHouse® cluster.
• Delete the Cloud Functions function.

ClickHouse® is a registered trademark of ClickHouse, Inc.