معرفی Blackfire¶

Blackfire از بخش‌های متعددی ساخته شده است:

• یک client که نمایه‌سازی را راه می‌اندازد (ابزار CLI مربوط به Blackfire یا یک افزونه‌ی مرورگر برای گوگل کروم یا فایرفاکس)؛
• یک مأمور (agent) که داده‌ها را برای ارسال به blackfire.io جهت نمایش، مهیا و تجمیع می‌کند؛
• یک افزونه‌ی PHP (probe) که کد PHP را به وسایل اندازه‌گیری مجهز می‌کند؛

برای کار با Blackfire، ابتدا لازم است که ثبت‌نام کنید.

با اجرای اسکریپت نصب سریع زیر، Blackfire را بر روی رایانه‌ی محلی‌تان نصب کنید:

1

$ curl https://installer.blackfire.io/ | bash

این نصاب، ابزار CLI مربوط به Blackfire را بارگیری کرده و PHP probe را بر روی تمام نسخه‌های PHP نصب می‌کند (بدون فعال‌سازی آن).

PHP probe را برای پروژه‌مان فعال کنید:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

--- a/php.ini
+++ b/php.ini
@@ -7,3 +7,7 @@ session.use_strict_mode=On
 realpath_cache_ttl=3600
 zend.detect_unicode=Off
 xdebug.file_link_format=vscode://file/%f:%l
+
+[blackfire]
+# use php_blackfire.dll on Windows
+extension=blackfire.so

وب سرور را بازراه‌اندازی کنید تا PHP بتواند Blackfire را بار بگیرد:

1
2

$ symfony server:stop
$ symfony server:start -d

ابزار CLI مربوط به Blackfire، نیاز دارد تا با اعتبارنامه‌های client شخصی‌تان پیکربندی شود (برای ذخیره‌ی نمایه‌های پروژه‌ی شما در اکانت شخصی‌تان). آن‌ها را در بالای صفحه‌ی Settings/Credentials پیدا کنید و فرمان‌های زیر را با جایگذاری مقادیر مربوطه، اجرا کنید:

1

$ blackfire config --client-id=xxx --client-token=xxx

تنظیم مأمور Blackfire بر روی Docker¶

آخرین گام، افزودن سرویس مأمور Blackfire به پشته‌ی Docker Compose است:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -20,3 +20,8 @@ services:
     mailer:
         image: schickling/mailcatcher
         ports: [1025, 1080]
+
+    blackfire:
+        image: blackfire/blackfire
+        env_file: .env.local
+        ports: [8707]

برای ارتباط با سرور، شما نیاز دارید تا اعتبارنامه‌های server شخصی‌تان را بدست آورید (این اعتبارنامه‌ها، جایی که می‌خواهید نمایه‌ها را در آن ذخیره کنید، مشخص می‌کنند -- می‌توانید برای هر پروژه یکی ایجاد کنید)؛ آن‌ها در پایین صفحه‌ی Settings/Credentials قابل یافتن هستند. آن‌ها را در فایل محلی .env.local ذخیره کنید:

1
2

BLACKFIRE_SERVER_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
BLACKFIRE_SERVER_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

حالا می‌توانید کانتینر جدید را راه‌اندازی کنید:

1
2

$ docker-compose stop
$ docker-compose up -d

تعمیر یک نصبِ خرابِ Blackfire¶

اگر هنگام profiling خطا دریافت می‌کنید، سطح لاگ را در Blackfire افزایش دهید تا اطلاعات بیشتری در لاگ‌ها دریافت کنید:

1
2
3
4
5
6
7

--- a/php.ini
+++ b/php.ini
@@ -10,3 +10,4 @@ zend.detect_unicode=Off
 [blackfire]
 # use php_blackfire.dll on Windows
 extension=blackfire.so
+blackfire.log_level=4

وب سرور را بازراه‌اندازی کنید:

1
2

$ symfony server:stop
$ symfony server:start -d

و لاگ‌ها را دنبال کنید:

1

$ symfony server:log

مجدداً نمایه‌سازی کرده و خروجی لاگ را بررسی کنید.

پیکربندی Blackfire در محیط عمل‌آوری¶

Blackfire به صورت پیشفرض در تمام پروژه‌های SymfonyCloud قرار داده شده است.

اعتبارنامه‌های server را به عنوان متغیر محیط تنظیم کنید:

1
2

$ symfony var:set BLACKFIRE_SERVER_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
$ symfony var:set BLACKFIRE_SERVER_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

PHP probe را مثل سایر افزونه‌های PHP فعال کنید:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

--- a/.symfony.cloud.yaml
+++ b/.symfony.cloud.yaml
@@ -4,6 +4,7 @@ type: php:7.4

 runtime:
     extensions:
+        - blackfire
         - xsl
         - amqp
         - redis

پیکربندی Varnish برای Blackfire¶

قبل از اینکه بتوانید مستقر کنید و profiling را شروع کنید، نیاز دارید که از نهان‌سازی HTTP توسط Varnish عبور کنید (آن را دور بزنید). اگر اینکار را نکنید، Blackfire هرگز نمی‌تواند به اپلیکیشن PHP دست یابد. شما تنها درخواست‌های نمایه‌سازی‌ای که از رایانه‌ی محلی‌تان می‌آید را مجاز خواهید شمرد.

IP فعلی‌تان را پیدا کنید:

1

$ curl https://ifconfig.me/

و از آن برای پیکربندی Varnish استفاده کنید:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

--- a/.symfony/config.vcl
+++ b/.symfony/config.vcl
@@ -1,3 +1,11 @@
+acl profile {
+   # Authorize the local IP address (replace with the IP found above)
+   "a.b.c.d";
+   # Authorize Blackfire servers
+   "46.51.168.2";
+   "54.75.240.245";
+}
+
 sub vcl_recv {
     set req.backend_hint = application.backend();
     set req.http.Surrogate-Capability = "abc=ESI/1.0";
@@ -8,6 +16,16 @@ sub vcl_recv {
         }
         return (purge);
     }
+
+    # Don't profile ESI requests
+    if (req.esi_level > 0) {
+        unset req.http.X-Blackfire-Query;
+    }
+
+    # Bypass Varnish when the profile request comes from a known IP
+    if (req.http.X-Blackfire-Query && client.ip ~ profile) {
+        return (pass);
+    }
 }

 sub vcl_backend_response {

حالا می‌توانید استقرار را انجام دهید.

نمایه‌سازی صفحات وب¶

شما می‌توانید صفحات وب سنتی را از طریق فایرفاکس یا گوگل کروم و از طریق افزونه‌ی اختصاصی آن‌ها ، نمایه‌سازی کنید.

فراموش نکنید که هنگام نمایه‌سازی، بر روی رایانه‌ی محلی‌تان، نهان‌سازی HTTP را در public/index.php غیرفعال کنید: اگر اینکار را نکنید، شما به جای کدتان، لایه‌ی نهان‌سازی HTTP در سیمفونی را نمایه‌سازی خواهید کرد:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

--- a/public/index.php
+++ b/public/index.php
@@ -24,7 +24,7 @@ if ($trustedHosts = $_SERVER['TRUSTED_HOSTS'] ?? $_ENV['TRUSTED_HOSTS'] ?? false
 $kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);

 if ('dev' === $kernel->getEnvironment()) {
-    $kernel = new HttpCache($kernel);
+//    $kernel = new HttpCache($kernel);
 }

 $request = Request::createFromGlobals();

برای به دست آوردن یک تصویر بهتر از کارایی اپلیکیشن‌تان در محیط عمل‌آوری، شما باید محیط «عمل‌آوری» را نیز نمایه‌سازی کنید. به صورت پیشفرض، محیط محلی شما از محیط «توسعه» استفاده می‌کند که سربار زیادی ایجاد می‌نماید (غالباً برای جمع‌آوری داده برای نوارابزار اشکال‌زدایی وب و نمایه‌ساز سیمفونی).

تعویض محیط رایانه‌ی محلی‌تان به محیط عمل‌آوری، از طریق تغییر متغیر محیط APP_ENV در فایل .env.local قابل انجام است:

1

APP_ENV=prod

یا می‌توانید از فرمان server:prod استفاده کنید:

1

$ symfony server:prod

فراموش نکنید که پس از پایان نمایه‌سازی، به محیط توسعه برگردید:

1

$ symfony server:prod --off

نمایه‌سازی منابع API¶

بهتر است نمایه‌سازی API یا SPA، با CLI و از طریق ابزار Blackfire CLI که قبلاً نصب کردید، انجام شود:

1

$ blackfire curl `symfony var:export SYMFONY_PROJECT_DEFAULT_ROUTE_URL`api

فرمان blackfire curl دقیقاً همان آرگمان‌ها و گزینه‌های cURL را می‌پذیرد.

مقایسه‌ی کارایی¶

در گام مربوط به «نهان‌سازی»، ما لایه‌ی نهان‌سازی را برای افزایش کارایی کدمان اضافه کردیم اما تأثیر این تغییر بر کارایی را اندازه‌گیری یا بررسی نکردیم. از آنجایی که همه‌ی ما در حدس‌زدن اینکه چه‌چیزی سریع و چه‌چیزی کند خواهد بود، بسیار بد هستیم، شما ممکن است در نهایت به وضعیتی برسید که برخی بهینه‌سازی‌ها در حقیقت اپلیکیشن‌تان را کندتر کند.

شما باید همیشه تأثیر هر بهینه‌سازی‌ای که انجام می‌دهید را با یک نمایه‌ساز اندازه بگیرید. Blackfire به کمک ویژگی مقایسه‌اش، به صورت بصری آن را ساده‌تر می‌کند.

نوشتن آزمون‌های کارکردی جعبه‌سیاه¶

ما نحوه‌ی نوشتن آزمون‌های کارکردی در سیمفونی را دیده‌ایم. Blackfire می‌تواند برای نوشتن سناریوهای مرور‌کردن وب‌سایت استفاده شود که در موقع نیاز می‌توان آن را از طریق Blackfire player اجرا کرد. بیایید یک سناریو برای ارسال یک کامنت جدید بنویسیم که در محیط توسعه اعتبارسنجی آن از طریق پیوند رایانامه و در محیط عمل‌آوری از طریق مدیر انجام می‌شود.

یک فایل .blackfire.yaml با محتوای زیر ایجاد کنید:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

scenarios: |
    #!blackfire-player

    group login
        visit url('/login')
        submit button("Sign in")
            param username "admin"
            param password "admin"
            expect status_code() == 302

    scenario
        name "Submit a comment on the Amsterdam conference page"
        include login
        visit url('/fr/conference/amsterdam-2019')
            expect status_code() == 200
        submit button("Submit")
            param comment_form[author] 'Fabien'
            param comment_form[email] '[email protected]'
            param comment_form[text] 'Such a good conference!'
            param comment_form[photo] file(fake('image', '/tmp', 400, 300, 'cats'), 'awesome-cat.jpg')
            expect status_code() == 302
        follow
            expect status_code() == 200
            expect not(body() matches "/Such a good conference/")
            # Wait for the workflow to validate the submissions
            wait 5000
        when env != "prod"
            visit url(webmail_url ~ '/messages')
                expect status_code() == 200
                set message_ids json("[*].id")
            with message_id in message_ids
                visit url(webmail_url ~ '/messages/' ~ message_id ~ '.html')
                    expect status_code() == 200
                    set accept_url css("table a").first().attr("href")
                visit url(accept_url)
                    # we don't check the status code as we can deal
                    # with "old" messages which do not exist anymore
                    # in the DB (would be a 404 then)
        when env == "prod"
            visit url('/admin/?entity=Comment&action=list')
                expect status_code() == 200
                set comment_ids css('table.table tbody tr').extract('data-id')
            with id in comment_ids
                visit url('/admin/comment/review/' ~ id)
                    # we don't check the status code as we scan all comments,
                    # including the ones already reviewed
        visit url('/fr/')
            wait 5000
        visit url('/fr/conference/amsterdam-2019')
            expect body() matches "/Such a good conference/"

Blackfire player را بارگیری کنید تا قادر به اجرای سناریو به صورت محلی باشید:

1
2

$ curl -OLsS https://get.blackfire.io/blackfire-player.phar
$ chmod +x blackfire-player.phar

سناریو را در محیط توسعه اجرا کنید:

1

$ ./blackfire-player.phar run --endpoint=`symfony var:export SYMFONY_PROJECT_DEFAULT_ROUTE_URL` .blackfire.yaml --variable "webmail_url=`symfony var:export MAILER_WEB_URL 2>/dev/null`" --variable="env=dev"

یا در محیط عمل‌آوری:

1

$ ./blackfire-player.phar run --endpoint=`symfony env:urls --first` .blackfire.yaml --variable "webmail_url=NONE" --variable="env=prod"

همچنین سناریوهای Blackfire می‌توانند برای هر درخواست نمایه‌سازی را راه‌اندازی کرده و با افزودن پرچم --blackfire، آزمون‌های کارایی را اجرا کنند.

خودکارسازی بررسی‌های کارایی¶

مدیریت کارایی تنها درباره‌ی بهبود کارایی کد موجود نیست و شامل بررسی اینکه روند کارایی نزولی نباشد نیز هست.

سناریوی نوشته‌شده در بخش قبلی می‌تواند به صورت خودکار در یک جریان‌کار ادغام مستمر (Continuous Integration) یا در محیط عمل‌آوری و بر اساس یک زمان‌بندی منظم اجرا گردد.

همچنین در SymfonyCloud این اجازه داده شده است که وقتی یک شاخه جدید ایجاد می‌کنید یا در محیط عمل‌آوری استقرار انجام می‌دهید، برای بررسی کارایی کد جدید به صورت خودکار سناریوها اجرا شوند.