Skip to content

Logger cleanup #87

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.

Sign up for GitHub

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

Merged
mateeullahmalik merged 5 commits into from
Jun 19, 2025
Merged

Logger cleanup #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8c49a14
Delete old logger
mateeullahmalik Jun 18, 2025
e500f41
feat: implement logtrace for gRPC logging
mateeullahmalik Jun 18, 2025
8017ae4
supernode cleanup
mateeullahmalik Jun 18, 2025
b61e4d9
Refactor logging to use logtrace package across multiple modules
mateeullahmalik Jun 18, 2025
7094075
Fix incorrect paths
mateeullahmalik Jun 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,9 @@ source ~/.bashrc

Download the latest release from GitHub:


### 2. Create Configuration File

Create a `config.yml` file in the same directory as your binary
Create a `config.yml` file in your base directory (default: `~/.supernode/config.yml`):

```yaml
# Supernode Configuration
Expand Down Expand Up @@ -156,13 +155,13 @@ The supernode binary supports the following command-line flags:

| Flag | Short | Description | Value Type | Example | Default |
|------|-------|-------------|------------|---------|---------|
| `--config` | `-c` | Path to configuration file | String | `-c /path/to/config.yml` | `config.yml` in current directory |
| `--config` | `-c` | Path to configuration file | String | `-c /path/to/config.yml` | `config.yml` in basedir (`~/.supernode/config.yml`) |
| `--basedir` | `-d` | Base directory for data storage | String | `-d /custom/path` | `~/.supernode` |

### Usage Examples

```bash
# Use default config.yml in current directory, with ~/.supernode as basedir
# Use default config.yml in basedir (~/.supernode/config.yml), with ~/.supernode as basedir
supernode start

# Use custom config file
Expand All @@ -181,11 +180,10 @@ supernode start -c /etc/supernode/config.yml -d /opt/supernode

If you use custom flags (`--config` or `--basedir`) for key management operations, you **MUST** use the same flags for ALL subsequent commands, including the `start` command. Otherwise, your configuration will break and keys will not be found.


### Additional Important Notes:

- Make sure you have sufficient balance in your Lumera account to broadcast transactions
- The P2P port (4445) should not be changed from the default
- Your `key_name` in the config must match the name you used when creating the key
- Your `identity` in the config must match the address generated for your key
- Ensure your Lumera validator node is running and accessible at the configured gRPC address
- Ensure your Lumera validator node is running and accessible at the configured gRPC address
86 changes: 64 additions & 22 deletions p2p/kademlia/bootstrap.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
"github.com/LumeraProtocol/supernode/pkg/errors"
"github.com/LumeraProtocol/supernode/pkg/utils"

"github.com/LumeraProtocol/supernode/pkg/log"
"github.com/LumeraProtocol/supernode/pkg/logtrace"
ltc "github.com/LumeraProtocol/supernode/pkg/net/credentials"
)

Expand Down Expand Up @@ -65,9 +65,11 @@ func (s *DHT) parseNode(extP2P string, selfAddr string) (*Node, error) {
// For system testing, use port+1 if SYSTEM_TEST=true
if os.Getenv("SYSTEM_TEST") == "true" {
port = uint16(portNum) + 1
log.P2P().WithField("original_port", portNum).
WithField("adjusted_port", port).
Info("Using port+1 for system testing")
logtrace.Info(context.Background(), "Using port+1 for system testing", logtrace.Fields{
logtrace.FieldModule: "p2p",
"original_port": portNum,
"adjusted_port": port,
})
} else {
// For normal P2P operation, always use the default port
port = defaultNetworkPort
Expand Down Expand Up @@ -108,7 +110,10 @@ func (s *DHT) setBootstrapNodesFromConfigVar(ctx context.Context, bootstrapNodes
})
}
s.options.BootstrapNodes = nodes
log.P2P().WithContext(ctx).WithField("bootstrap_nodes", nodes).Info("Bootstrap nodes set from config var")
logtrace.Info(ctx, "Bootstrap nodes set from config var", logtrace.Fields{
logtrace.FieldModule: "p2p",
"bootstrap_nodes": nodes,
})

return nil
}
Expand Down Expand Up @@ -158,15 +163,22 @@ func (s *DHT) ConfigureBootstrapNodes(ctx context.Context, bootstrapNodes string
}

if latestIP == "" {
log.P2P().WithContext(ctx).WithField("supernode", supernode.SupernodeAccount).Warn("No valid IP address found for supernode")
logtrace.Warn(ctx, "No valid IP address found for supernode", logtrace.Fields{
logtrace.FieldModule: "p2p",
"supernode": supernode.SupernodeAccount,
})
continue
}

// Parse the node from the IP address
node, err := s.parseNode(latestIP, selfAddress)
if err != nil {
log.P2P().WithContext(ctx).WithError(err).WithField("address", latestIP).WithField("supernode", supernode.SupernodeAccount).
Warn("Skip Bad Bootstrap Address")
logtrace.Warn(ctx, "Skip Bad Bootstrap Address", logtrace.Fields{
logtrace.FieldModule: "p2p",
logtrace.FieldError: err.Error(),
"address": latestIP,
"supernode": supernode.SupernodeAccount,
})
continue
}

