Description
Each blockchain platform, including Hyperledger Fabric, provide a way to record information on blockchain in an immutable manner. In the case of Hyperledger Fabric, information is recorded as a `key-value` pair. All previous updates to a `key` are recorded in the ledger, but only the latest value of a `key` can be easily queried using CouchDB; the previous updates are only available in ledger files. This mechanism makes it challenging to perform analysis of updates to a `key`, a necessary requirement for information provenance.
The goal of this project is to
(1) write a Elastic beats module (in Go), that will ship ledger data to Elasticsearch instance
(2) create generic Kibana dashboards that will allow selection of a particular key and visualization updates to it (channel, id, timestamp etc)
Time permitting, the dashboards can be extended to analyze Fabric logs and in-progress transaction data, as well as creating dashboards similar to Hyperledger Explorer.
Of course, a blockchain solution can track information provenance in multiple ways. In one such mechanism, a solution may always write new key-value pairs to blockchain, and maintain the relationship among key-value pairs within the solution (off-chain), instead of blockchain. This project does not concern itself on how a solution manages relationship among key-value pairs.
Additional Information
- You must be a self-starter and have experience writing Go code. Familiarity with ELK stack is also desired.
- You must be able to solve technical problems and come up with creative solutions.
Learning Objectives
- You will become familiar with Hyperledger Fabric, and ledger analysis using Elastic stack. You will learn to generate dummy transactions in Fabric, and analyze the ledger. You will also learn Go.
- The expectation is at least one (remote) meeting once a week, with several meetings to kick-off the project or as needed.
Expected Outcome
A open source implementation, eventually available as Hyperledger Labs, containing:
- Elastic beats plugin for Hyperledger Fabric
- Kibana dashboards
- Dashboards similar to Hyperledger Explorer
- Create a setup for generating various dummy data in various configurations
- One peer / CA / order, single user for initial testing
- A four peers/CA setup with two channels, and two users each associated with two peers. Select (e.g.) 10 keys (through configuration file), to which these users write data, for at least one value per key.
Relation to Hyperledger
- Hyperledger Fabric (ledger analysis)
Education Level
Undergraduate or graduate
Skills
- Elastic beats module
- Familiarity with Go
- Familiarity with using ELK stack and creating Kibana dashboards
Future plans
Create a Hyperledger Lab or incubation project for analyzing ledgers.
Preferred Hours and Length of Internship
Full-time (40 hours a week for 12 weeks during the summer)
Mentor(s) Names and Contact Info
Salman Baset
Rocketchat id: salmanbaset
Project Deliverables
Overall goals of the project:
- write an Elastic beats module (in Go), that will ship ledger data to Elasticsearch instance
- create generic Kibana dashboards that will show both the operational and data aspects of ledger data. Basically, allow selection of a particular key or a channel configuration, and visualize updates to it (channel, id, timestamp etc)
Week 1 |
|
Week 2 |
|
Week 3 |
|
Week 4 |
|
Week 5 |
|
Week 6 |
|
Week 7 |
|
Week 8 |
|
Week 9 |
|
Week 10 |
|
Week 11 |
|
Week 12 |
|
Project Milestones
- Write a Beats agent that sends ledger data to Elasticsearch Balazs Prehoda (1st Quarter)
- Create operational and data dashboards for different Fabric network setups and use-cases Balazs Prehoda (2nd Quarter)
- Evaluate how to read data directly from ledger file, prepare for submission as Hyperledger Lab Balazs Prehoda (3rd Quarter)
- Store and analyze peer/CA logs within Elastic stack, create network setup and dashboards for private data Balazs Prehoda (4th Quarter)