-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md: simplification (#14)
- Loading branch information
Showing
1 changed file
with
12 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,22 @@ | ||
| # Logtail - PHP Logging Made Easy | ||
|
|
||
| [](https://betterstack.com/logtail) | ||
| # [Better Stack](https://betterstack.com/logs) PHP client | ||
|
|
||
| 📣 Logtail is now part of Better Stack. [Learn more ⇗](https://betterstack.com/press/introducing-better-stack/) | ||
|
|
||
| [](LICENSE.md)  | ||
| [](https://badge.fury.io/ph/logtail%2Fmonolog-logtail) | ||
| [](https://betterstack.com/logs) | ||
|
|
||
| Collect logs from your PHP projects, including Laravel, Symfony, CodeIgniter, CakePHP, Zend, and more. | ||
| [](LICENSE.md) | ||
| [](https://badge.fury.io/ph/logtail%2Fmonolog-logtail) | ||
| [](https://github.com/logtail/monolog-logtail/actions/workflows/main.yml) | ||
|
|
||
| [Logtail](https://betterstack.com/logtail) is a hosted service that centralizes all of your logs into one place. Allowing for analysis, correlation and filtering with SQL. Actionable Grafana dashboards and collaboration come built-in. Logtail works with [any language or platform and any data source](https://docs.logtail.com/). | ||
| Experience SQL-compatible structured log management based on ClickHouse. [Learn more ⇗](https://betterstack.com/logs) | ||
|
|
||
| ### Features | ||
| - Simple integration. Built on well-known Monolog logging library. | ||
| - Support for structured logging and events. | ||
| - Automatically captures useful context. | ||
| - Performant, light weight, with a thoughtful design. | ||
| ## Documentation | ||
|
|
||
| ### Supported language versions | ||
| - PHP 8 or newer | ||
| - Composer 1.10.1 or newer | ||
| [Getting started ⇗](https://betterstack.com/docs/logs/php/) | ||
|
|
||
| # Installation | ||
|
|
||
| Install the Logtail Monolog library using composer: | ||
|
|
||
| ```bash | ||
| composer require logtail/monolog-logtail | ||
| ``` | ||
|
|
||
| **Using older Monolog?** Install Logtail for Monolog 2: | ||
|
|
||
| ```bash | ||
| composer require logtail/monolog-logtail:^2.0.0 | ||
| ``` | ||
| --- | ||
|
|
||
| # Example project | ||
|
|
||
| To help you get started with using Logtail in your PHP projects, we have prepared a simple program that showcases the usage of Logtail logger. | ||
|
|
||
| ## Download and install the example project | ||
|
|
||
| You can download the [example project](https://github.com/logtail/monolog-logtail/tree/master/example-project) from GitHub directly or you can clone it to a select directory. In that directory, run the following command: | ||
|
|
||
| ```bash | ||
| composer update | ||
| ``` | ||
| This command will install all dependencies from `composer.json` file and lock them in `composer.lock` file. | ||
|
|
||
| ## Run the example project | ||
|
|
||
| To run the example application, simply run the following command: | ||
|
|
||
| ```bash | ||
| php index.php <source-token> | ||
| ``` | ||
|
|
||
| *Don't forget to replace `<source-token>` with your actual source token which you can find by going to logtail.com -> sources -> edit.* | ||
|
|
||
| You should see the following output: | ||
| ```text | ||
| All done, you can check your logs in the control panel. | ||
| ``` | ||
|
|
||
| This will create and send a total of 8 log messages to the Logtail. Each message corresponds to a specific log level. Detail explanation follows below. | ||
|
|
||
| ## Explore how example project works | ||
|
|
||
| Learn how to setup PHP logging by exploring the workings of the [example project](https://github.com/logtail/monolog-logtail/tree/master/example-project) in detail. | ||
|
|
||
| ## Improved performance with batches | ||
| We extend `Monolog\Handler\BufferHandler` to send your logs periodically in batches for optimized network traffic by default. If you don't want to use batches or you want to use your own buffer handler, use `SynchronousLogtailHandler` instead. | ||
| ## Need help? | ||
| Please let us know at [[email protected]](mailto:[email protected]). We're happy to help! | ||
|
|
||
| --- | ||
|
|
||
| ## Get in touch | ||
|
|
||
| Have any questions? Please explore the Logtail [documentation](https://docs.logtail.com/) or contact our [support](https://betterstack.com/help). | ||
| [ISC license](https://github.com/logtail/monolog-logtail/blob/master/LICENSE.md), [example project](https://github.com/logtail/monolog-logtail/tree/master/example-project) |