Feature/canonical logger (#7)

* Support Canonical Logger

.github/ISSUE_TEMPLATE/bug_report.md

@@ -9,7 +9,7 @@ A clear and concise description of what the bug is.
 
 **Development or production environment**
  - OS: [e.g. Ubuntu 18.04]
- - PHP 7.2
+ - PHP 7.x
 
 **Additional context**
 Add any other context about the problem here.

.mergify.yml

@@ -32,7 +32,7 @@ pull_request_rules:
   -
     actions:
       comment:
-        message: "Nice! PR merged successfully."
+        message: "Nice! PR successfully merged."
     conditions:
       - merged
     name: "Merge Done 🚀"

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hello@clivern.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+## Contributing
+
+- With issues:
+  - Use the search tool before opening a new issue.
+  - Please provide source code and commit sha if you found a bug.
+  - Review existing issues and provide feedback or react to them.
+
+- With pull requests:
+  - Open your pull request against `master`
+  - Your pull request should have no more than two commits, if not you should squash them.
+  - It should pass all tests in the available continuous integrations systems such as TravisCI.
+  - You should add/modify tests to cover your proposed code changes.
+  - If your pull request contains a new feature, please document it on the README.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Clivern
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

src/EventSubscriber/RequestSubscriber.php

@@ -9,6 +9,7 @@
 
 namespace App\EventSubscriber;
 
+use App\Utils\CanonicalLogger;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
@@ -22,12 +23,18 @@ class RequestSubscriber implements EventSubscriberInterface
     /** @var LoggerInterface */
     private $logger;
 
+    /** @var CanonicalLogger */
+    private $canonicalLogger;
+
     /**
      * Class Constructor.
      */
-    public function __construct(LoggerInterface $logger)
-    {
+    public function __construct(
+        LoggerInterface $logger,
+        CanonicalLogger $canonicalLogger
+    ) {
         $this->logger = $logger;
+        $this->canonicalLogger = $canonicalLogger;
     }
 
     /**
@@ -41,6 +48,12 @@ public function onKernelRequest(RequestEvent $event)
             $event->getRequest()->get('_route'),
             $event->getRequest()->getUri()
         ));
+
+        $this->canonicalLogger->info('Request started', [
+            'http_method' => $event->getRequest()->getMethod(),
+            'http_path' => $event->getRequest()->getUri(),
+            'http_route' => $event->getRequest()->get('_route'),
+        ]);
     }
 
     /**

src/Utils/CanonicalLogger.php

@@ -0,0 +1,170 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Beagle project.
+ * (c) Clivern <hello@clivern.com>
+ */
+
+namespace App\Utils;
+
+use Psr\Log\LoggerInterface;
+
+/**
+ * CanonicalLogger Utils.
+ *
+ * @see https://stripe.com/blog/canonical-log-lines
+ */
+class CanonicalLogger
+{
+    /** @var LoggerInterface */
+    private $logger;
+
+    /**
+     * Class Constructor.
+     */
+    public function __construct(
+        LoggerInterface $logger
+    ) {
+        $this->logger = $logger;
+    }
+
+    /**
+     * System is unusable.
+     *
+     * @return void
+     */
+    public function emergency(string $action, array $flags = [])
+    {
+        $this->logger->emergency($this->format(
+            $action,
+            $flags
+        ));
+    }
+
+    /**
+     * Action must be taken immediately.
+     *
+     * @return void
+     */
+    public function alert(string $action, array $flags = [])
+    {
+        $this->logger->alert($this->format(
+            $action,
+            $flags
+        ));
+    }
+
+    /**
+     * Critical conditions.
+     *
+     * @return void
+     */
+    public function critical(string $action, array $flags = [])
+    {
+        $this->logger->critical($this->format(
+            $action,
+            $flags
+        ));
+    }
+
+    /**
+     * Runtime errors that do not require immediate action but should typically
+     * be logged and monitored.
+     *
+     * @return void
+     */
+    public function error(string $action, array $flags = [])
+    {
+        $this->logger->error($this->format(
+            $action,
+            $flags
+        ));
+    }
+
+    /**
+     * Exceptional occurrences that are not errors.
+     *
+     * @return void
+     */
+    public function warning(string $action, array $flags = [])
+    {
+        $this->logger->warning($this->format(
+            $action,
+            $flags
+        ));
+    }
+
+    /**
+     * Normal but significant events.
+     *
+     * @return void
+     */
+    public function notice(string $action, array $flags = [])
+    {
+        $this->logger->notice($this->format(
+            $action,
+            $flags
+        ));
+    }
+
+    /**
+     * Interesting events.
+     *
+     * @return void
+     */
+    public function info(string $action, array $flags = [])
+    {
+        $this->logger->info($this->format(
+            $action,
+            $flags
+        ));
+    }
+
+    /**
+     * Detailed debug information.
+     *
+     * @return void
+     */
+    public function debug(string $action, array $flags = [])
+    {
+        $this->logger->debug($this->format(
+            $action,
+            $flags
+        ));
+    }
+
+    /**
+     * Logs with an arbitrary level.
+     *
+     * @param mixed $level
+     *
+     * @return void
+     */
+    public function log($level, string $action, array $flags = [])
+    {
+        $this->logger->log($level, $this->format(
+            $action,
+            $flags
+        ));
+    }
+
+    /**
+     * Format logs to be cononical.
+     *
+     * @return string
+     */
+    private function format(string $action, array $flags = [])
+    {
+        ksort($flags);
+
+        $result = $action;
+
+        foreach ($flags as $key => $value) {
+            $result .= " {$key}={$value}";
+        }
+
+        return $result;
+    }
+}