opentelemetry-collector icon indicating copy to clipboard operation
opentelemetry-collector copied to clipboard

Documentation improvements - Internal Architecture Doc + Package level comments

Open ankitpatel96 opened this issue 1 year ago • 1 comments

Documentation

Creates an internal architecture file. In it is a diagram of the startup flow of the collector as well as links to key files / packages. I also added package level comments to some key packages.

I wrote some other documentation in https://github.com/open-telemetry/opentelemetry-collector/pull/10029 but split the PRs up.

ankitpatel96 avatar May 01 '24 21:05 ankitpatel96

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.87%. Comparing base (326ef7c) to head (b2f63fe). Report is 79 commits behind head on main.

:exclamation: Current head b2f63fe differs from pull request most recent head e16f0fd

Please upload reports for the commit e16f0fd to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10068      +/-   ##
==========================================
+ Coverage   91.55%   91.87%   +0.31%     
==========================================
  Files         360      356       -4     
  Lines       16693    16865     +172     
==========================================
+ Hits        15284    15495     +211     
+ Misses       1073     1031      -42     
- Partials      336      339       +3     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar May 01 '24 21:05 codecov[bot]

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: ankitpatel96 / name: Ankit Patel (8845ab6f164f9df4cf3291a7f20c798709a8f69d, e392e9dca98a579b3c440e140ff0e041281da583, d0b056b92c7eabeb8f84767e34e802f5749271fd, 4ef04245282442fb722402c824e8100819d7a5c8, c5d84fef1917c13cbcefa44b34baa232441eade6, c6329132b88fa45a0711100320484570b4785484, f98a87a140e0c2e0c7a56968042d64b925631b26, 6e41919799664c1ba119ec047d65d6425f8f077e, 15fd22d58c7c04fbb8c05c37703d55643bc6e0a2, d9f8ba1f311c6a788b1e87010669eeb7a3732e97, 0ccd586e0fa37078fba9929f8c5a966bb8e51470, e16f0fddfb8996b92ca7a63e2b28371384e9d8c2, 0114504d64ed8264bd97a12c90ff65914f3cde2d, 4840b90918b2bb5329d167de0ea0e3e6ac8d4af2)
  • :white_check_mark: login: mx-psi / name: Pablo Baeyens (15fd22d58c7c04fbb8c05c37703d55643bc6e0a2, 6e41919799664c1ba119ec047d65d6425f8f077e, 4840b90918b2bb5329d167de0ea0e3e6ac8d4af2)