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.

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

feature/add_logging_mechanism -> release/v0.4.50 #241

Open
wants to merge 9 commits into
base: release/v0.4.50
Choose a base branch
from
Open

feature/add_logging_mechanism -> release/v0.4.50 #241

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
27794c6
Test commit with GPG signing
golnar-boosty Nov 19, 2024
782a358
feat(logs): add log generation functionality in the log folder
golnar-boosty Nov 19, 2024
9d92aff
docs(config): fixed markdown errors and add detailed configuration op…
golnar-boosty Nov 19, 2024
00b26a2
feat(logging): integrate log creation functionalities into main.go an…
golnar-boosty Nov 19, 2024
6e624ad
chore(deps): update go.mod and go.sum for dependency changes
golnar-boosty Nov 19, 2024
7f952d5
feat(logging): integrate log creation functionalities
golnar-boosty Nov 19, 2024
49f0786
git commit -S -m"refactor(logs): update logging mechanism to prevent …
golnar-boosty Nov 20, 2024
dd49b97
refactor(logs): enhance event logging structure for better readabilit…
golnar-boosty Nov 22, 2024
853d285
feat(logs): bump interx version
MrLutik Nov 29, 2024
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
171 changes: 159 additions & 12 deletions gateway/interx/block.go
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (

"github.com/KiraCore/interx/common"
"github.com/KiraCore/interx/config"
"github.com/KiraCore/interx/log"
"github.com/KiraCore/interx/types"
kiratypes "github.com/KiraCore/sekai/types"
multistaking "github.com/KiraCore/sekai/x/multistaking/types"
Expand Down Expand Up @@ -61,12 +62,19 @@ func queryBlocksHandle(rpcAddr string, r *http.Request) (interface{}, interface{
func QueryBlocksRequest(gwCosmosmux *runtime.ServeMux, rpcAddr string) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
var statusCode int

log.CustomLogger().Info("Starting 'QueryBlocksRequest' request...")

request := common.GetInterxRequest(r)
response := common.GetResponseFormat(request, rpcAddr)

common.GetLogger().Info("[query-blocks] Entering Blocks query")

if !common.RPCMethods["GET"][config.QueryBlocks].Enabled {

log.CustomLogger().Error(" `QueryBlocksRequest` is disabled.",
"method", request.Method,
"endpoint", request.Endpoint,
)

response.Response, response.Error, statusCode = common.ServeError(0, "", "API disabled", http.StatusForbidden)
} else {
if common.RPCMethods["GET"][config.QueryBlocks].CachingEnabled {
Expand All @@ -75,22 +83,42 @@ func QueryBlocksRequest(gwCosmosmux *runtime.ServeMux, rpcAddr string) http.Hand
response.Response, response.Error, statusCode = cacheResponse, cacheError, cacheStatus
common.WrapResponse(w, request, *response, statusCode, false)

common.GetLogger().Info("[query-blocks] Returning from the cache")
log.CustomLogger().Info("Cache hit for 'QueryBlocksRequest' request.",
"method", request.Method,
"endpoint", request.Endpoint,
"params", request.Params,
"error", response.Error,
)

return
}
}

response.Response, response.Error, statusCode = queryBlocksHandle(rpcAddr, r)
}

log.CustomLogger().Info("Processed 'QueryBlocksRequest' request.",
"method", request.Method,
"endpoint", request.Endpoint,
"params", request.Params,
"error", response.Error,
)

common.WrapResponse(w, request, *response, statusCode, common.RPCMethods["GET"][config.QueryBlocks].CachingEnabled)

log.CustomLogger().Info("Finished 'QueryBlocksRequest' request.")
}
}

