Skip to content

Commit

Permalink
tweaks to architecture doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ankitpatel96 committed May 20, 2024
1 parent 6e41919 commit 4ef0424
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions docs/internal-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This document describes the Collector internal architecture and startup flow. It can be helpful if you are starting to contribute to the Collector codebase.

For the end-user focused architecture document, please see the [opentelemetry.io's Architecture documentation](https://opentelemetry.io/docs/collector/architecture/)
For the end-user focused architecture document, please see the [opentelemetry.io's Architecture documentation](https://opentelemetry.io/docs/collector/architecture/). While it is end user focused - its still a good place to start if you're trying to learn about the Collector codebase.

### Startup Diagram
```mermaid
Expand Down Expand Up @@ -36,7 +36,7 @@ flowchart TD
Topological sort the graph, and create each component in reverse order`")
L --> M(Receiver Factory) & N(Processor Factory) & O(Exporter Factory) & P(Connector Factory)
```
### Important Files
### Where to start to read the code
Here is a brief list of useful and/or important files and interfaces that you may find valuable to glance through.
Most of these have package-level documentation and function/struct-level comments that help explain the Collector!

Expand All @@ -50,6 +50,3 @@ Implementations of new components use this `NewFactory` function in their implem
the Collector. For example, the Collector uses this interface to give receivers a handle to a `nextConsumer` -
representing where the receiver can send data to that it has received.
An example of this is in [exporter.go](../exporter/exporter.go).

### [Architecture Docs](https://opentelemetry.io/docs/collector/architecture/)
OpenTelemetry's Collector architecture is a great resource to understand the Collector!

0 comments on commit 4ef0424

Please sign in to comment.