Sign upLogin

docker/docker

View on GitHub
Star
daemon/logger/awslogs/cloudwatchlogs.go

Summary

Maintainability
D
2 days
Test Coverage

File cloudwatchlogs.go has 663 lines of code (exceeds 500 allowed). Consider refactoring.
Open

// Package awslogs provides the logdriver for forwarding container logs to Amazon CloudWatch Logs
package awslogs // import "github.com/docker/docker/daemon/logger/awslogs"

import (
    "context"
Severity: Minor
Found in daemon/logger/awslogs/cloudwatchlogs.go - About 5 hrs to fix

    Method logStream.collectBatch has a Cognitive Complexity of 32 (exceeds 20 allowed). Consider refactoring.
    Open

    func (l *logStream) collectBatch(created chan bool) {
    // Wait for the logstream/group to be created
    <-created
    flushInterval := l.forceFlushInterval
    if flushInterval <= 0 {
    Severity: Minor
    Found in daemon/logger/awslogs/cloudwatchlogs.go - 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 newAWSLogsClient has 68 lines of code (exceeds 50 allowed). Consider refactoring.
    Open

    func newAWSLogsClient(info logger.Info, configOpts ...func(*config.LoadOptions) error) (*cloudwatchlogs.Client, error) {
    ctx := context.TODO()
    var region, endpoint *string
    if os.Getenv(regionEnvKey) != "" {
        region = aws.String(os.Getenv(regionEnvKey))
    Severity: Minor
    Found in daemon/logger/awslogs/cloudwatchlogs.go - About 1 hr to fix

      Function New has 55 lines of code (exceeds 50 allowed). Consider refactoring.
      Open

      func New(info logger.Info) (logger.Logger, error) {
    containerStreamConfig, err := newStreamConfig(info)
    if err != nil {
        return nil, err
    }
      Severity: Minor
      Found in daemon/logger/awslogs/cloudwatchlogs.go - About 1 hr to fix

        Method logStream.collectBatch has 52 lines of code (exceeds 50 allowed). Consider refactoring.
        Open

        func (l *logStream) collectBatch(created chan bool) {
    // Wait for the logstream/group to be created
    <-created
    flushInterval := l.forceFlushInterval
    if flushInterval <= 0 {
        Severity: Minor
        Found in daemon/logger/awslogs/cloudwatchlogs.go - About 1 hr to fix

          Function newStreamConfig has 51 lines of code (exceeds 50 allowed). Consider refactoring.
          Open

          func newStreamConfig(info logger.Info) (*logStreamConfig, error) {
    logGroupName := info.Config[logGroupKey]
    logStreamName, err := loggerutils.ParseLogTag(info, "{{.FullID}}")
    if err != nil {
        return nil, err
          Severity: Minor
          Found in daemon/logger/awslogs/cloudwatchlogs.go - About 1 hr to fix

            Function ValidateLogOpt has 8 return statements (exceeds 4 allowed).
            Open

            func ValidateLogOpt(cfg map[string]string) error {
    for key := range cfg {
        switch key {
        case logGroupKey:
        case logStreamKey:
            Severity: Major
            Found in daemon/logger/awslogs/cloudwatchlogs.go - About 50 mins to fix

              Function ValidateLogOpt has a Cognitive Complexity of 23 (exceeds 20 allowed). Consider refactoring.
              Open

              func ValidateLogOpt(cfg map[string]string) error {
    for key := range cfg {
        switch key {
        case logGroupKey:
        case logStreamKey:
              Severity: Minor
              Found in daemon/logger/awslogs/cloudwatchlogs.go - About 45 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 newStreamConfig has 7 return statements (exceeds 4 allowed).
              Open

              func newStreamConfig(info logger.Info) (*logStreamConfig, error) {
    logGroupName := info.Config[logGroupKey]
    logStreamName, err := loggerutils.ParseLogTag(info, "{{.FullID}}")
    if err != nil {
        return nil, err
              Severity: Major
              Found in daemon/logger/awslogs/cloudwatchlogs.go - About 45 mins to fix

                Function newAWSLogsClient has 6 return statements (exceeds 4 allowed).
                Open

                func newAWSLogsClient(info logger.Info, configOpts ...func(*config.LoadOptions) error) (*cloudwatchlogs.Client, error) {
    ctx := context.TODO()
    var region, endpoint *string
    if os.Getenv(regionEnvKey) != "" {
        region = aws.String(os.Getenv(regionEnvKey))
                Severity: Major
                Found in daemon/logger/awslogs/cloudwatchlogs.go - About 40 mins to fix

                  Function New has a Cognitive Complexity of 21 (exceeds 20 allowed). Consider refactoring.
                  Open

                  func New(info logger.Info) (logger.Logger, error) {
    containerStreamConfig, err := newStreamConfig(info)
    if err != nil {
        return nil, err
    }
                  Severity: Minor
                  Found in daemon/logger/awslogs/cloudwatchlogs.go - 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

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

                          if errors.As(err, &apiErr) {
            fields := log.Fields{
                "errorCode":      apiErr.ErrorCode(),
                "message":        apiErr.ErrorMessage(),
                "logGroupName":   l.logGroupName,
                  Severity: Major
                  Found in daemon/logger/awslogs/cloudwatchlogs.go and 1 other location - About 1 hr to fix
                  daemon/logger/awslogs/cloudwatchlogs.go on lines 516..529

                  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 161.

                  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

                          if errors.As(err, &apiErr) {
            fields := log.Fields{
                "errorCode":     apiErr.ErrorCode(),
                "message":       apiErr.ErrorMessage(),
                "logGroupName":  l.logGroupName,
                  Severity: Major
                  Found in daemon/logger/awslogs/cloudwatchlogs.go and 1 other location - About 1 hr to fix
                  daemon/logger/awslogs/cloudwatchlogs.go on lines 477..490

                  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 161.

                  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