func queryBlockByHeightOrHashHandle(rpcAddr string, height string) (interface{}, interface{}, int) {
success, err, statusCode := common.MakeTendermintRPCRequest(rpcAddr, "/block", fmt.Sprintf("height=%s", height))

if err != nil {
log.CustomLogger().Error(" `queryBlockByHeightOrHashHandle` failed to execute.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On each call you initialize the new logger. Wouldn't it better to init the logger once and share it between packages?

"height", height,
"method", "/block",
"err", err,
)
success, err, statusCode = common.MakeTendermintRPCRequest(rpcAddr, "/block_by_hash", fmt.Sprintf("hash=%s", height))
}

Expand All @@ -106,9 +134,17 @@ func QueryBlockByHeightOrHashRequest(gwCosmosmux *runtime.ServeMux, rpcAddr stri
request := common.GetInterxRequest(r)
response := common.GetResponseFormat(request, rpcAddr)

common.GetLogger().Info("[query-blocks-by-height] Entering Block query by height: ", height)
log.CustomLogger().Info("Starting `QueryBlockByHeightOrHashRequest` request...")

if !common.RPCMethods["GET"][config.QueryBlockByHeightOrHash].Enabled {

log.CustomLogger().Error("Query `QueryBlockByHeightOrHashRequest` is disabled.",
"method", request.Method,
"endpoint", request.Endpoint,
"params", request.Params,
"error", response.Error,
)

response.Response, response.Error, statusCode = common.ServeError(0, "", "API disabled", http.StatusForbidden)
} else {
if common.RPCMethods["GET"][config.QueryBlockByHeightOrHash].CachingEnabled {
Expand All @@ -117,21 +153,39 @@ func QueryBlockByHeightOrHashRequest(gwCosmosmux *runtime.ServeMux, rpcAddr stri
response.Response, response.Error, statusCode = cacheResponse, cacheError, cacheStatus
common.WrapResponse(w, request, *response, statusCode, false)

common.GetLogger().Info("[query-blocks-by-height] Returning from the cache: ", height)
log.CustomLogger().Info("Cache hit for `QueryBlockByHeightOrHashRequest` request.",
"method", request.Method,
"endpoint", request.Endpoint,
"params", request.Params,
"error", response.Error,
)

return
}
}

response.Response, response.Error, statusCode = queryBlockByHeightOrHashHandle(rpcAddr, height)
}

log.CustomLogger().Info("Processed `QueryBlockByHeightOrHashRequest` request.",
"method", request.Method,
"endpoint", request.Endpoint,
"params", request.Params,
"error", response.Error,
)

common.WrapResponse(w, request, *response, statusCode, common.RPCMethods["GET"][config.QueryBlockByHeightOrHash].CachingEnabled)

log.CustomLogger().Info("Finished `QueryBlockByHeightOrHashRequest` request.")

}
}

func getTransactionsFromLog(attributes []abciTypes.EventAttribute) []sdk.Coin {
feeTxs := []sdk.Coin{}

log.CustomLogger().Info("Starting `getTransactionsFromLog` request...")

var evMap = make(map[string]string)
for _, attribute := range attributes {
key := string(attribute.GetKey())
Expand Down Expand Up @@ -164,15 +218,26 @@ func getTransactionsFromLog(attributes []abciTypes.EventAttribute) []sdk.Coin {
}
}

log.CustomLogger().Info("Finished `getTransactionsFromLog` request.")

return feeTxs
}

func parseTransaction(rpcAddr string, transaction tmTypes.ResultTx) (types.TransactionResult, error) {
txResult := types.TransactionResult{}

log.CustomLogger().Info("Starting `parseTransaction` request...")

tx, err := config.EncodingCg.TxConfig.TxDecoder()(transaction.Tx)
if err != nil {
common.GetLogger().Error("[query-transactions] Failed to decode transaction: ", err)

log.CustomLogger().Error("Failed to decode transaction.",
"method", "TxDecoder",
"transaction", tx,
"error", err,
"result", txResult,
)

return txResult, err
}

Expand All @@ -185,8 +250,14 @@ func parseTransaction(rpcAddr string, transaction tmTypes.ResultTx) (types.Trans
txResult.BlockHeight = transaction.Height
txResult.BlockTimestamp, err = common.GetBlockTime(rpcAddr, transaction.Height)
if err != nil {
common.GetLogger().Error("[query-transactions] Block not found: ", transaction.Height)
return txResult, fmt.Errorf("block not found: %d", transaction.Height)

log.CustomLogger().Error("Failed to find block.",
"method", "GetBlockTime",
"RPC", rpcAddr,
"height", transaction.Height,
"error", err,
)

}
txResult.Confirmation = common.NodeStatus.Block - transaction.Height + 1
txResult.GasWanted = transaction.TxResult.GetGasWanted()
Expand All @@ -205,6 +276,11 @@ func parseTransaction(rpcAddr string, transaction tmTypes.ResultTx) (types.Trans
})
}

