Download the PHP package bref/monolog-bridge without Composer
On this page you can find all versions of the php package bref/monolog-bridge. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 monolog-bridge
This repository provides a Monolog log formatter optimized for AWS Lambda and CloudWatch.
Read all about logs in the Bref documentation.
Logs will be formatted to combine readability and structured data, making it easy to both read logs and filter them. Here's an example of a log record:
The JSON object contains the following fields (when applicable):
The JSON object is parsed by CloudWatch, allowing you to filter logs in CloudWatch Logs Insights. For example:
Installation
[!IMPORTANT]
This package is already installed if you use Bref's Laravel bridge or Symfony bridge. If you do, you don't need to install this package.
Usage
For Laravel applications, set the following environment variable in serverless.yml:
For Symfony applications, set the Bref Monolog formatter in your config/packages/prod/monolog.yaml:
For other applications, you can set the formatter in your Monolog configuration. For example:
Motivation
The goal of this is to improve the overall logs experience with CloudWatch.
The usual format is to log unstructured text. This sucks because:
- we can't filter by log level (e.g. look for errors)
- we can't easily filter and see all logs of a request/invocation via the AWS request ID (e.g. as log metadata)
- some log messages are split across multiple lines
- exception traces especially are split across loads of lines, not easy to navigate in CloudWatch or other line-based viewers
Here's an example:
A better approach is to switch to JSON-formatted logs:
- we can add metadata to log records (e.g. request ID to filter/see all logs of a request, or filter by log level)
- exception traces are organized as sub-metadata of the exception record, keeping things easier to navigate
But this isn't perfect:
- depending on the tool you use to view the logs, the UX can be very very poor
- it's hard to explore the logs quickly because now all info is nested in a log record, with no hierarchy to preview "just the message" quickly
- Monolog's JSON formatter adds tons of info to the JSON record
Here's an example (Bref Cloud formats the JSON payload FYI, this isn't the case in CloudWatch):
CloudWatch has some great features though:
The log message above will automatically get parsed as text (the first part) and a JSON object attached (the second part).
That means we can have a simple log message + a structured JSON object.
On top of that, with CloudWatch:
- we don't need to log the timestamp, CloudWatch automatically timestamps log records
- I don't think we need to log the "channel" name: IMO channels make sense to split web logs from jobs or artisan commands, but in Lambda these are separate functions/logs anyway, so I think we can remove that part too
This is why I want to add this CloudWatchFormatter optimized for Bref users.
As you can see in the screenshots below, it is easy to navigate the logs textually. But it's also possible to have a lot more information nested in the log records via the JSON object.
In CloudWatch:
In Bref Cloud:
In CloudWatch Logs Insights, we can see that keys of the JSON objects are correctly detected:
That allows us to create advanced queries, for example to search for "ERROR" logs with a specific exception class:
