Skip to content
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

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

rootfs
Copy link
Contributor

@rootfs rootfs commented Oct 24, 2024

The diagram preview can be found here

@rootfs rootfs requested review from sthaha and vimalk78 October 24, 2024 17:54
Copy link
Contributor

github-actions bot commented Oct 24, 2024

🤖 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:

  • Updated architecture diagram in README.md
  • Added new elements, including eBPF program, process/container/VM info, hardware power readings, ML features, and idle/dynamic energy attribution
  • Improved diagram readability and understanding of the project's architecture

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.

@vimalk78
Copy link
Collaborator

@rootfs please update the diagram preview

@vimalk78
Copy link
Collaborator

vimalk78 commented Oct 28, 2024

preview

image

README.md Outdated
Comment on lines 37 to 44
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
Copy link
Collaborator

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
Comment on lines 53 to 57
subgraph KL[Kernel Level]
direction TB
TP[Kernel Tracepoint]:::kernel --> EBPF[Kepler eBPF Program]:::kernel
EBPF --> |Performance Counter Stats|OM[Output Map]:::kernel
end
Copy link
Collaborator

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?

@rootfs
Copy link
Contributor Author

rootfs commented Nov 14, 2024

@vimalk78
Copy link
Collaborator

/lgtm merging

@vimalk78 vimalk78 merged commit 45fbcbc into sustainable-computing-io:main Nov 15, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants