Stash debug logging

Redirection notice

This page will redirect to /display/BitbucketServer/Bitbucket+Server+debug+logging .

On this page:

Debug logging for the Stash server

This section describes how to enable debug level logging in Stash. Stash logs can be found in <Stash home directory>/log.

When using the standard Stash distribution, logs for the Tomcat webserver that hosts Stash can be found in <Stash installation directory>/log.

Enabling debug logging via the UI

To enable debug logging, go to the Stash admin area, choose Logging and Profiling (under 'Support') and select Enable debug logging.

Enabling debug logging on startup

To enable debug logging whenever Stash is started, edit the <Stash home directory>/shared/stash-config.properties file (if this file doesn't exist then you should create it) and add the following two lines:

logging.logger.ROOT=DEBUG
logging.logger.com.atlassian.stash=DEBUG

If your Stash instance is earlier than version 3.2, the stash-config.properties file is at the top level of the Stash home directory.

Enabling debug logging at runtime

To enable debug logging for the root logger once Stash has been started, run the following two commands in your terminal:

curl -u <ADMIN_USERNAME> -v -X PUT -d "" -H "Content-Type: application/json" <BASE_URL>/rest/api/latest/logs/rootLogger/debug
curl -u <ADMIN_USERNAME> -v -X PUT -d "" -H "Content-Type: application/json" <BASE_URL>/rest/api/latest/logs/logger/com.atlassian.stash/debug

# e.g.
curl -u admin -v -X PUT -d "" -H "Content-Type: application/json" http://localhost:7990/rest/api/latest/logs/rootLogger/debug
curl -u admin -v -X PUT -d "" -H "Content-Type: application/json" http://localhost:7990/rest/api/latest/logs/logger/com.atlassian.stash/debug

To enable debug logging for a specific logger, run the following command in your terminal:

curl -u <ADMIN_USERNAME> -v -X PUT -d "" -H "Content-Type: application/json" <BASE_URL>/rest/api/latest/logs/logger/<LOGGER_NAME>/debug

# e.g.
curl -u admin -v -X PUT -d "" -H "Content-Type: application/json" http://localhost:7990/rest/api/latest/logs/logger/com.atlassian.crowd/debug

Profiling logging for the Stash server

This section describes how to enable profiling in Stash. This log is essential when troubleshooting performance issues. Stash logs can be found in <Stash home directory>/log.

When using the standard Stash distribution, logs for the Tomcat webserver that hosts Stash can be found in <Stash installation directory>/log.

Enabling profiling logging via the UI

To turn on detailed trace information,  go to the Stash admin area, choose Logging and Profiling (under 'Support') and select Enable profiling.

Debug logging for Git operations on the client

Atlassian Support might request DEBUG logs for Git operations (on the client) when troubleshooting issues. You can enable DEBUG logging on the Git client by setting the following variables. If you are using HTTP/S please do remove the Authorization header from the output as it will contain your Basic-Auth information. Atlassian provides a set of scripts that simplify the collection of git client debug information.

On Linux

Execute the following in the command line before executing the Git command:

export GIT_TRACE_PACKET=1
export GIT_TRACE=1 
export GIT_CURL_VERBOSE=1

On Windows

Execute the following in the command line before executing the Git command:

set GIT_TRACE_PACKET=1
set GIT_TRACE=1 
set GIT_CURL_VERBOSE=1

Setting GIT_CURL_VERBOSE is only useful for connections over HTTP/S since SSH doesn't use the libcurl library.

Debug logging for the Stash Backup Client

Atlassian Support might request DEBUG logs for the Backup client when troubleshooting issues.

You can enable DEBUG logging on the Backup client by adding a file named logback.xml to your working directory (pwd) with the following content:

logback.xml
<included><logger name="com.atlassian.stash" level="DEBUG"/></included>


Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport