Download the PHP package hkyss/sonar without Composer

On this page you can find all versions of the php package hkyss/sonar. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package sonar

Sonar

ci packagist

Request performance overlay for PHP. A pill in the corner of the page reports what the request cost: database queries, server timings, browser metrics, and every XHR and fetch the page makes with its own server-side query count.

Install

The root namespace is hkyss\Sonar\, lowercase vendor. PHP resolves class names case-insensitively but Composer matches PSR-4 prefixes case-sensitively, so use Hkyss\Sonar\Sonar; gets you a class that PHP considers the same and the autoloader cannot find. Copy the imports as written.

Enable

SONAR takes false (off), true (visible to everyone) or gated (collected always, shown only to whoever the gate allows).

Two settings refuse to do the dangerous thing:

Laravel

The service provider is auto-discovered. It listens for QueryExecuted, attaches SonarMiddleware to every matched route, injects the overlay into HTML responses and adds X-Sonar-* headers to the rest.

Under Octane the provider hooks RequestReceived to open each request. Nothing to configure.

Evolution CMS 3

Register the EVO provider instead of the Laravel one. It injects through OnWebPagePrerender, which also covers pages served from the EVO page cache, and gates on a manager login.

That event carries a whole document, so a template spelling no </body> — the one a fresh installation serves until it is given templates of its own — still gets the overlay, appended to the end. Documents that are not HTML are left alone by their own content type, which is where a sitemap or a feed says so.

Set SONAR=gated in core/custom/.env or in the web server environment (env[SONAR] in the php-fpm pool, SetEnv SONAR gated for mod_php).

Queries arrive from two places. EVO 3.1 runs its legacy evo()->db API on an Illuminate connection but calls logQuery() with seconds where Illuminate reports milliseconds. The integration tells them apart through Connection::beforeExecuting, which only fires for Illuminate-driven queries, and normalises the legacy timings. evo()->executedQueries is not used — EVO never increments it.

Registration is idempotent: a package chain where several providers extend one another and each registers Sonar wires the listeners once.

PSR-15

The middleware opens a new request on the way in, which is what keeps the figures per-request under RoadRunner, Swoole and friends. Mount it first. If it has to sit behind other middleware, pass new SonarMiddleware($factory, false) and call Sonar::start() yourself at the real request boundary.

Plain PHP

API

Call Purpose
Sonar::boot(?Config) Start collecting; returns null when disabled
Sonar::start(?Config) Open a new request: drop what was collected, restart the clock
Sonar::record($sql, $ms, $source) Log one statement
Sonar::add($source, $count, $ms) Log totals for a source that cannot report statements
Sonar::addUsing($source, $resolver) Same, resolved at snapshot time
Sonar::mark($name, $ms) / Sonar::timer($name) Named timing, e.g. SSR or a template render
Sonar::meta($key, $value) Extra row in the panel; a closure is resolved at snapshot time
Sonar::snapshot() Everything collected, as an array
Sonar::headers() X-Sonar-* headers for the current request
Sonar::inject($html) Overlay inserted before </body>

Connecting a system Sonar has never heard of is these calls and nothing else — see docs/integrations.md.

Reading the overlay

The pill carries two readings. The first is the page — its load time and its query count — and it stays for as long as the page does. The second appears once the page makes a request: the last one the application answered, its round trip and its query count, and how many requests there have been. On a page that navigates by fetch, that makes it the cost of the screen just loaded rather than a total that only ever climbs, and the page's own figures never leave the corner.

Row Meaning
Queries Total across all sources, broken down per source
Database / PHP / Total Wall clock split between SQL and everything else
Requests XHR and fetch calls: the median, the 95th percentile and the slowest, then each call with its round trip and query count, split into server, database and network time
Pages The pages this tab has loaded, newest first, with their server time, query count and load time, and the median across them
Repeated queries The same statement run more than once

A request's split comes from the headers on its response: server is X-Sonar-Time, db is X-Sonar-Query-Time, and net is whatever part of the round trip the server does not account for. A call to a third party carries no headers and gets no split.

One page load is one sample and says little on its own; reload a page a few times and the median is what it costs. The pages live in the tab's sessionStorage under sonar:pages, twenty at most, so they survive a reload and a click through the site and are gone with the tab. What is kept of a page is its path, the first forty characters of its query string and its three figures. clear forgets every page but the current one, which is where a comparison after a change starts.

Identical statements collapse into one row with a counter, so an N+1 reads as ×40 rather than forty lines. What is shown is the fingerprint — literals replaced by ? — which is both what makes the grouping meaningful and what keeps bind values off the page.

Client metrics (TTFB, DOMContentLoaded, Load, FCP, LCP) come from the Navigation Timing and Performance Observer APIs.

Notes and limits

Development

composer check runs the style check, PHPStan and PHPUnit. The overlay script has its own suite:

See CONTRIBUTING.md.

License

MIT — see LICENSE.


All versions of sonar with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package hkyss/sonar contains the following files

Loading the files please wait ...