apache / skywalking-banyandb
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
proto
mk
tpl
mod
gitattributes
editorconfig
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.

main29635 LOC (60%) 260 files
test13264 LOC (26%) 234 files
generated2607 LOC (5%) 1 file
build and deployment461 LOC (<1%) 13 files
other3263 LOC (6%) 12 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 260 files match defined criteria (29,635 LOC, 100.0% vs. main code):
    • 191 *.go files (23,410 LOC)
    • 27 *.vue files (3,681 LOC)
    • 16 *.proto files (1,383 LOC)
    • 14 *.js files (603 LOC)
    • 3 *.scss files (213 LOC)
    • 2 *.yml files (164 LOC)
    • 2 *.css files (88 LOC)
    • 1 *.toml files (43 LOC)
    • 3 *.yaml files (37 LOC)
    • 1 *.html files (13 LOC)
  • " *.go" is biggest, containing 78.99% of LOC.
  • " *.html" is smallest, containing 0.04% of LOC.


*.go23410 LOC (78%) 191 files
*.vue3681 LOC (12%) 27 files
*.proto1383 LOC (4%) 16 files
*.js603 LOC (2%) 14 files
*.scss213 LOC (<1%) 3 files
*.yml164 LOC (<1%) 2 files
*.css88 LOC (<1%) 2 files
*.toml43 LOC (<1%) 1 file
*.yaml37 LOC (<1%) 3 files
*.html13 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 ".*/[Tt]est/.*".
    • files with paths like ".*_test[.].*".
  • 234 files match defined criteria (13,264 LOC, 44.8% vs. main code):
    • 80 *.go files (8,698 LOC)
    • 99 *.yaml files (3,434 LOC)
    • 49 *.yml files (1,055 LOC)
    • 2 *.xml files (38 LOC)
    • 3 *.sh files (31 LOC)
    • 1 *.js files (8 LOC)
  • " *.go" is biggest, containing 65.58% of LOC.
  • " *.js" is smallest, containing 0.06% of LOC.


*.go8698 LOC (65%) 80 files
*.yaml3434 LOC (25%) 99 files
*.yml1055 LOC (7%) 49 files
*.xml38 LOC (<1%) 2 files
*.sh31 LOC (<1%) 3 files
*.js8 LOC (<1%) 1 file
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[-]lock[.]json".
  • 1 file matches defined criteria (2,607 LOC, 8.8% vs. main code). All matches are in *.json files.


*.json2607 LOC (100%) 1 file
Build and Deployment Code
Source code used to configure or support build and deployment process.
mk
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/package[-]lock[.]json".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*/docker[-]compose[.]yml".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/docker[-]compose[.]yaml".
    • files with paths like ".*[.]mk".
    • files with paths like ".*/[.]gitattributes".
  • 13 files match defined criteria (461 LOC, 1.6% vs. main code):
    • 12 *.mk files (372 LOC)
    • 1 *.sh files (89 LOC)
  • " *.mk" is biggest, containing 80.69% of LOC.
  • " *.sh" is smallest, containing 19.31% of LOC.


*.mk372 LOC (80%) 12 files
*.sh89 LOC (19%) 1 file
Other Code
mod
tpl
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]editorconfig".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[.]dockerignore".
  • 12 files match defined criteria (3,263 LOC, 11.0% vs. main code):
    • 3 *.json files (2,659 LOC)
    • 7 *.md files (438 LOC)
    • 1 *.mod files (153 LOC)
    • 1 *.tpl files (13 LOC)
  • " *.json" is biggest, containing 81.49% of LOC.
  • " *.tpl" is smallest, containing 0.4% of LOC.


*.json2659 LOC (81%) 3 files
*.md438 LOC (13%) 7 files
*.mod153 LOC (4%) 1 file
*.tpl13 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2023-08-11 02:12