Skip to content

Commit

Permalink
docs: update docs on usage info tracking
Browse files Browse the repository at this point in the history
  • Loading branch information
shadowusr committed Jan 3, 2025
1 parent bf55a2b commit 370897c
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 62 deletions.
48 changes: 17 additions & 31 deletions docs/en/html-reporter-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,41 +311,27 @@ customScripts: [

### yandexMetrika

This parameter allows you to add [Yandex.Metrika][yandex-metrika] to the report. The parameter is set as an object with the key `counterNumber`. As the key value, you must specify the Yandex.Metrica counter number (see "[How to create a counter][how-to-create-counter]"). The number should be set as a Number, not a String.
By default, anonymous html-reporter interface usage information is collected for us to analyze usage patterns and improve UX. We collect such info as html-reporter loading speed, how often certain UI features are used (e.g. sorting tests) or clicks on UI elements. NO information about your project or tests is ever tracked.

Also, in the Yandex.Metrika interface, go to the _"Counter"_ tab in the settings section, click _"Copy"_ and paste the counter code into the [customScripts](#customscripts) field.
If you want to opt out, choose any of the options below:

With the help of metrics, you can find out how developers interact with your report and what kind of problems they face.

The report supports the following [goals of metrics][yandex-metrika-goals]:

* **ACCEPT_SCREENSHOT**—there was a click on the _Accept_ button to accept a screenshot;
* **ACCEPT_OPENED_SCREENSHOTS**—there was a click on the _Accept opened_ button to accept screenshots from open tests.

Example of setting up Yandex.Metrika in one of the projects:

```javascript
module.exports = {
plugins: {
'html-reporter/hermione': {
customScripts: [
function(){(function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)}; m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)}) (window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym"); ym(56782912, "init", { clickmap:true, trackLinks:true, accurateTrackBounce:true, webvisor:true })},

// other scripts...
],
yandexMetrika: {
counterNumber: 1234567
- Edit your config:
```javascript
module.exports = {
plugins: {
'html-reporter/testplane': {
yandexMetrika: {
enabled: false
},
// other html-reporter settings...
},

// other plugin settings...
// other Testplane plugins...
},

// other hermione plugins...
},

// other hermione settings...
};
```
// other Testplane settings...
};
```
- Using environment variables: `html_reporter_yandex_metrika_enabled=false` or simply `NO_ANALYTICS=true`
- Using CLI arguments: `--html-reporter-yandex_metrika_enabled=false`

### Passing parameters via the CLI

Expand Down
48 changes: 17 additions & 31 deletions docs/ru/html-reporter-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,41 +312,27 @@ customScripts: [

### yandexMetrika

Данный параметр позволяет добавить в отчет [Яндекс.Метрику][yandex-metrika]. Параметр задается в виде объекта с ключом `counterNumber` _(номер счетчика)_. В качестве значения ключа необходимо указать номер счетчика Яндекс.Метрики (см. «[Как создать счетчик][how-to-create-counter]»). Номер должен задаваться как число _(Number)_, а не строка.
По умолчанию выполняется сбор анонимных сведений об использовании интерфейса отчета в целях анализа и улучшения UX. Собираются такие сведения, как скорость загрузки отчета, частота использования некоторых функций (например, сортировка тестов) и клики по элементам управления. Сведения о вашем проекте или содержимом тестов НЕ собираются ни при каких обстоятельствах.

Также в интерфейсе Яндекс.Метрики необходимо перейти в разделе настроек на вкладку _«Счетчик»_, нажать кнопку _«Скопировать»_ и вставить код счетчика в поле [customScripts](#customscripts).
Если вы не хотите делиться аналитикой с нами, вы можете отключить это любым из способов:

С помощью метрики вы сможете узнать как разработчики взаимодействуют с вашим отчетом и с какого рода проблемами они сталкиваются.

Отчет поддерживает следующие [цели для метрики][yandex-metrika-goals]:

* **ACCEPT_SCREENSHOT** — было нажатие на кнопку _Accept_ для принятия скриншота;
* **ACCEPT_OPENED_SCREENSHOTS** — было нажатие на кнопку _Accept opened_ для принятия скриншотов из открытых тестов.

Пример настройки _Яндекс.Метрики_ в одном из проектов:

```javascript
module.exports = {
plugins: {
'html-reporter/hermione': {
customScripts: [
function(){(function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)}; m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)}) (window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym"); ym(56782912, "init", { clickmap:true, trackLinks:true, accurateTrackBounce:true, webvisor:true })},

// другие скрипты...
],
yandexMetrika: {
counterNumber: 1234567
- В конфиге
```javascript
module.exports = {
plugins: {
'html-reporter/testplane': {
yandexMetrika: {
enabled: false
},
// другие настройки html-reporter...
},

// другие настройки плагина...
// другие плагины Testplane...
},

// другие плагины гермионы...
},

// другие настройки гермионы...
};
```
// другие настройки Testplane...
};
```
- С помощью переменных окружения: `html_reporter_yandex_metrika_enabled=false` или просто `NO_ANALYTICS=true`
- С помощью аргументов CLI: `--html-reporter-yandex_metrika_enabled=false`

### Передача параметров через CLI

Expand Down

0 comments on commit 370897c

Please sign in to comment.