blackfire/player

A powerful web crawler and web scraper with Blackfire support

v2.6.21 2024-11-04 14:41 UTC

Requires

• php: >=8.3
• ext-ctype: *
• ext-filter: *
• ext-intl: *
• ext-mbstring: *
• blackfire/php-sdk: ^2.1
• fakerphp/faker: ^1.10
• maltyxx/images-generator: ^1.0
• mtdowling/jmespath.php: ^2.2
• nyholm/psr7: ^1.6
• psr/log: ^3.0
• sentry/sentry: ^4.0
• symfony/console: 7.1.*
• symfony/css-selector: 7.1.*
• symfony/dom-crawler: 7.1.*
• symfony/event-dispatcher: 7.1.*
• symfony/expression-language: 7.1.*
• symfony/filesystem: 7.1.*
• symfony/finder: ^7.0
• symfony/http-client: 7.1.*
• symfony/mime: 7.1.*
• symfony/polyfill-uuid: ^1.28
• symfony/property-access: 7.1.*
• symfony/serializer: 7.1.*
• symfony/yaml: 7.1.*

Requires (Dev)

• symfony/phpunit-bridge: 7.1.*
• symfony/process: 7.1.*
• symfony/var-dumper: 7.1.*

Replaces

• symfony/polyfill-ctype: *
• symfony/polyfill-intl-grapheme: *
• symfony/polyfill-intl-idn: *
• symfony/polyfill-intl-normalizer: *
• symfony/polyfill-mbstring: *
• symfony/polyfill-php72: *
• symfony/polyfill-php80: *

MIT

• Fabien Potencier

• scraper
• crawler
• blackfire

README

Blackfire Player is a powerful performance testing application. It provides a nice DSL to crawl HTTP services, assert responses, and extract data from HTML/XML/JSON responses.

Read more about how to download and use Blackfire Player.

Usage

blackfire-player is distributed through a Docker image.

To run a scenario located in the my-scenario.bkf file, run the following command:

docker run --rm -it -e BLACKFIRE_CLIENT_ID -e BLACKFIRE_CLIENT_TOKEN -v "`pwd`:/app" blackfire/player run my-scenario.bkf

The pwd part is the local working directory (we are using the current directory here) and it is mapped to the /app path in the Docker container.

BLACKFIRE_CLIENT_ID and BLACKFIRE_CLIENT_TOKEN environment variables need to be properly exposed from the host in order to be able to use the :doc:`Blackfire Profiler integration </integrations/blackfire-player>`.

Note

To make it simpler to run this command, you might create a shell alias (that you can store in a .bashrc or .zshrc file depending on your shell):

alias blackfire-player="docker run --rm -it -e BLACKFIRE_CLIENT_ID -e BLACKFIRE_CLIENT_TOKEN -v \"`pwd`:/app\" blackfire/player"

Don't forget to restart your terminal for it to take effect. You can then use blackfire-player as if it was the binary itself:

blackfire-player --version
blackfire-player list
blackfire-player run my-scenario.bkf