https://github.com/ngmy/laravel-query-log-tracker

The Laravel package which log all executed queries
https://github.com/ngmy/laravel-query-log-tracker

laravel library logging php query-log

Last synced: 3 months ago
JSON representation

The Laravel package which log all executed queries

• Host: GitHub
• URL: https://github.com/ngmy/laravel-query-log-tracker
• Owner: ngmy
• License: mit
• Created: 2020-03-28T14:48:18.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-01T21:44:23.000Z (over 2 years ago)
• Last Synced: 2025-01-24T08:31:22.169Z (4 months ago)
• Topics: laravel, library, logging, php, query-log
• Language: PHP
• Size: 880 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel Query Log Tracker

[![Latest Stable Version](https://poser.pugx.org/ngmy/laravel-query-log-tracker/v/stable)](https://packagist.org/packages/ngmy/laravel-query-log-tracker)

[![Total Downloads](https://poser.pugx.org/ngmy/laravel-query-log-tracker/downloads)](https://packagist.org/packages/ngmy/laravel-query-log-tracker)

[![Latest Unstable Version](https://poser.pugx.org/ngmy/laravel-query-log-tracker/v/unstable)](https://packagist.org/packages/ngmy/laravel-query-log-tracker)

[![License](https://poser.pugx.org/ngmy/laravel-query-log-tracker/license)](https://packagist.org/packages/ngmy/laravel-query-log-tracker)

[![composer.lock](https://poser.pugx.org/ngmy/laravel-query-log-tracker/composerlock)](https://packagist.org/packages/ngmy/laravel-query-log-tracker)


[![PHP CI](https://github.com/ngmy/laravel-query-log-tracker/workflows/PHP%20CI/badge.svg)](https://github.com/ngmy/laravel-query-log-tracker/actions?query=workflow%3A%22PHP+CI%22)

[![Coverage Status](https://coveralls.io/repos/github/ngmy/laravel-query-log-tracker/badge.svg?branch=master)](https://coveralls.io/github/ngmy/laravel-query-log-tracker?branch=master)

The Laravel package which log all executed queries.

## Demo

![Demo](https://ngmy.github.io/laravel-query-log-tracker/demo.gif)

## Features

Laravel Query Log Tracker has the following features:

* Log all executed queries with the following items:

  * SQL with bound parameters

  * Bind parameters

  * Execution time in milliseconds

  * Connection name

* Disable/Enable query logging at runtime

* More configurations:

  * Log level

  * Exclude patterns

  * Channels

## Requirements

Laravel Query Log Tracker has the following requirements:

* PHP >= 7.3

* Laravel >= 6.0

## Installation

Execute the Composer `require` command:

```console

composer require ngmy/laravel-query-log-tracker

```

This will update your `composer.json` file and install this package into the `vendor` directory.

If you don't use package discovery, add the service provider to the `providers` array in the `config/app.php` file:

```php

Ngmy\LaravelQueryLogTracker\QueryLogTrackerServiceProvider::class,

```

If you don't use package discovery, add the alias to the `aliases` array in the `config/app.php` file:

```php

'QueryLogTracker' => Ngmy\LaravelQueryLogTracker\QueryLogTrackerFacade::class,

```

### Publishing Configuration

Execute the Artisan `vendor:publish` command:

```console

php artisan vendor:publish

```

This will publish the configuration file to the `config/ngmy-query-log-tracker.php` file.

You can also use the tag to execute the command:

```console

php artisan vendor:publish --tag=ngmy-query-log-tracker

```

You can also use the service provider to execute the command:

```console

php artisan vendor:publish --provider="Ngmy\LaravelQueryLogTracker\QueryLogTrackerServiceProvider"

```

## Usage

### Log Queries

Execute queries with Laravel. That's all.

### Disable Log

There are two ways to disable log.

```php

QueryLogTracker::beginDisable();

// Execute queries for which you want to disable log

QueryLogTracker::endDisable();

```

```php

QueryLogTracker::disable(function () {

    // Execute queries for which you want to disable log

});

```