Bitbucket サポート

この記事は、JMX クライアントで監視するために、Bitbucket Server 内の JMX MBeans を開示する方法について説明します。

JMX とは何か

JMX (Java Management eXtensions) は、Java アプリケーションの監視と管理を行うためのテクノロジーです。JMX は MBean (Managed Bean) と呼ばれるオブジェクトを使用してアプリケーションのデータとリソースを公開します。

Bitbucket Server 内で JMX 監視を有効化する理由

On this page:

関連ページ:

JMX について理解する (Oracle)

Bitbucket Server または Bitbucket Data Center の大規模なインスタンスでは、JMX を有効化することで、アプリケーションリソースの消費状況をより簡単に監視できるようになります。これにより、マシンリソースの保持 / 最適化方法について、より優れた判断を行えます。

JMX を使用して何を監視できますか?

Bitbucket Server 内で JMX カウンタを使用してさまざまな統計情報を監視できます。以下は監視できる統計情報の例です。

メール統計情報 (com.atlassian.bitbucket:name=MailStatistics)

名前	説明
AverageMessageSize	送信されたメッセージの平均サイズ (バイト単位)
LargestMessageSent	送信された最大メッセージ (バイト単位)
LastMessageFailure	メッセージの送信に最後に失敗した日付
LastMessageSuccess	メッセージの送信操作に最後に成功した日付
LastQueueFullEvent	メッセージキューが前回満杯になった時間
QueueFullEventCount	メッセージキューが満杯になった回数
QueueUsage	キューの使用率を小数で表したもの。0.0d は空を、1.0d は満杯の状態を示します
QueuedMessagesCount	キューにある (未送信の) メッセージの現在の数
QueuedMessagesSize	キューにある (未送信の) メッセージの現在のサイズ (バイト単位)
TotalMailDataSent	送信されたメッセージの合計サイズ (バイト単位)
TotalMessagesFailed	送信に失敗したメッセージの合計数
TotalMessagesSent	送信済みのメッセージの合計数

診断

アラート合計 (com.atlassian.diagnostics:type=Alerts,name=Total)

名前	説明
LatestAlertTimestamp	最新のアラートのタイムスタンプ
TotalCount	JMX の起動以降のアラートの合計数
ErrorCount	JMX の起動以降の重大度 ERROR のアラートの数
InfoCount	JMX の起動以降の重大度 INFO のアラートの数
WarningCount	JMX の起動以降の重大度 WARNING のアラートの数

プラグイン (com.atlassian.diagnostics:type=Alerts,Category=Plugin,name=${PLUGIN_NAME})

名前	説明
LatestAlertTimestamp	最新のアラートのタイムスタンプ
TotalCount	JMX の起動以降のアラートの合計数
ErrorCount	JMX の起動以降の重大度 ERROR のアラートの数
InfoCount	JMX の起動以降の重大度 INFO のアラートの数
WarningCount	JMX の起動以降の重大度 WARNING のアラートの数
PluginName	プラグイン名 (利用可能な場合)

課題 (com.atlassian.diagnostics:type=Alerts,Category=Issue,name=${ISSUE_ID})

名前	説明
LatestAlertTimestamp	最新のアラートのタイムスタンプ
コンポーネント	課題が定義されているコンポーネント
count	JMX の起動以降のその課題のアラートの数
深刻度	課題の重大度
説明	課題の説明

ホスティング統計情報

プロトコル	オブジェクト名
ssh	com.atlassian.bitbucket:name=SshHostingStatistics
http	com.atlassian.bitbucket:name=HttpHostingStatistics

ホスティング統計属性

すべてのホスティング統計属性は、JVM の再起動以降、単調に増加します。

名前	説明
CloneCacheBypass	Clone requests that have bypassed the scm-cache
CloneCacheHit	Clone requests served from the scm-cache
CloneCacheMiss	Clone requests that could not be served from the scm-cache
CloneRead	Bytes read from clients during clone operations
CloneRequestCount	Number of clone requests served
CloneWritten	<i>クローン<i> 操作中にクライアントに書き込まれたバイト数
FetchRead	Bytes read from clients during <i>fetch</i> operations
FetchRequestCount	Number of fetch requests served
FetchWritten	Bytes written to clients during fetch operations
Requests	Total number of requests served
TotalBytesRead	Total bytes read from clients
TotalBytesWritten	Total bytes written to clients

