Overview

You can configure code coverage behavior by creating a configuration file named code-coverage.datadog.yml or code-coverage.datadog.yaml in the root of your repository.

Example configuration file:

ignore:
  - "test/**/*"
  - "**/*.pb.go"

Pattern syntax

Configuration options that accept file paths support three types of patterns:

• regex
• glob
• path_prefix

The pattern type is automatically detected based on the syntax you use.

Regex patterns

Patterns containing regex-specific characters (+, {, }, |, (, ), ^, $, \) are treated as regular expressions:

• ".*\\.pb\\.go$" - Matches files ending with .pb.go
• "^generated/.*" - Matches files in the generated directory
• ".*_test\\.go$" - Matches test files

Note: Regex patterns are automatically anchored with ^...$ for whole-path matching. Use forward slashes (/) as path separators in regex patterns.

Glob patterns

Patterns containing glob-specific characters (*, ?, [, ]) are treated as glob patterns:

• "**/*.java" - Matches all Java files
• "src/test/**/*" - Matches all files under src/test
• "*.pb.go" - Matches protobuf files in any directory

Note: Use ** to match directories recursively. The pattern folder/* matches only direct children, while folder/**/* matches all descendants.

Prefix patterns

Simple path prefixes without special characters are treated as prefix matches:

• "vendor/" - Matches all files under vendor directory
• "third_party/" - Matches third-party code
• "generated/" - Matches generated code

Ignoring paths

You can exclude specific files or directories from code coverage reporting using the ignore field. This is useful for excluding test files, generated code, vendor dependencies, and other files that should not be included in coverage metrics.

ignore:
  - "test/**/*"           # Exclude all files in test directory
  - "*.pb.go"             # Exclude all protobuf generated files
  - "vendor/"             # Exclude vendor directory

Exceptions

Add ! before a pattern to create an exception to your ignore rules. This lets you include specific files or folders that would otherwise be excluded.

ignore:
  - "generated/"          # Ignore all generated code
  - "!generated/core/"    # Except core generated files

Important: Negative patterns take precedence over positive patterns. If any negative pattern matches a file path, that path will not be ignored.

Examples

Exclude test files and generated code

ignore:
  - "**/*_test.go"        # Exclude Go test files
  - "**/*.pb.go"          # Exclude protobuf files
  - "vendor/"             # Exclude vendor directory
  - "mocks/"              # Exclude mock files

Exclude with exceptions

ignore:
  - "generated/"          # Ignore all generated code
  - "!generated/core/"    # Except core generated files
  - "test/"               # Ignore test directory
  - "!test/integration/"  # Except integration tests

Mixed pattern types

ignore:
  - "^vendor/.*"          # Regex: exclude vendor (anchored)
  - "**/*.min.js"         # Glob: exclude minified JS files
  - "dist/"               # Prefix: exclude dist directory
  - ".*\\.pb\\.go$"       # Regex: exclude protobuf files

Further reading

추가 유용한 문서, 링크 및 기사:

Code CoverageDOCUMENTATION Set up Code CoverageDOCUMENTATION