log.CustomLogger().Info("Signing tx successfully done.",
"method", "signing.Tx",
"signed tx", txSigning,
)

txResult.Transactions = []types.Transaction{}
txResult.Fees = []sdk.Coin{}

Expand Down Expand Up @@ -413,16 +489,25 @@ func parseTransaction(rpcAddr string, transaction tmTypes.ResultTx) (types.Trans
}

txResult.Transactions = append(txResult.Transactions, transfers...)

}

log.CustomLogger().Info("Finished `parseTransaction` request.")

return txResult, nil
}

// QueryBlockTransactionsHandle is a function to query transactions of a block.
func QueryBlockTransactionsHandle(rpcAddr string, height string) (interface{}, interface{}, int) {
blockHeight, _ := strconv.Atoi(height)
response, err := SearchTxHashHandle(rpcAddr, "", "", "", 0, 0, int64(blockHeight), int64(blockHeight), "")

if err != nil {
log.CustomLogger().Error("`QueryBlockTransactionsHandle` failed to execute.",
"block_height", height,
"error", err,
"response_data", response,
)
return common.ServeError(0, "transaction query failed", "", http.StatusBadRequest)
}

Expand All @@ -449,12 +534,27 @@ func QueryBlockTransactionsRequest(gwCosmosmux *runtime.ServeMux, rpcAddr string
var statusCode int
queries := mux.Vars(r)
height := queries["height"]

log.CustomLogger().Info("Starting `QueryBlockTransactionsRequest`.",
"block_height", height,
)

request := common.GetInterxRequest(r)
response := common.GetResponseFormat(request, rpcAddr)

common.GetLogger().Info("[query-block-transactions-by-height] Entering Block query by height: ", height)
log.CustomLogger().Info("Attempting to fetch transactions from block.",
"block_height", height,
"method", request.Method,
"endpoint", request.Endpoint,
"params", request.Params,
)

if !common.RPCMethods["GET"][config.QueryBlockTransactions].Enabled {

log.CustomLogger().Error("`QueryBlockTransactionsRequest` is disabled.",
"block_height", height,
)

response.Response, response.Error, statusCode = common.ServeError(0, "", "API disabled", http.StatusForbidden)
} else {
if common.RPCMethods["GET"][config.QueryBlockTransactions].CachingEnabled {
Expand All @@ -463,15 +563,28 @@ func QueryBlockTransactionsRequest(gwCosmosmux *runtime.ServeMux, rpcAddr string
response.Response, response.Error, statusCode = cacheResponse, cacheError, cacheStatus
common.WrapResponse(w, request, *response, statusCode, false)

common.GetLogger().Info("[query-block-transactions-by-height] Returning from the cache: %s", height)
log.CustomLogger().Info("Cache hit for `QueryBlockTransactionsRequest`.",
"block_height", height,
)

return
}
}

response.Response, response.Error, statusCode = QueryBlockTransactionsHandle(rpcAddr, height)
}

log.CustomLogger().Info("Fetched transaction from block (no cache used).",
"block_height", height,
"transaction_response", response.Response,
"error_details", response.Error,
)
common.WrapResponse(w, request, *response, statusCode, common.RPCMethods["GET"][config.QueryBlockTransactions].CachingEnabled)

log.CustomLogger().Info("Completed `QueryBlockTransactionsRequest`.",
"block_height", height,
"status_code", statusCode,
)
}
}

