Merge pull request #18 from crowdsecurity/improve-logging

improve logging

Author: mobula9

docs/contribute.md

@@ -62,14 +62,16 @@ We use the git workflow [Github Flow](https://guides.github.com/introduction/flo
 #### New feature
 
 ```bash
-git checkout -b feature/<the-feature>
-git commit # as mush as necessary
-git push origin feature/<the-feature>
+git checkout -b new-feature # the name is not important now.
+git commit # as mush as necessary.
+git branch -m <name-of-the-branch> # to rename the branch to what has really be done
+git push -u origin <name-of-the-branch>
 gh pr create --fill
 ```
 
 #### New release
 
 ```bash
-gh release create --draft vx.x.x
+git describe --tags # to verify what is the current tag
+gh release create --draft vx.x.x --title vx.x.x
 ```

src/ApiCache.php

@@ -239,13 +239,7 @@ private function saveRemediations(array $decisions): bool
                 }
             }
         }
-
-        $warmedUp = $this->adapter->commit();
-
-        // Store the fact that the cache has been warmed up.
-        $this->defferUpdateCacheConfig(['warmed_up' => $warmedUp]);
-
-        return $warmedUp;
+        return $this->adapter->commit();
     }
 
     private function removeRemediations(array $decisions): bool
@@ -263,7 +257,7 @@ private function removeRemediations(array $decisions): bool
                 if (!$success) {
                     // The API may return stale deletion events due to API design.
                     // Ignoring them is therefore not a problem.
-                    $this->logger->debug("Decision " . $decision['id'] . " not found in cache for one or more items.");
+                    $this->logger->debug("Decision " . $decision['id'] . " not found in cache for one or more items");
                 }
             }
         }
@@ -297,7 +291,10 @@ private function saveRemediationsForIp(array $decisions, string $ip): string
 
     public function clear(): bool
     {
-        return $this->adapter->clear();
+        $cleared = $this->adapter->clear();
+        $this->warmedUp = false;
+        $this->logger->info("Cache cleared");
+        return $cleared;
     }
 
     /**
@@ -306,20 +303,27 @@ public function clear(): bool
      * Used when the stream mode has just been activated.
      *
      */
-    private function warmUp(): void
+    public function warmUp(): void
     {
-        $this->logger->info('Warming the cache up');
+        $this->logger->debug('Warming the cache up');
         $startup = true;
         $decisionsDiff = $this->apiClient->getStreamedDecisions($startup);
         $newDecisions = $decisionsDiff['new'];
 
+        $nbNew = 0;
         if ($newDecisions) {
             $this->warmedUp = $this->saveRemediations($newDecisions);
             if (!$this->warmedUp) {
                 throw new BouncerException("Unable to warm the cache up");
             }
+            $nbNew = count($newDecisions);
         }
-        $this->logger->debug('Cache warmed up');
+        
+        // Store the fact that the cache has been warmed up.
+        $this->logger->info("Cache warmed up with $nbNew decision(s)");
+        $this->defferUpdateCacheConfig(['warmed_up' => true]);
+        $this->adapter->commit();
+
     }
 
     /**
@@ -331,26 +335,30 @@ private function warmUp(): void
      */
     public function pullUpdates(): void
     {
-        $this->logger->info('Pulling updates from API');
         if (!$this->warmedUp) {
             $this->warmUp();
+            return;
         }
 
+        $this->logger->debug('Pulling updates from API');
         $decisionsDiff = $this->apiClient->getStreamedDecisions();
         $newDecisions = $decisionsDiff['new'];
         $deletedDecisions = $decisionsDiff['deleted'];
 
+        $nbDeleted = 0;
         if ($deletedDecisions) {
             $this->removeRemediations($deletedDecisions);
+            $nbDeleted = count($deletedDecisions);
         }
-
+        
+        $nbNew = 0;
         if ($newDecisions) {
             $this->saveRemediations($newDecisions);
-            if (!$this->warmedUp) {
-                throw new BouncerException("Unable to warm the cache up");
-            }
+            $nbNew = count($newDecisions);
         }
-        $this->logger->debug('Updates pulled from API');
+        
+        
+        $this->logger->info("Updates pulled from API (-$nbDeleted+$nbNew)");
     }
 
     /**

src/Bouncer.php

@@ -124,6 +124,15 @@ public function getDefault403Template(): string
             'Please contact our technical support if you think it is an error.</p></body></html>';
     }
 
+    /**
+     * Used in stream mode only.
+     * This method should be called only to force a cache warm up.
+     */
+    public function warmBlocklistCacheUp(): void
+    {
+        $this->apiCache->warmUp();
+    }
+
     /**
      * Used in stream mode only.
      * This method should be called periodically (ex: crontab) in a asynchronous way to update the bouncer cache.
@@ -149,6 +158,14 @@ public function pruneCache(): bool
         return $this->apiCache->clear();
     }
 
+    /**
+     * Returns the logger instance.
+     */
+    public function getLogger(): LoggerInterface
+    {
+        return $this->logger;
+    }
+
     /**
      * Browse the remediations cache.
      */