Enable SQL query logging in Bitbucket Server or Data Center

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

プラットフォームについて: Server および Data Center のみ。この記事は、Server および Data Center プラットフォームのアトラシアン製品にのみ適用されます。

Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Fisheye および Crucible は除く

要約

For troubleshooting purposes, it may be necessary to enable SQL query and parameter logging to review the queries that Bitbucket runs. 

This article describes procedures for enabling them.

ソリューション

Bitbucket versions >= 5.0

During Runtime

Enabling SQL query logging at runtime

This method enables the debug log level for SQL queries at runtime, without the need of restarting Bitbucket Server. More details are provided on the Enable debug logging page.

Enable debug log level
curl -X PUT -u <ADMIN_USERNAME> <BASE_URL>/rest/api/latest/logs/logger/org.hibernate.SQL/debug

Use the following to disable the debug log level by setting it back to warn:

Set log level to warn
curl -X PUT -u <ADMIN_USERNAME> <BASE_URL>/rest/api/latest/logs/logger/org.hibernate.SQL/warn

Enabling SQL parameter logging at runtime

This may log sensitive information (user names, group names, project names, etc).

This method enables the trace log level for logging the query parameters at runtime, without the need of restarting Bitbucket Server. More details are provided on the Enable debug logging page.

Enable trace log level
curl -X PUT -u <ADMIN_USERNAME> <BASE_URL>/rest/api/latest/logs/logger/org.hibernate.type/trace

Use the following to disable the trace log level by setting it back to warn:

Set log level to warn
curl -X PUT -u <ADMIN_USERNAME> <BASE_URL>/rest/api/latest/logs/logger/org.hibernate.type/warn


At Startup

Enabling SQL query logging at startup

Add the following to the $BITBUCKET_HOME/shared/bitbucket.properties  file followed by a restart.

logging.logger.org.hibernate.SQL=debug

To disable, just remove the line followed by a restart.

Enabling SQL parameter logging at startup

This may log sensitive information (user names, group names, project names, etc).

Add the following to the $BITBUCKET_HOME/shared/bitbucket.properties  file followed by a restart.

logging.logger.org.hibernate.type=trace

To disable, just remote the line followed by a restart.


Bitbucket versions < 5.0

Use the following procedures for versions earlier than 5.0:

ここをクリックして展開...

Enabling SQL query logging on startup

  1. Create a file <BITBUCKET_HOME>/logback.xml with the following text in it:

    <included>
    <logger name="org.hibernate.SQL" level="DEBUG"/>
    </included>
  2. Restart your Bitbucket Server instance.
  3. Look for org.hibernate.SQL logging lines in <BITBUCKET_HOME>/log/atlassian-bitbucket.log such as:

    2014-12-04 19:39:39,749 DEBUG [clusterScheduler_Worker-8]  
    org.hibernate.SQL delete sta_activity_0 from sta_activity 
    sta_activity_0  inner join HT_sta_pr_rescope_activity 
    HT_sta_pr_rescope_activity_0 on sta_activity_0.id=HT_sta_pr_rescope_activity_0.activity_id

Enabling parameter logging

This may log sensitive information (user names, group names, project names, etc).

SQL queries are parameterized with ?. If you need to see the parameter data, you can enable parameter logging by changing the logback.xml file as below.

<included>
<logger name="org.hibernate.SQL" level="DEBUG"/>
<logger name="org.hibernate.type" level="TRACE"/>
</included>




最終更新日 2024 年 8 月 9 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.