Expand All @@ -185,13 +197,19 @@ func (s *DHT) ConfigureBootstrapNodes(ctx context.Context, bootstrapNodes string
}

if len(boostrapNodes) == 0 {
log.WithContext(ctx).Error("unable to fetch bootstrap IP addresses. No valid supernodes found.")
logtrace.Error(ctx, "unable to fetch bootstrap IP addresses. No valid supernodes found.", logtrace.Fields{
logtrace.FieldModule: "p2p",
})
return nil
}

for _, node := range boostrapNodes {
log.WithContext(ctx).WithFields(log.Fields{"bootstap_ip": node.IP, "bootstrap_port": node.Port, "node_id": string(node.ID)}).
Info("adding p2p bootstrap node")
logtrace.Info(ctx, "adding p2p bootstrap node", logtrace.Fields{
logtrace.FieldModule: "p2p",
"bootstap_ip": node.IP,
"bootstrap_port": node.Port,
"node_id": string(node.ID),
})
}

s.options.BootstrapNodes = append(s.options.BootstrapNodes, boostrapNodes...)
Expand Down Expand Up @@ -221,7 +239,10 @@ func (s *DHT) Bootstrap(ctx context.Context, bootstrapNodes string) error {

addr := fmt.Sprintf("%s:%v", node.IP, node.Port)
if _, err := s.cache.Get(addr); err == nil {
log.P2P().WithContext(ctx).WithField("addr", addr).Info("skip bad p2p boostrap addr")
logtrace.Info(ctx, "skip bad p2p boostrap addr", logtrace.Fields{
logtrace.FieldModule: "p2p",
"addr": addr,
})
continue
}

Expand All @@ -245,20 +266,32 @@ func (s *DHT) Bootstrap(ctx context.Context, bootstrapNodes string) error {
// So if bootstrap failed, should try to connect to node again for next bootstrap retry
// s.cache.SetWithExpiry(addr, []byte("true"), badAddrExpiryHours*time.Hour)

log.P2P().WithContext(ctx).WithError(err).Error("network call failed, sleeping 3 seconds")
logtrace.Error(ctx, "network call failed, sleeping 3 seconds", logtrace.Fields{
logtrace.FieldModule: "p2p",
logtrace.FieldError: err.Error(),
})
time.Sleep(5 * time.Second)
continue
}
log.P2P().WithContext(ctx).Debugf("ping response: %v", response.String())
logtrace.Debug(ctx, "ping response", logtrace.Fields{
logtrace.FieldModule: "p2p",
"response": response.String(),
})

// add the node to the route table
log.P2P().WithContext(ctx).WithField("sender-id", string(response.Sender.ID)).
WithField("sender-ip", string(response.Sender.IP)).
WithField("sender-port", response.Sender.Port).Debug("add-node params")
logtrace.Debug(ctx, "add-node params", logtrace.Fields{
logtrace.FieldModule: "p2p",
"sender-id": string(response.Sender.ID),
"sender-ip": string(response.Sender.IP),
"sender-port": response.Sender.Port,
})

if len(response.Sender.ID) != len(s.ht.self.ID) {
log.P2P().WithContext(ctx).WithField("sender-id", string(response.Sender.ID)).
WithField("self-id", string(s.ht.self.ID)).Error("self ID && sender ID len don't match")
logtrace.Error(ctx, "self ID && sender ID len don't match", logtrace.Fields{
logtrace.FieldModule: "p2p",
"sender-id": string(response.Sender.ID),
"self-id": string(s.ht.self.ID),
})

continue
}
Expand All @@ -277,7 +310,10 @@ func (s *DHT) Bootstrap(ctx context.Context, bootstrapNodes string) error {
if s.ht.totalCount() > 0 {
// iterative find node from the nodes
if _, err := s.iterate(ctx, IterateFindNode, s.ht.self.ID, nil, 0); err != nil {
log.P2P().WithContext(ctx).WithError(err).Error("iterative find node failed")
logtrace.Error(ctx, "iterative find node failed", logtrace.Fields{
logtrace.FieldModule: "p2p",
logtrace.FieldError: err.Error(),
})
return err
}
} else {
Expand All @@ -291,12 +327,18 @@ func (s *DHT) Bootstrap(ctx context.Context, bootstrapNodes string) error {

func (s *DHT) retryBootstrap(ctx context.Context, bootstrapNodes string) {
if err := s.ConfigureBootstrapNodes(ctx, bootstrapNodes); err != nil {
log.P2P().WithContext(ctx).WithError(err).Error("retry failed to get bootstap ip")
logtrace.Error(ctx, "retry failed to get bootstap ip", logtrace.Fields{
logtrace.FieldModule: "p2p",
logtrace.FieldError: err.Error(),
})
return
}

// join the kademlia network if bootstrap nodes is set
if err := s.Bootstrap(ctx, bootstrapNodes); err != nil {
log.P2P().WithContext(ctx).WithError(err).Error("retry failed - bootstrap the node.")
logtrace.Error(ctx, "retry failed - bootstrap the node.", logtrace.Fields{
logtrace.FieldModule: "p2p",
logtrace.FieldError: err.Error(),
})
}
}
Loading