Webhook 統計情報 (com.atlassian.webhooks:name=Webhooks)

名前	説明
PublishCount	webhook をトリガーできたイベントの合計数 (公開によって多数のディスパッチが作成される場合があります)
DispatchSuccessCount	正常な HTTP レスポンスによって正常に起動した webhook の合計数
DispatchRejectedCount	実行が拒否された webhook ディスパッチの数
DispatchLastRejectedTimestamp	サーキットブレークによって、または多数の webhook が動作したために前回 webhook が拒否された時刻
DispatchInFlightCount	トリガーされたディスパッチと解決を待機しているディスパッチの合計数
DispatchFailureCount	正常に起動したが HTTP レスポンスが失敗を示している webhook の合計数 (非 2xx コード)
DispatchErrorCount	ディスパッチされたときにエラーが発生した webhook の合計数
DispatchCount	ディスパッチされた webhook の合計数

スレッドプール

スレッドプール	説明	オブジェクト名
IoPumpThreadPool	Threads that handle blocking process I/O	com.atlassian.bitbucket.thread-pools:name=IoPumpThreadPool
NioPumpThreadPool	Threads that handle nonblocking process I/O	com.atlassian.bitbucket.thread-pools:name=NioPumpThreadPool
ScheduledThreadPool	さまざまな複数のスケジュール済みタスクを処理するスレッドプール	com.atlassian.bitbucket.thread-pools:name=ScheduledThreadPool
EventThreadPool	イベントを @EventListenermethods にディスパッチするスレッド	com.atlassian.bitbucket.thread-pools:name=EventThreadPool

スレッドプール属性

名前	説明
ActiveCount	アクティブにタスクを実行しているスレッド数の概算を返します。
MaximumPoolSize	最大許容スレッド数を返します。
PoolSize	現在プール内にあるスレッド数を返します。
QueueLength	スレッドプールによる実行待ちのタスクの数
LargestPoolSize	プール内に同時に存在したスレッドの最大数
CompletedTaskCount	実行が完了したタスクの合計数の概算。タスクおよびスレッドの状態は計算中に動的に変わる場合があるため、返される値はおおよその値ですが、この値が成功呼び出し全体で減ることはありません。

リポジトリ (com.atlassian.bitbucket:name=Repositories)

名前	説明
count	Bitbucket Server ですべてのプロジェクトで現在設定されているリポジトリの数

Scm 統計 (com.atlassian.bitbucket:name=ScmStatistics)

名前	説明
Pulls	開始以降、このインスタンスが提供した scm プルの数
Pushes	インスタンスの開始以降、このインスタンスが受信した scm プッシュの数

チケット統計

Bitbucket Server は、システムがリクエストで過負荷状態になることを防ぐためのバックプレッシャーの作成メカニズムとして "チケット" を使用します。Bitbucket Server で使用されるチケットには、ホスティングチケットとコマンドチケットの 2 種類があります。
ホスティングチケット (com.atlassian.bitbucket:name=HostingTickets): 同時に実行される可能性がある SCM ホスティング操作 (HTTP または SSH 経由のプッシュおよびプル) の数を制限します。
コマンドチケット (com.atlassian.bitbucket:name=CommandTickets): 同時に実行される可能性がある git diff、git blame、git rev-list などの SCM コマンドの数を制限します。

Bitbucket Server では、各チケットタイプごとに以下のメトリックをサポートします。

名前	説明
Available	取得に利用できるチケットの数 (数値が小さいほど負荷が大きくなります)
LastRejection	前回拒否されたチケットのタイムスタンプ、チケットが拒否されていない場合は null
名前	チケットバケットの名前 ("scm-command" または "scm-hosting")
OldestQueuedRequest	キューに最初に追加されたリクエストが開始を待機した時間のタイムスタンプ、キューにリクエストがない場合は null
QueuedRequests	利用可能なチケットを現在待機しているリクエストの数
合計	バックプレッシャーが適用されるまでに同時に取得できるチケットの最大数
Used	取得されたチケットの数 (数値が大きいほど負荷が大きくなります)

イベント統計 (com.atlassian.bitbucket:name=EventStatistics)

名前	説明
DispatchedCount	実行されたリスナーコールバックの合計数。10 リスナーに配信されるイベントが 10 ディスパッチとカウントされます
LastRejection	前回のイベントが拒否された日付、イベントが拒否されていない場合は null
PublishedCount	配信されたイベントの総数。10 リスナーに配信されるイベントが 1 イベントとカウントされます。
QueueCapacity	イベントが却下される前にキューに追加できるイベントコールバックの最大数
QueueLength	キューに追加されているがまだディスパッチされていないイベントコールバックの数
RejectedCount	イベントキューが満杯だったためにディスパッチされなかったイベントの合計数
RemainingQueueCapacity	イベントが却下される前にキューに追加できるイベントコールバックの残りの数

クラスタロック統計情報 (com.atlassian.bitbucket:name=ClusterLocks)

名前	説明
LockedCount	このノードが現在保持しているクラスタロックの数
QueuedThreadCount	このノード上の、現在ロックを待機してブロックされているスレッド数
TotalAcquiredCount	このノードの起動以降、ノードでクラスタロックが取得された合計回数
TotalAcquireErrorCount	このノードの起動以降、ノードでクラスタロックを取得しようとしているときに例外がスローされた回数
TotalAcquireTimeMillis	このノードで任意のスレッドがロックの取得に費やしたミリ秒単位の合計時間 (ロックが使用可能になるまで待機しているブロック時間を含む)
TotalReleasedCount	このノードの起動以降、ノードでクラスタロックが解放された合計回数
TotalReleaseErrorCount	このノードの起動以降、ノードでクラスタロックの開放中に例外がスローされた合計回数

SSH セッション統計 (com.atlassian.bitbucket:name=SshSessions)

名前	説明
ActiveSessionCount	現在アクティブな SSH セッションの数
MaxActiveSessionCount	前回の起動以降、同時にアクティブな SSH セッションの最大数
SessionClosedCount	前回の起動以降、クローズされた SSH セッションの合計数
SessionCreatedCount	前回の起動以降、作成された SSH セッションの合計数
SessionExceptionCount	SSH コマンド実行で例外がスローされたために終了した SSH セッションの合計数

Rate limiting statistics (com.atlassian.bitbucket:name=RateLimitStatistics)

名前	説明
RejectedRequestCount	The number of rate limited requests
UserMapSize	The number of token buckets currently in memory

サードパーティライブラリ属性

Bitbucket Server は、多数のサードパーティライブラリから JMX 属性を開示します。以下の一覧は、運用の観点で特に興味深い属性のサンプルです。

HikariCP - (com.zaxxer.hikari:type=Pool (bitbucket))

名前	説明
ActiveConnections	アクティブ接続数 (使用中)
IdleConnections	アイドル接続数
ThreadsAwaitingConnection	接続を待機しているスレッドの数 (利用可能なすべての接続が使用中の場合)
TotalConnections	合計接続数

Hibernate - (org.hibernate.core:sessionFactory=bitbucket.core,serviceRole=org.hibernate.stat.Statistics,serviceType=org.hibernate.stat.internal.ConcurrentStatisticsImpl)

名前	説明
QueryCacheHitCount	キャッシュから正常に取得されたキャッシュ済みクエリのグローバル数
QueryCacheMissCount	キャッシュ内で検出されなかったキャッシュ済みクエリのグローバル数
SecondLevelCacheHitCount	キャッシュから正常に取得されたキャッシュ可能エンティティ / コレクションのグローバル数
SecondLevelCacheMissCount	キャッシュ内で検出されず、データベースからロードされたキャッシュ可能エンティティ / コレクションのグローバル数

Bitbucket Server 内での JMX MBeans の公開

Bitbucket Server で JMX を使用した特定の統計の公開を有効化するには、以下を実行する必要があります。

Locate and open the bitbucket.properties file in the <Bitbucket home directory>/shared directory.
1. ファイルにこのプロパティを追加します。
```
jmx.enabled=true
```
2. ファイルを保存して閉じます。
JMX モニタリングに安全にアクセスするために、JMX パスワードファイルを作成します。
Modify the set-jmx-opts.sh file to enable Bitbucket Server to expose JMX Mbeans.

これらの変更は、Bitbucket Server が再起動されるまで反映されません。

JMX パスワードファイルのセットアップ

