Sign upLogin

librenms/librenms

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

Summary

Maintainability
A
3 hrs
Test Coverage

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

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

    Method generateData has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function generateData(array $alert_data, int $status, int $offset = 0): array
    {
        $namespace = $this->config['sensu-namespace'] ?: 'default';

        return [
    Severity: Minor
    Found in LibreNMS/Alert/Transport/Sensu.php - About 1 hr to fix

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

          public function deliverAlert(array $alert_data): bool
    {
        $sensu_opts['source-key'] = $this->config['sensu-source-key'];

        $url = $this->config['sensu-url'] ?: 'http://127.0.0.1:3031';
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Sensu.php - About 25 mins 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

      Avoid using undefined variables such as '$sensu_opts' which will lead to PHP notices.
      Open

              $sensu_opts['source-key'] = $this->config['sensu-source-key'];
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Sensu.php by phpmd

      UndefinedVariable

      Since: 2.8.0

      Detects when a variable is used that has not been defined before.

      Example

      class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

      Source https://phpmd.org/rules/cleancode.html#undefinedvariable

      Avoid using undefined variables such as '$sensu_opts' which will lead to PHP notices.
      Open

              throw new AlertTransportDeliveryException($alert_data, $result->status(), $result->body(), json_encode($data), $sensu_opts);
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Sensu.php by phpmd

      UndefinedVariable

      Since: 2.8.0

      Detects when a variable is used that has not been defined before.

      Example

      class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

      Source https://phpmd.org/rules/cleancode.html#undefinedvariable

      Avoid variables with short names like $s. Configured minimum length is 3.
      Open

              ], function (?string $s): bool {
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Sensu.php by phpmd

      ShortVariable

      Since: 0.2

      Detects when a field, local, or parameter has a very short name.

      Example

      class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

      Source https://phpmd.org/rules/naming.html#shortvariable

      There are no issues that match your filters.

      Category
      Status