https://github.com/atoum/telemetry-extension
https://github.com/atoum/telemetry-extension
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/atoum/telemetry-extension
- Owner: atoum
- Created: 2016-10-27T14:33:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-04T00:45:52.000Z (about 7 years ago)
- Last Synced: 2025-03-24T16:46:12.698Z (about 1 month ago)
- Language: PHP
- Size: 22.5 KB
- Stars: 2
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# atoum telemetry extension [](https://travis-ci.org/atoum/telemetry-extension)
## Install it
Install extension using [composer](https://getcomposer.org):
```json
{
"require-dev": {
"atoum/telemetry-extension": "^1.0"
}
}
```
Or simply run the following command
```shell
composer require --dev atoum/telemetry-extension
```
The extension will then be autoloaded by atoum, the only thing you will have to do is to configure the report.
## Use it
The telemetry report allow us to collect metrics from your test suites. If you want to help us improve atoum, please send us your reports.
To enable the telemetry report, add the following code to your configuration file:
```php
addDefaultReport();
$telemetry = new telemetry\report();
$telemetry->addWriter(new std\out());
$runner->addReport($telemetry);
```
Now, each time your run your test suite, atoum will collect data and send them to the telemetry. By default, **everything is
sent anonymously**: a random project name will be generated and we'll only collect metrics.
If you want to let us know who you are, add the following lines to your configuration file:
```php
readProjectNameFromComposerJson(__DIR__ . '/composer.json');
// Or
$telemetry->setProjectName('my/project');
```
_The project name **must** be composer compliant._
With this configuration, atoum will send us everything about your project: the vendor name and the project name. If
you want to keep the latter secret so we only collect the vendor name, you can add the following line:
```php
sendAnonymousProjectName();
```