# Отчёты

[Перейти в личный кабинет](https://my.tuna.am/reports)

Функционал для сбора ошибок и создания избыточных отчётов на вашем сайте.

![Изображение с примером отчёта](/docs/img/reports/main.png)

***

## Обзор

С помощью встраиваемого скрипта пользователи и QA-инженеры могут легко показать, где спрятался баг, а вы – получить отладочную информацию и сразу приступить к исправлению.

![Настройка](/docs/img/reports/setup.png)

Для этого создайте проект и подключите скрипт на ваш сайт.

## Структура сервиса

Внутри сервиса **Отчёты** находятся **Проекты**, предполагается, что вы создаёте отдельный проект под каждый свой сайт. Проекты разделяются по уникальному ключу `captureKey`. Внутри проектов уже будут появляться создаваемые вами отчёты с скриншотами и видео записями.

## Установка

Разместите код на HTML странице перед закрытием тега `<head>`:

```html
<!-- tuna. Запись экрана и действий пользователей -->
<script>
    window.reportOptions = {
        captureKey: "YOUR_CAPTURE_KEY"
    };
</script>
<script src="https://reports.tuna.am/latest/index.js" async></script>

```

Замените **YOUR\_CAPTURE\_KEY** вашим из нужного проекта.

## Вызов cкрипта для создания отчёта

Есть несколько способов создать отчёт:

* Горячие клавиши
* Кнопка (data аттребут)
* Вызов из кода (JS)
* Аргумент в URL

### Горячие клавиши

**Windows**

Используйте сочетание клавиш

`CTRL` + `ALT` + `S`

**macOS**

Используйте сочетание клавиш

`⌘ command` + `⌥ option` + `S`

**Linux**

Используйте сочетание клавиш

`CTRL` + `ALT` + `S`

### Нажатие на кнопку

Вызывайте форму создания отчета, добавив кнопку с data-аттрибутом:

```html
<button data-report-trigger>
    Сообщить об ошибке
</button>

```

### Вызов из кода

Вызывайте форму создания отчета из своего кода, добавив команду:

```js
if (typeof window.autoCapture !== 'undefined'
    && window.autoCapture.showCaptureModal) {
    window.autoCapture.showCaptureModal();
}

```

### Аргумент в URL

Вызывайте форму создания отчета, добавив к URL в адресной строке аргумент `report=true`.

```url
https://example.com/dashboard?report=true

```

## Запроса на создание отчёта с записью экрана

Если вы хотите чтобы пользователь записал для вас отчёт не с сайта, а продемонстрировал проблему на своей рабочей станции, тогда можно создать ссылку с запросом на запись экрана.

![](/docs/img/reports/external_1.png) ![](/docs/img/reports/external_2.png)

***

Перейдя по ссылке пользователь сможет записать для вас видео и рассказать о проблеме.

![](/docs/img/reports/external_3.png)

## Как выглядит отчёт?

Внутри отчёта будет скриншот или видео и вся отладочная информация из консоли, сетевые операции, действия пользователя и снимок DOM-дерева страницы.

**Информация**

На первой вкладке содержится общая сводная информация о клиенте, устройстве, браузере...

![](/docs/img/reports/info.png)

**Инспектор**

Снимок DOM-дерева страницы, с возможностью выбора элемента.

***

примечание

Эта вкладка доступна только для отчётов с скриншотом, в отчётах с видео невозможно захватить снимок DOM-дерева так как он может меняться по ходу.

**Консоль**

Список всех событий из консоли браузера.

![](/docs/img/reports/console.png)

**Сеть**

Список всех XHR запросов с возможностью заглянуть в детали.

**Действия**

Действия пользователя на странице.

![](/docs/img/reports/actions.png)

**Комментарии**

Также можно оставлять комментарии и реакции к комментариям.

![](/docs/img/reports/message.png)

## Видимость отчёта

По умолчанию отчёт создаётся с видимостью - **Только для участников команды**, но вы можете сделать его публичным. Например для ведения диалога с клиентом создавшим отчёт.

![](/docs/img/reports/share.png)
