Proposal Details
Proposal #275
Proposal title
Proposal: Log Forwarding Integration for the Akash Network
Submit time
Deposit end time
Voting start time
Voting end time
Tally result
Proposal #275 description
Introduction
This proposal represents a strategic pivot in our approach to implementing logging solutions for the Akash Network. Following in-depth discussions with the Akash core team, we have refined our strategy to better align with the network's principles of decentralization and user needs while maintaining simplicity and effectiveness.
Initially, we proposed developing a self-hosted logging infrastructure using Grafana, Prometheus, and Loki. However, discussions with the core team highlighted the following key insights:
- Many users already have established relationships with various logging providers.
- Concerns were raised about overloading provider services for streaming logs.
- Leveraging existing battle-tested solutions provides immediate value.
- Multiple Akash customers prefer SaaS logging solutions like Datadog and Grafana Cloud.
Based on these insights, we revised our approach to focus on integrating robust log forwarding capabilities, allowing users to utilize their preferred logging solutions while maintaining full control over their data and costs.
Problem Statement
The Akash Network console currently lacks a persistent logging system, leading to significant challenges:
- Limited Log Availability: Only live logs are accessible; there is no historical retention, making debugging difficult after a system crash or unexpected behavior.
- Ineffective Debugging: Without log history, identifying the root cause of issues is challenging, especially for complex deployments.
- Community Support Barriers: New users or developers lack the ability to share logs for troubleshooting within the community, complicating the onboarding process.
Proposed Solution
We propose integrating comprehensive log forwarding capabilities into the Akash console to:
- Enable persistent log storage through users' preferred logging solutions.
- Provide a simple, configuration-based setup process.
- Allow users to maintain control over their logging costs and retention policies.
- Leverage existing, battle-tested logging infrastructure.
Implementation Details
Console Integration
Settings Page Enhancement:
- Add a new "Logging Configuration" section to the console settings.
- Allow users to input credentials for supported logging destinations.
- Validate credentials before saving.
- Securely store logging configuration.
SDL Builder Integration:
- Add an "Enable Logging" checkbox in the SDL builder section.
- Automatically inject the logging sidecar configuration into the deployment when enabled.
- Allow users to modify logging parameters through the UI.
Technical Implementation
Logging Sidecar Service:
- Automatically add a logging sidecar container to deployments when logging is enabled.
- Configure the sidecar to collect logs from all containers in the deployment.
- Forward logs to the specified logging destination using stored credentials.
- Implement retry mechanisms and buffering for reliable log delivery.
Supported Logging Destinations (Initial Phase):
- Datadog
- Grafana Cloud
- Elastic Logstash
(Expand support to additional platforms based on user feedback.)
Implementation Timeline (2-3 Months)
Phase 1: Frontend Development
- Design and implement console UI components.
- Add a logging configuration section in the settings page.
- Develop credential management and validation workflows.
- Create a logging toggle and basic configuration options in the SDL builder.
Phase 2: Backend Development
- Design and implement secure credential storage.
- Develop the logging sidecar container configuration.
- Create a system for injecting logging configurations into deployments.
- Implement initial logging destinations.
Phase 3: Testing and Documentation
- Conduct end-to-end testing of logging integration.
- Create user documentation and troubleshooting guides.
- Develop documentation for adding support for additional logging destinations.
Expected Outcomes
This revised logging integration approach will provide:
- Professional-grade logging capabilities through users' preferred solutions.
- Simplified deployment monitoring and troubleshooting.
- Cost-effective solutions leveraging existing infrastructure.
- Improved developer experience and debugging capabilities.
- Enhanced support for production workloads.
This solution aligns with Akash Network's principles of decentralization and user empowerment while providing immediate value to the community.
Budget Estimate
The following budget reflects the comprehensive scope of work required:
Category | Hours | Description |
---|---|---|
Research & MVP Testing | 150 | User needs identification and MVP conceptualization. |
UI/UX Design | 80 | Designing user-friendly configuration flows. |
Frontend Development | 150 | UI components and SDL builder enhancements. |
Base Container Development | 180 | Building a robust logging sidecar container. |
Data-Logging Integration | 120 | Integration with Datadog, Grafana Cloud, and Elastic Logstash. |
Production Testing | 100 | Thorough testing, documentation, and refinements. |
Total Hours: 780
Hourly Rate: $100
Total Budget: $78k
This budget ensures a professional-grade implementation of log forwarding integration, addressing user pain points while aligning with Akash Network's values.
Governance Timeline
- Discussion & Feedback: ongoing
- On-Chain Voting: Targeting Thursday/Friday this week
Link to POC Video: click here Previous Prop & plan (just for record): click here
Thank you for considering this proposal.
For more details, refer to github discussion here: https://github.com/orgs/akash-network/discussions/727
Thank you