-
Notifications
You must be signed in to change notification settings - Fork 192
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(readme): update architecture diagram #1827
Conversation
🤖 SeineSailor Here is a concise summary of the pull request changes: Summary: The pull request updates the architecture diagram in README.md, providing a clearer and more detailed view of the Kepler Exporter project's components. The new Mermaid diagram includes additional elements, such as eBPF program and ML features, and highlights subsystems with distinct colors and class definitions, enhancing readability and understanding of the project's architecture. Key Modifications:
Impact: This change enhances the project's documentation without introducing functional changes, making it easier for developers to understand the system's components and their interactions. Observations/Suggestions: The deduplication of changesets is appreciated, as it reduces redundancy and makes the review process more efficient. The updated diagram is a valuable addition to the project's documentation, and it would be beneficial to consider adding a brief description or legend to explain the colors and class definitions used in the diagram. |
@rootfs please update the diagram preview |
README.md
Outdated
classDef kernel fill:#e6f3ff,stroke:#4a90e2 | ||
classDef collector fill:#f0fff0,stroke:#2ecc71 | ||
classDef hardware fill:#fff0f5,stroke:#e74c3c | ||
classDef estimator fill:#fff5e6,stroke:#f39c12 | ||
classDef mapping fill:#f5f0ff,stroke:#9b59b6 | ||
classDef calculator fill:#f0f5ff,stroke:#3498db | ||
classDef attribution fill:#fff0f0,stroke:#e74c3c | ||
classDef export fill:#f5fff0,stroke:#27ae60 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the fill colors make the box heading close to invisible
README.md
Outdated
subgraph KL[Kernel Level] | ||
direction TB | ||
TP[Kernel Tracepoint]:::kernel --> EBPF[Kepler eBPF Program]:::kernel | ||
EBPF --> |Performance Counter Stats|OM[Output Map]:::kernel | ||
end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it possible to have "kernel level" at the bottom, and the go up?
Signed-off-by: Huamin Chen <[email protected]>
@vimalk78 updated, can you check again? thanks |
/lgtm merging |
The diagram preview can be found here