Download the PHP package cybex/laravel-query-tracer without Composer
On this page you can find all versions of the php package cybex/laravel-query-tracer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cybex/laravel-query-tracer
More information about cybex/laravel-query-tracer
Files in cybex/laravel-query-tracer
Package laravel-query-tracer
Short Description Add stacktraces to your Model queries.
License MIT
Homepage https://github.com/cybex-gmbh/laravel-query-tracer
FAQ
Example:
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 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.
Informations about the package laravel-query-tracer
Laravel Query Tracer [](https://packagist.org/packages/cybex/laravel-query-tracer) [](https://packagist.org/packages/cybex/laravel-query-tracer)  [](https://github.com/cybex-gmbh/laravel-query-tracer/pull/) [](https://github.com/cybex-gmbh/laravel-query-tracer/issues/) [](https://laravel.com/docs/7.x) 
Stack Traces for Your Queries.
If you ever wondered where specific queries in your log originate from, or wanted to easily track down the code that caused a slow query, this package is for you.
Laravel Query Tracer hooks into your Eloquent and adds information from the most useful stack frame it finds, and adds not only the class, file, line number, function name and called function, but also the relevant part of the source file.
Installation
You can install the package via composer:
Usage
To activate the Query Tracer, just add the following line to your .env file:
Once you have done this, all Model queries will contain a comment with useful information to locate the source of the query.
The easiest way to evaluate the queries is to install Laravel Telescope, the Laravel Debugbar or any other package that will log and display queries.
Configuration
The query-tracer.php config file can be published using the following command:
You can customize a variety of options which are explained in the comments inside the configuration file.
Additionally, some options can also be set using environment settings that you can put in your .env file as needed.
The available options with their corresponding env settings and defaults are:
| Option | Env | Default | Description |
|---|---|---|---|
| enabled | QUERY_TRACER_ENABLED | false | Main switch for turning query tracer integration on/off. |
| mode | QUERY_TRACER_MODE | default | Default mode of operation. When set to scoped, it will run in default mode. |
| modelNamespace | QUERY_TRACER_MODEL_NAMESPACE | '' | The path to your Models directory, relative to /app. |
| restrictToDriver | QUERY_TRACER_DRIVER | '*' | Specify which driver Query Tracer will attach to (e.g. mysql, pgsql, sqlite). If set to '*', it will attach to the first established connection. |
| trace.logArray.enabled | QUERY_TRACER_ENABLE_ARRAY_TRACE | true | If true, a trace key will be added to Laravel's QueryLog with all the information requested in logArray.values. |
| trace.logArray.key | QUERY_TRACER_LOG_KEY | 'trace' | Name of the key that will be used for adding the trace to the QueryLog. |
| trace.sqlComment.enabled | QUERY_TRACER_ENABLE_COMMENT_TRACE | true | If true, the query trace will be added to the query as an SQL comment. In default mode, the comment is added AFTER execution for logging only. In scoped mode, it will be added to the query BEFORE execution. |
| trace.sqlComment.tag | QUERY_TRACER_TAG | '' | If set, the SQL comments will carry this tag right after the opening comment token (/*). |
Modes of Operation
Query Tracer comes with two different modes of operation that are different in how they hook into the framework. If you
are debugging your queries locally within Laravel Telescope or
the Laravel Debugbar, you will want to use default mode. If you want
the traces to appear in your database server, for example inside a slow query log or any other server log, you will have
to use scoped mode.
Default Mode
In default mode, Query Tracer overrides the logging method of Laravel's Database Connection class. In this mode, the
SQL comments are added to the queries after they have been executed on your DB server, and thus will not appear on the
server itself. Also, you can enable adding trace information to every QueryLog entry via trace.logArray:
By default, the key is called trace, but can be renamed using the trace.logArray.key option.
Scoped Mode
In scoped mode, Query Tracer attaches a global scope to each of your Models that will add a where 1 to each query
that attaches the SQL comment with the trace. Therefore, each query is modified before its being executed and will
therefore be present in all logs along the way. Note that adding traces to the QueryLog will not work in scoped mode,
because the log method will not the overridden.
Available Trace Values
The query-tracer.trace.logArray.values and query-tracer.trace.sqlComment.template options configure the values that
will be included in the QueryLog array and the SQL comments, respectively. The available values are the same for both
options; the only difference is that you need to precede them with @ for use in the SQL template.
The following values are available for use:
call
The call that triggered the query, including a synopsis of its arguments.
class
The class of the object the call was executed on.
compiled
Only set if the call is inside of a compiled Blade view. It then contains the file path of the compiled view,
while file contains the name of the original Blade template.
file
The file that contains the call, including the path relative to the project root.
line
The number of the line that contains the call.
source
The part of the source code that contains the call. The amount of code listed is configurable with
the query-tracer.trace.includeSourceLines setting.
Custom Formatters
You can replace for formatters for source code, call arguments, QueryLog arrays and SQL comments with your own implementations by replacing the classes defined in the configuration.
Argument Formatter
The argument formatter converts the call arguments from the stack frame into a printable representation. The formatter
class used is configured in query-tracer.backtrace.argumentFormatter. Argument formatters need to
implement Cybex\QueryTracer\Interfaces\ArgumentFormatterInterface.
A very easy implementation of a custom argument formatter that only prints arguments' types could look like this:
To activate your implementation, you would then set 'argumentFormatter' => App\Classes\CustomArgumentFormatter::class
in the configuration.
Source Code Formatter
The source code formatter is responsible for retrieving the source code of a given file and return it in a printable
form. The formatter class is configured in query-tracer.backtrace.sourceCodeFormatter. Your own implementation has to
extend Cybex\QueryTracer\Classes\AbstractSourceCodeFormatter.
LogArray Formatter
The LogArray formatter turns the raw trace array into an array ready to append to the DB QueryLog. The class can be
configured in query-tracer.trace.logArray.formatter. Your own implementation needs to
extend Cybex\QueryTracer\Classes\AbstractTraceFormatter which in essence only provides a format() method that must
return an array or null.
SQL Comment Formatter
The SQL comment formatter formats the data from the raw trace array and populates the template configured
in query-tracer.trace.sqlComment.template. The formatter class is defined in query-tracer.trace.sqlComment.formatter
. Like the LogArray formatter, your implementation needs to extend Cybex\QueryTracer\Classes\AbstractTraceFormatter
which in essence only provides a format() method that must return a string or null.
Testing
Requirements
- PHP: 7.3, 7.4, 8.0, 8.1
- Laravel: 7, 8, 9
Changelog
Please see CHANGELOG for more information on what has changed recently.
Known Issues
- If there are any question marks in your trace, e.g. in the code listing, QueryExceptions will replace them with the parameter bindings, thus breaking the exception message (see related issue). This is only a display issue in Laravel and will not affect query execution on the database server. To mitigate this, question marks are replaced with a UTF-8 fullwidth question mark.
- If the origin of a query is a template, line numbers always refer to the compiled view. Since compiled views are not helpful in debugging, the original view file is automatically resolved and referenced. Thus, the source code location shown will only be accurate for very simple templates. The use of includes, blade components and directives may move the originating call in a different location. Therefore, always take the line numbers and source code of view locations with a grain of salt.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Web development team at Cybex GmbH - cybex-online.com
- Oliver Matla
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