Expand All @@ -481,6 +594,11 @@ func QueryTransactionResultHandle(rpcAddr string, txHash string) (interface{}, i

response, err := SearchTxHashHandle(rpcAddr, "", "", "", 0, 0, 0, 0, txHash)
if err != nil {
log.CustomLogger().Error("`QueryTransactionResultHandle` failed to execute.",
"tx_Hash", txHash,
"error", err,
"response_data", response,
)
return common.ServeError(0, "transaction query failed", "", http.StatusBadRequest)
}

Expand All @@ -489,6 +607,11 @@ func QueryTransactionResultHandle(rpcAddr string, txHash string) (interface{}, i
for _, transaction := range response.Txs {
txResult, err = parseTransaction(rpcAddr, *transaction)
if err != nil {
log.CustomLogger().Error("`parseTransaction` failed to execute.",
"tx_Result", txResult,
"error", err,
"response_data", response.Txs,
)
return common.ServeError(0, "", err.Error(), http.StatusBadRequest)
}
}
Expand All @@ -502,12 +625,24 @@ func QueryTransactionResultRequest(gwCosmosmux *runtime.ServeMux, rpcAddr string
var statusCode int
queries := mux.Vars(r)
txHash := queries["txHash"]

log.CustomLogger().Info("Starting `QueryTransactionResultRequest` request...")

request := common.GetInterxRequest(r)
response := common.GetResponseFormat(request, rpcAddr)

common.GetLogger().Info("[query-transaction-by-hash] Entering transaction query by hash: %s", txHash)
log.CustomLogger().Info("Attempting to fetch transactions by hash.",
"tx_Hash", txHash,
"method", request.Method,
"endpoint", request.Endpoint,
"params", request.Params,
)

if !common.RPCMethods["GET"][config.QueryTransactionResult].Enabled {

log.CustomLogger().Error("`QueryTransactionResultRequest` is disabled.",
"tx_Hash", txHash,
)
response.Response, response.Error, statusCode = common.ServeError(0, "", "API disabled", http.StatusForbidden)
} else {
if common.RPCMethods["GET"][config.QueryTransactionResult].CachingEnabled {
Expand All @@ -516,14 +651,26 @@ func QueryTransactionResultRequest(gwCosmosmux *runtime.ServeMux, rpcAddr string
response.Response, response.Error, statusCode = cacheResponse, cacheError, cacheStatus
common.WrapResponse(w, request, *response, statusCode, false)

common.GetLogger().Info("[query-transaction-by-hash] Returning from the cache: %s", txHash)
log.CustomLogger().Info("Cache hit for `QueryTransactionResultRequest`.",
"tx_Hash", txHash,
)
return
}
}

response.Response, response.Error, statusCode = QueryTransactionResultHandle(rpcAddr, txHash)
log.CustomLogger().Info("Fetched transaction by hash (no cache used).",
"tx_Hash", txHash,
"transaction_response", response.Response,
"error_details", response.Error,
)
}

common.WrapResponse(w, request, *response, statusCode, common.RPCMethods["GET"][config.QueryTransactionResult].CachingEnabled)

log.CustomLogger().Info("Completed `QueryBlockTransactionsRequest`.",
"tx_Hash", txHash,
"status_code", statusCode,
)
}
}
31 changes: 31 additions & 0 deletions log/logger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package log

import (
"fmt"
"os"
"strconv"
"time"

cosmosLog "cosmossdk.io/log"
)

func CustomLogger() cosmosLog.Logger {

printLogs, err := strconv.ParseBool(os.Getenv("PrintLogs"))
if err != nil {
fmt.Println("[CustomLogger] Error parsing PrintLogs environment variable:", err)
}

if !printLogs {
return cosmosLog.NewNopLogger()
}

// Initialize a new `cosmosLog` logger instance
logger := cosmosLog.NewLogger(os.Stderr)

logger = logger.With(
"timestamp", time.Now().UTC().Format(time.RFC3339),
)

return logger
}
Loading
Loading