elastic / apm-agent-ruby
Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope
Files includes and excluded from analyses
feature
txt
Overview of Analyzed Files
Basic stats on analyzed files
Intro
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.

  • The main category contains all manually created source code files that are being used in the production.
  • Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
  • Test source code files are used only for testing of the product. These files are normally not deployed to production.
  • Build and deployment source code files are used to configure or support build and deployment process.
  • Generated source code files are automatically generated files that have not been manually changed after generation.
  • While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
  • Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.

main18499 LOC (74%) 278 files
test497 LOC (1%) 6 files
generated0 LOC (0%) 0 files
build and deployment156 LOC (<1%) 11 files
other5816 LOC (23%) 17 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 278 files match defined criteria (18,499 LOC, 100.0% vs. main code):
    • 276 *.rb files (18,457 LOC)
    • 1 *.gemspec files (21 LOC)
    • 1 *.yaml files (21 LOC)
  • " *.rb" is biggest, containing 99.77% of LOC.
  • " *.yaml" is smallest, containing 0.11% of LOC.


*.rb18457 LOC (99%) 276 files
*.gemspec21 LOC (<1%) 1 file
*.yaml21 LOC (<1%) 1 file
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
feature
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*_tests[.].*".
    • files with paths like ".*[.]feature".
    • files with paths like ".*/test[.].*".
  • 6 files match defined criteria (497 LOC, 2.7% vs. main code). All matches are in *.feature files.


*.feature497 LOC (100%) 6 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 11 files match defined criteria (156 LOC, 0.8% vs. main code). All matches are in *.sh files.


*.sh156 LOC (100%) 11 files
Other Code
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]svg".
  • 17 files match defined criteria (5,816 LOC, 31.4% vs. main code):
    • 13 *.json files (5,635 LOC)
    • 4 *.md files (181 LOC)
  • " *.json" is biggest, containing 96.89% of LOC.
  • " *.md" is smallest, containing 3.11% of LOC.


*.json5635 LOC (96%) 13 files
*.md181 LOC (3%) 4 files
Analyzers
Info about analyzers used for source code examinations.

2025-05-13 19:42