spotify / volcano
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
txt
mod
tpl
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.

main82014 LOC (76%) 271 files
test22957 LOC (21%) 106 files
generated0 LOC (0%) 0 files
build and deployment1418 LOC (1%) 26 files
other1401 LOC (1%) 18 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
tpl
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 271 files match defined criteria (82,014 LOC, 100.0% vs. main code):
    • 75 *.yaml files (62,691 LOC)
    • 194 *.go files (19,301 LOC)
    • 1 *.tpl files (11 LOC)
    • 1 *.py files (11 LOC)
  • " *.yaml" is biggest, containing 76.44% of LOC.
  • " *.py" is smallest, containing 0.01% of LOC.


*.yaml62691 LOC (76%) 75 files
*.go19301 LOC (23%) 194 files
*.tpl11 LOC (<1%) 1 file
*.py11 LOC (<1%) 1 file
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*/e2e/.*".
    • files with paths like ".*/test_.*".
  • 106 files match defined criteria (22,957 LOC, 28.0% vs. main code). All matches are in *.go files.


*.go22957 LOC (100%) 106 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".
  • 26 files match defined criteria (1,418 LOC, 1.7% vs. main code). All matches are in *.sh files.


*.sh1418 LOC (100%) 26 files
Other Code
mod
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*[.]json".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]svg".
    • files with paths like ".*/[.]gitignore".
  • 18 files match defined criteria (1,401 LOC, 1.7% vs. main code):
    • 15 *.md files (1,249 LOC)
    • 1 *.mod files (136 LOC)
    • 2 *.txt files (16 LOC)
  • " *.md" is biggest, containing 89.15% of LOC.
  • " *.txt" is smallest, containing 1.14% of LOC.


*.md1249 LOC (89%) 15 files
*.mod136 LOC (9%) 1 file
*.txt16 LOC (1%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2025-01-17 11:41