Sign upLogin

librenms/librenms

View on GitHub
Star
LibreNMS/Alert/Transport/Elasticsearch.php

Summary

Maintainability
C
7 hrs
Test Coverage

Method deliverAlert has 104 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function deliverAlert(array $alert_data): bool
    {
        $es_host = $this->config['es-host'];
        $es_port = $this->config['es-port'] ?: 9200;
        $index = date($this->config['es-pattern'] ?: "\l\i\b\\r\\e\\n\m\s\-Y.m.d");
Severity: Major
Found in LibreNMS/Alert/Transport/Elasticsearch.php - About 4 hrs to fix

    Method configTemplate has 37 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static function configTemplate(): array
    {
        return [
            'config' => [
                [
    Severity: Minor
    Found in LibreNMS/Alert/Transport/Elasticsearch.php - About 1 hr to fix

      Function deliverAlert has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

          public function deliverAlert(array $alert_data): bool
    {
        $es_host = $this->config['es-host'];
        $es_port = $this->config['es-port'] ?: 9200;
        $index = date($this->config['es-pattern'] ?: "\l\i\b\\r\\e\\n\m\s\-Y.m.d");
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      The method deliverAlert() has 117 lines of code. Current threshold is set to 100. Avoid really long methods.
      Open

          public function deliverAlert(array $alert_data): bool
    {
        $es_host = $this->config['es-host'];
        $es_port = $this->config['es-port'] ?: 9200;
        $index = date($this->config['es-pattern'] ?: "\l\i\b\\r\\e\\n\m\s\-Y.m.d");
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php by phpmd

      The method deliverAlert() has a Cyclomatic Complexity of 13. The configured cyclomatic complexity threshold is 10.
      Open

          public function deliverAlert(array $alert_data): bool
    {
        $es_host = $this->config['es-host'];
        $es_port = $this->config['es-port'] ?: 9200;
        $index = date($this->config['es-pattern'] ?: "\l\i\b\\r\\e\\n\m\s\-Y.m.d");
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php by phpmd

      CyclomaticComplexity

      Since: 0.1

      Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

      Example

      // Cyclomatic Complexity = 11
class Foo {
1   public function example() {
2       if ($a == $b) {
3           if ($a1 == $b1) {
                fiddle();
4           } elseif ($a2 == $b2) {
                fiddle();
            } else {
                fiddle();
            }
5       } elseif ($c == $d) {
6           while ($c == $d) {
                fiddle();
            }
7        } elseif ($e == $f) {
8           for ($n = 0; $n < $h; $n++) {
                fiddle();
            }
        } else {
            switch ($z) {
9               case 1:
                    fiddle();
                    break;
10              case 2:
                    fiddle();
                    break;
11              case 3:
                    fiddle();
                    break;
                default:
                    fiddle();
                    break;
            }
        }
    }
}

      Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

      Avoid unused local variables such as '$k'.
      Open

              foreach ($alert_data['faults'] as $k => $v) {
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php by phpmd

      UnusedLocalVariable

      Since: 0.2

      Detects when a local variable is declared and/or assigned, but not used.

      Example

      class Foo {
    public function doSomething()
    {
        $i = 5; // Unused
    }
}

      Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

      A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line 27 and the first side effect is on line 25.
      Open

      <?php
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php by phpcodesniffer

      Possible parse error: class missing opening or closing brace
      Open

      class Elasticsearch extends Transport
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php by phpcodesniffer

      Possible parse error: class missing opening or closing brace
      Open

      class Elasticsearch extends Transport
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php by phpcodesniffer

      Space before opening parenthesis of function call prohibited
      Open

              $state = match ($alert_data['state']) {
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php by phpcodesniffer

      Closing brace indented incorrectly; expected 4 spaces, found 0
      Open

      }
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php by phpcodesniffer

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function deliverAlert(array $alert_data): bool
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php by phpcodesniffer

      Line indented incorrectly; expected 4 spaces, found 12
      Open

                  default => 'unknown',
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Elasticsearch.php by phpcodesniffer

      There are no issues that match your filters.

      Category
      Status