Skip to content

Update logger usage #13

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

Open
wants to merge 1 commit into
base: chore/update-store-dir
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions src/api/debug.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Router } from 'express'
import { pino } from '../utils/logger.js'
import { logger } from '../utils/logger.js'
import { getNodesList } from '../utils/utils.js'
import { helia } from '../helia.js'

Expand All @@ -8,26 +8,26 @@ const router = Router()
router.get('/autopeering', async (req, res) => {
try {
const nodes = getNodesList([helia.libp2p.peerId.toString()])
pino.logger.info(`Peering nodes list: ${nodes.map((node) => node.name)}`)
logger.info(`Peering nodes list: ${nodes.map((node) => node.name)}`)

const successPeers: string[] = []

for await (const node of nodes) {
pino.logger.info(`Start peering ${node.name} node (${node.multiAddr})...`)
logger.info(`Start peering ${node.name} node (${node.multiAddr})...`)
try {
await helia.libp2p.dial(node.multiAddr)
pino.logger.info(`Successfully peered with ${node.name}`)
logger.info(`Successfully peered with ${node.name}`)
successPeers.push(node.name)
} catch (err) {
pino.logger.info(`Peering with ${node.name} failed. Error: ${err.message}`)
logger.info(`Peering with ${node.name} failed. Error: ${err.message}`)
}
}

res.send({
peeredSuccessfullyTo: successPeers
})
} catch (err) {
pino.logger.error(err)
logger.error(err)
res.send({
error: err.message
})
Expand Down
18 changes: 9 additions & 9 deletions src/api/file.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { CID } from 'multiformats/cid'
import { multerStorage } from '../multer.js'
import { config } from '../config.js'
import { helia } from '../helia.js'
import { pino } from '../utils/logger.js'
import { logger } from '../utils/logger.js'
import { UnixFsMulterFile } from '../utils/types.js'
import { flatFiles } from '../utils/utils.js'
import { downloadFile, FileNotFoundError, getFileStats } from '../utils/file.js'
Expand All @@ -27,22 +27,22 @@ router.post('/upload', multerStorage.array('files'), async (req, res) => {

try {
const files = flatFiles(req.files as UnixFsMulterFile[])
pino.logger.info(`req.files: : ${JSON.stringify(files.map((item) => item.originalname))}`)
logger.info(`req.files: : ${JSON.stringify(files.map((item) => item.originalname))}`)

const cids: CID[] = []
for (const file of files) {
pino.logger.info(`Adding ${file.originalname} to IPFS`)
logger.info(`Adding ${file.originalname} to IPFS`)

const { cid } = file
pino.logger.info(`Successfully added file ${cid}`)
logger.info(`Successfully added file ${cid}`)
cids.push(cid)

const isPinned = await helia.pins.isPinned(cid)
if (isPinned) {
pino.logger.info(`File already pinned ${cid}`)
logger.info(`File already pinned ${cid}`)
} else {
for await (const pinned of helia.pins.add(cid)) {
pino.logger.info(`Filed pinned: ${pinned}`)
logger.info(`Filed pinned: ${pinned}`)
}
}
}
Expand All @@ -52,7 +52,7 @@ router.post('/upload', multerStorage.array('files'), async (req, res) => {
cids: cids.map((cid) => cid.toString())
})
} catch (err) {
pino.logger.error(err)
logger.error(err)

res.status(400).send({
error: err.message
Expand All @@ -77,7 +77,7 @@ router.get('/:cid', async (req, res) => {
})

stream.on('error', (err) => {
pino.logger.error(err)
logger.error(err)
res.status(408).send({
error: err.message
})
Expand All @@ -90,7 +90,7 @@ router.get('/:cid', async (req, res) => {
error: error.message
})
} else {
pino.logger.error(error)
logger.error(error)
res.status(500).send({
error: error.message
})
Expand Down
12 changes: 6 additions & 6 deletions src/api/helia.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ import { Router } from 'express'
import { Pin } from 'helia'
import { CID } from 'multiformats/cid'
import { helia } from '../helia.js'
import { pino } from '../utils/logger.js'
import { logger } from '../utils/logger.js'

const router = Router()

router.get('/pins', async (req, res) => {
const pins: Pin[] = []

for await (const pin of helia.pins.ls()) {
pino.logger.info('PIN LS', pin)
logger.info('PIN LS', pin)
pins.push(pin)
}

Expand All @@ -24,10 +24,10 @@ router.post('/pin/:cid', async (req, res) => {

try {
for await (const pin of helia.pins.add(cid)) {
pino.logger.info('PINNED', pin)
logger.info('PINNED', pin)
}
} catch (err) {
pino.logger.error(`Error: ${err.message}`)
logger.error(`Error: ${err.message}`)
res.status(500).send({
error: err.message
})
Expand Down Expand Up @@ -57,7 +57,7 @@ router.get('/routing/findProviders/:cid', async (req, res) => {

const providers: string[] = []
for await (const provider of helia.routing.findProviders(cid)) {
pino.logger.info(`Found provider of CID:${cid.toString()}, PeerId:${provider.id.toString()}`)
logger.info(`Found provider of CID:${cid.toString()}, PeerId:${provider.id.toString()}`)
providers.push(provider.id.toString())
}

Expand All @@ -68,7 +68,7 @@ router.get('/routing/findProviders/:cid', async (req, res) => {
res.send({
error: err.message
})
pino.logger.error(err)
logger.error(err)
}
})

Expand Down
16 changes: 8 additions & 8 deletions src/api/libp2p.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { multiaddr, Multiaddr } from '@multiformats/multiaddr'
import { Request, Response, Router } from 'express'
import { PeerIdDto } from '../dto/peer-id.dto.js'
import { helia } from '../helia.js'
import { pino } from '../utils/logger.js'
import { logger } from '../utils/logger.js'

const router = Router()

Expand Down Expand Up @@ -94,7 +94,7 @@ router.get(
multiAddr = multiaddr(req.query.multiAddr || '')
}
} catch (err) {
pino.logger.error('Invalid peer ID:' + err.message)
logger.error('Invalid peer ID:' + err.message)
res.send({
success: false,
error: 'Invalid peer ID'
Expand All @@ -103,9 +103,9 @@ router.get(
}

if (multiAddr) {
pino.logger.info(`Peering by multiAddress: ${multiAddr}`)
logger.info(`Peering by multiAddress: ${multiAddr}`)
} else if (peerId) {
pino.logger.info(`Peering by PeerID: ${peerId}`)
logger.info(`Peering by PeerID: ${peerId}`)
}

try {
Expand All @@ -116,13 +116,13 @@ router.get(
const connection = await helia.libp2p.dial(peer)
res.send({ success: true, connection })
} catch (err) {
pino.logger.warn(`Cannot dial peer: ${err.message}`)
logger.warn(`Cannot dial peer: ${err.message}`)

res.send({
success: false,
error: err.message
})
pino.logger.error(err)
logger.error(err)
}
}
)
Expand All @@ -137,7 +137,7 @@ router.get('/connections', async (req: Request<never, never, never, PeerIdDto>,
connections
})
} catch (err) {
pino.logger.error(err)
logger.error(err)
res.status(400)
res.send({
error: err.message
Expand All @@ -157,7 +157,7 @@ router.get('/peers', (req, res) => {

res.send({ peers })
} catch (err) {
pino.logger.error(err)
logger.error(err)
res.status(400)
res.send({
error: err.message
Expand Down
8 changes: 4 additions & 4 deletions src/disk-usage.cron.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { blockstorePath, datastorePath } from './store.js'
import { dirSize, availableStorageSize } from './utils/utils.js'
import { CronJob } from 'cron'
import { config } from './config.js'
import { pino } from './utils/logger.js'
import { logger } from './utils/logger.js'

const oneMb = 1048576

Expand All @@ -17,13 +17,13 @@ export const diskUsageCron = CronJob.from({
try {
if (!isRunning) {
isRunning = true
pino.logger.info('[Cron] Running "diskUsage" cronjob.')
logger.info('[Cron] Running "diskUsage" cronjob.')
const duration = await scan()
pino.logger.info(`[Cron] "diskUsage" cronjob took ${duration} ms.`)
logger.info(`[Cron] "diskUsage" cronjob took ${duration} ms.`)
isRunning = false
}
} catch (error) {
pino.logger.error(`${error.message}\n${error.stack}`)
logger.error(`${error.message}\n${error.stack}`)
} finally {
isRunning = false
}
Expand Down
16 changes: 8 additions & 8 deletions src/helia.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { identify } from '@libp2p/identify'
import { blockstore, datastore } from './store.js'
import { getAllowNodesMultiaddrs } from './utils/utils.js'
import { config } from './config.js'
import { pino } from './utils/logger.js'
import { logger } from './utils/logger.js'

export const helia = await createHelia({
datastore,
Expand Down Expand Up @@ -37,32 +37,32 @@ export const helia = await createHelia({
})

helia.libp2p.getMultiaddrs().forEach((addr) => {
pino.logger.info(`Listening on ${addr.toString()}`)
logger.info(`Listening on ${addr.toString()}`)
})

helia.libp2p.addEventListener('peer:discovery', (evt) => {
const peer = evt.detail
pino.logger.info(`Discovered peer: ${peer.id}`)
logger.info(`Discovered peer: ${peer.id}`)
})

helia.libp2p.addEventListener('peer:connect', (evt) => {
const peerId = evt.detail
pino.logger.info(`Peer connected: ${peerId}`)
logger.info(`Peer connected: ${peerId}`)
})

helia.libp2p.addEventListener('peer:disconnect', (evt) => {
const peerId = evt.detail
pino.logger.info(`Peer disconnected: ${peerId}`)
logger.info(`Peer disconnected: ${peerId}`)
})

helia.libp2p.addEventListener('start', () => {
pino.logger.info('Libp2p node started')
logger.info('Libp2p node started')
})

helia.libp2p.addEventListener('stop', () => {
pino.logger.info('Libp2p node stopped')
logger.info('Libp2p node stopped')
})

pino.logger.info(`Helia is running! PeerID: ${helia.libp2p.peerId.toString()}`)
logger.info(`Helia is running! PeerID: ${helia.libp2p.peerId.toString()}`)

export const ifs = unixfs(helia)
10 changes: 5 additions & 5 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import express from 'express'
import { Request, Response } from 'express'
import { pino } from './utils/logger.js'
import { httpLogger, logger } from './utils/logger.js'
import { config, CONFIG_FILE_NAME } from './config.js'
import { diskUsageCron } from './disk-usage.cron.js'
import cors from 'cors'
Expand All @@ -10,14 +10,14 @@ import { datastore, blockstore } from './store.js'
await datastore.open()
await blockstore.open()

pino.logger.info(`Using config file: ${CONFIG_FILE_NAME}`)
logger.info(`Using config file: ${CONFIG_FILE_NAME}`)

diskUsageCron.start()

const PORT = config.serverPort
const app = express()

app.use(pino)
app.use(httpLogger)

app.use(
cors({
Expand All @@ -38,10 +38,10 @@ app.use('/api/libp2p', routers.libp2p)
app.use('/api/debug', routers.debug)

app.use((err: Error, req: Request, res: Response) => {
pino.logger.error(`${err.message}\n${err.stack}`)
logger.error(`${err.message}\n${err.stack}`)
res.status(500).send({ error: 'Internal Server Error. See logs.' })
})

app.listen(PORT, () => {
pino.logger.info(`Server is running on http://localhost:${PORT}`)
logger.info(`Server is running on http://localhost:${PORT}`)
})
3 changes: 2 additions & 1 deletion src/utils/file.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { Readable } from 'node:stream'
import { clearTimeout } from 'node:timers'
import { config } from '../config.js'
import { ifs } from '../helia.js'
import { logger } from './logger.js'

/**
* Return file statistics by CID.
Expand All @@ -19,7 +20,7 @@ export async function getFileStats(cid: CID) {
const stats = await ifs.stat(cid, { signal: abortController.signal })
return stats
} catch (err) {
console.log(err)
logger.error(err)
clearTimeout(timeout)

throw new FileNotFoundError('Cannot find requested CID. Request timed out.')
Expand Down
19 changes: 17 additions & 2 deletions src/utils/logger.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
import { pinoHttp } from 'pino-http'
import { pino } from 'pino'
import { config } from '../config.js'
import { pinoHttp } from 'pino-http'

export const logger = pino({
// export const pino = pinoHttp({
level: config.logLevel || 'info',
// useLevel: 'debug',
transport: {
target: 'pino-pretty',
options: {
colorize: true,
translateTime: 'dd.mm.yy HH:MM:ss Z',
ignore: 'pid,hostname'
}
}
})

export const pino = pinoHttp({
export const httpLogger = pinoHttp({
level: config.logLevel || 'info',
useLevel: 'debug',
transport: {
Expand Down
4 changes: 2 additions & 2 deletions src/utils/unixfs-multer.storage.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { StorageEngine } from 'multer'
import * as e from 'express'
import { UnixFS } from '@helia/unixfs'
import { pino } from './logger.js'
import { logger } from './logger.js'
import { UnixFsMulterFile } from './types.js'

export interface UnixfsStorageOptions {
Expand Down Expand Up @@ -33,7 +33,7 @@ export class UnixfsMulterStorage implements StorageEngine {
file: Express.Multer.File,
callback: (error: Error | null) => void
): void {
pino.logger.info(`Need remove file ${file.originalname}`)
logger.info(`Need remove file ${file.originalname}`)
callback(null)
}
}
Loading