JMX パスワードファイルをセットアップして、JMX モニタリングに安全にアクセスする方法

Create a file named jmx.access.

このファイルには、パスワード情報が含まれます。ファイルが、Bitbucket Server を実行するセキュアなユーザーからのみ読み取り可能であることを確認します。ただし、Bitbucket Server ユーザーがファイルを読み取ることができない場合、Bitbucket Server の起動が失敗する点にご注意ください。
Edit the jmx.access file to include this property and save the file.
```
monitorRole <password>
```
If you wish to use a username other than monitorRole or controlRole you will need to modify the jmxremote.access file located in the /lib/management/ directory of the installed Java.

Bitbucket Server 環境ファイルの変更

To modify the set-jmx-opts.sh (for Windows set-jmx-opts.bat) files to enable JMX monitoring for Bitbucket Server

Within the bin directory, locate the file set-jmx-opts.sh (for Windows set-jmx-opts.bat) and change these properties.

JMX_REMOTE_AUTH=password
JMX_REMOTE_PORT=3333
RMI_SERVER_HOSTNAME=-Djava.rmi.server.hostname=<hostname>
JMX_PASSWORD_FILE=<path>/jmx.access

Bitbucket Server を再起動します。

Bitbucket Server が Windows サービスとして実行されている場合に JMX MBeans を公開する

Bitbucket Server が Windows サービスとして実行されている場合に JMX MBeans を公開する方法

Bitbucket Server サービスを停止します。
コマンドラインプロンプトを開いて以下を入力します。
```
cmd
```
Navigate to the Bitbucket Server bin directory.
```
cd <Bitbucket Server installation dir>\bin
```

次のコマンドを実行します。

tomcat8w //ES//AtlassianBitbucket Server

表示されたウィンドウで [Java] タブをクリックすると、現在の起動オプションの一覧が表示されます。[Java Options:] フォームで、値を入力します。
```
-Dcom.sun.management.jmxremote.port=<JMX_REMOTE_PORT>   
-Djava.rmi.server.hostname=<hostname>
-Dcom.sun.management.jmxremote.ssl=false 
-Dcom.sun.management.jmxremote.password.file=<JMX_PASSWORD_FILE> 
```
パスワードファイルの所有者が、Bitbucket Server を実行するセキュアユーザーであることを確認します。Bitbucket Server ユーザーがファイルを読み取ることができない場合、Bitbucket Server の起動が失敗します。

<> 文字内の値を置き換えます。

JMX_REMOTE_PORT=3333
JMX_PASSWORD_FILE=<path>\jmx.access

Bitbucket Server サービスを再起動します。

JMX が正しく構成されていることを確認する

これらの手順では、JMX が正しく設定されていることをテストするのに JConsole を使用します。JConsole は、Oracle JDK に同梱されているユーティリティです。

jconsole ユーティリティを起動するには、コマンドラインプロンプトから以下を入力します。
```
jconsole
```
同様の接続設定で新しい JConsole 接続を作成します。
bitbucket 監視する Bitbucket Server インスタンスのホスト名
3333
以前に構成した JMX ポート番号。
username, password values configured within the JMX password file jmx.access.
接続をクリックします。

正しく設定されている場合、これらのプロパティが表示されます。

com.atlassian.bitbucket	CommandTickets HostingTickets プロジェクトリポジトリ ScmStatistics Tickets EventStatistics ClusterLocks SshSessions
com.atlassian.bitbucket.thread-pools	EventThreadPool IoPumpThreadPool ScheduledThreadPool

パフォーマンスダッシュボードの例

このダッシュボードは、Oracle JDK (1.7u40 以降) に同梱されている Java Mission Control を使用して生成されました。詳細については、ご利用の JMX クライアントに同梱しているドキュメントを参照してください。

SSL を使用するように JMX を設定する

You can find information about the options for configuring JMX to use SSL in the set-jmx-opts files. Comprehensive documentation is available from Oracle.

bitbucket	監視する Bitbucket Server インスタンスのホスト名
3333	以前に構成した JMX ポート番号。
username, password	values configured within the JMX password file `jmx.access`.

ページ

Viewport

Confluence

バージョン

Enabling JMX counters for performance monitoring

Bitbucket Server を管理する

このページの内容

関連コンテンツ

お困りですか?