IPFS Logging configuration

dmellos · January 7, 2021, 7:04pm

Hi,

I am trying to find the ipfs logs for content upload, download and the logs when an ipfs node in a cluster replicates the data to all other nodes.
I know we can check ipfs logs using ipfs log tail, but I can’t see logs having info for the operations I am looking for?

Also, can we configure all the logs to be written to a file just like ipfs cluster rest api.

twdragon · January 8, 2021, 9:25am

Just use IPFS_LOGGING environment variable to set the level. The level set is standard: debug, info, warn, error, dpanic, panic, fatal. After setting of this variable, the daemon will throw the log messages of the selected level to stderr

twdragon · January 8, 2021, 9:31am

If you are using systemd service unit, there is the way to configure output for the logs inside .service file:

# It is possible also to set the output as a filestore: 'file:/var/log/<ipfs-log-file>' in systemd 2.36 or newer
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=ipfs

dmellos · January 11, 2021, 8:09pm

Thanks @twdragon

dmellos · January 14, 2021, 9:47pm

@twdragon , Thanks again.

I tried and was able to see the logs when I call the cluster API for adding content
http:// ipfs-node:9094/add

But for some reason, the logs are not generated when I try to get the data from gateway URL
http:// ipfs-node:8080/ipfs/filehash

any thoughts?

twdragon · January 15, 2021, 9:46am

Did you try to turn logging to debug?

dmellos · January 15, 2021, 6:23pm

Yes, tried debug too.

I did set the env variable using export IPFS_LOGGING=debug but no logs were getting generated, so I tried ipfs log level all debug and I saw many logs populating.

Yet, logs for gateway api while fetching the data are still not generating.

twdragon · January 19, 2021, 10:15am

Well, this is the mess. I can suggest you now only to examine the code which serves TCP in IPFS…

hector · January 19, 2021, 2:36pm

I had a quick look, and it may be that the gateway handlers are not logging much at all. I see no calls to around here log.Info/Debug(...)

github.com

ipfs/go-ipfs/blob/2ed9254426e900cf00a9b35304dc5b5de8173208/core/corehttp/gateway_handler.go#L154


func (i *gatewayHandler) optionsHandler(w http.ResponseWriter, r *http.Request) {
	/*
		OPTIONS is a noop request that is used by the browsers to check
		if server accepts cross-site XMLHttpRequest (indicated by the presence of CORS headers)
		https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS#Preflighted_requests
	*/
	i.addUserHeaders(w) // return all custom headers (including CORS ones, if set)
}
func (i *gatewayHandler) getOrHeadHandler(w http.ResponseWriter, r *http.Request) {
	begin := time.Now()
	urlPath := r.URL.Path
	escapedURLPath := r.URL.EscapedPath()
	// If the gateway is behind a reverse proxy and mounted at a sub-path,
	// the prefix header can be set to signal this sub-path.
	// It will be prepended to links in directory listings and the index.html redirect.
	prefix := ""
	if prfx := r.Header.Get("X-Ipfs-Gateway-Prefix"); len(prfx) > 0 {
		for _, p := range i.config.PathPrefixes {

I recommend opening a feature request in go-ipfs about better logging of gateway requests (please search for existing issues first around this topic).

Your best-shot workaround, however, is to put the IPFS gateway behind an nginx reverse proxy, which will log everything you want and let you control other stuff that IPFS does not allow to customize (max request body size, timeouts etc).