rycus86/prometheus_flask_exporter

View on GitHub
prometheus_flask_exporter/__init__.py

Summary

Maintainability
F
3 days
Test Coverage

Function _track has a Cognitive Complexity of 56 (exceeds 5 allowed). Consider refactoring.
Open

    def _track(metric_type, metric_call, metric_kwargs, name, description, labels,
               registry, before=None):
        """
        Internal method decorator logic.

Severity: Minor
Found in prometheus_flask_exporter/__init__.py - About 1 day 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

File __init__.py has 440 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import os
import inspect
import warnings
import functools
import threading
Severity: Minor
Found in prometheus_flask_exporter/__init__.py - About 6 hrs to fix

    Function export_defaults has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

        def export_defaults(self, buckets=None, group_by='path',
                            prefix='flask', app=None, **kwargs):
            """
            Export the default metrics:
                - HTTP request latencies
    Severity: Minor
    Found in prometheus_flask_exporter/__init__.py - About 2 hrs 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

    Function register_endpoint has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        def register_endpoint(self, path, app=None):
            """
            Register the metrics endpoint on the Flask application.
    
            :param path: the path of the endpoint
    Severity: Minor
    Found in prometheus_flask_exporter/__init__.py - 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

    Function __init__ has 8 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def __init__(self, app, path='/metrics',
    Severity: Major
    Found in prometheus_flask_exporter/__init__.py - About 1 hr to fix

      Function _track has 7 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def _track(metric_type, metric_call, metric_kwargs, name, description, labels,
      Severity: Major
      Found in prometheus_flask_exporter/__init__.py - About 50 mins to fix

        Function export_defaults has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            def export_defaults(self, buckets=None, group_by='path',
        Severity: Minor
        Found in prometheus_flask_exporter/__init__.py - About 35 mins to fix

          Function info has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

              def info(self, name, description, labelnames=None, labelvalues=None, **labels):
          Severity: Minor
          Found in prometheus_flask_exporter/__init__.py - About 35 mins to fix

            Function __init__ has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                def __init__(self, app, path='/metrics',
                             export_defaults=True, defaults_prefix='flask',
                             group_by='path', buckets=None,
                             registry=None, **kwargs):
                    """
            Severity: Minor
            Found in prometheus_flask_exporter/__init__.py - About 35 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

            Function info has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                def info(self, name, description, labelnames=None, labelvalues=None, **labels):
                    """
                    Report any information as a Prometheus metric.
                    This will create a `Gauge` with the initial value of 1.
            
            
            Severity: Minor
            Found in prometheus_flask_exporter/__init__.py - About 35 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

            Similar blocks of code found in 2 locations. Consider refactoring.
            Open

                def histogram(self, name, description, labels=None, **kwargs):
                    """
                    Use a Histogram to track the execution time and invocation count
                    of the method.
            
            
            Severity: Major
            Found in prometheus_flask_exporter/__init__.py and 1 other location - About 1 hr to fix
            prometheus_flask_exporter/__init__.py on lines 333..348

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 47.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            Similar blocks of code found in 2 locations. Consider refactoring.
            Open

                def summary(self, name, description, labels=None, **kwargs):
                    """
                    Use a Summary to track the execution time and invocation count
                    of the method.
            
            
            Severity: Major
            Found in prometheus_flask_exporter/__init__.py and 1 other location - About 1 hr to fix
            prometheus_flask_exporter/__init__.py on lines 315..330

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 47.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            There are no issues that match your filters.

            Category
            Status