YouTrack サーバー 2024.2 ヘルプ

JVM オプションの構成

YouTrack インスタンスのプロパティと JVM オプションを設定できます。YouTrack プロパティにはさまざまな起動設定が含まれています。JVM オプションを使用すると、サーバーの動作、ガベージコレクション、パフォーマンス、デバッグの各オプションを管理できます。

YouTrack サーバーインストールのデフォルトの JVM オプションを編集する最も一般的な使用例は、サーバーに大きな負荷をかける操作を実行する場合です。これには、外部ソースからのコンテンツのインポートや、多数の課題に対する一括更新の実行が含まれます。サーバーのタイムアウトまたはメモリ制限のために失敗するプロセスを開始した場合は、操作が完了するまで Java ヒープまたは Metaspace メモリを一時的に増やすことができます。

  • YouTrack は、YouTrack インストールのパフォーマンスとメモリ割り当てに影響する JVM オプションのデフォルト値を提供します。完全なリストについては、デフォルトの JVM オプションを参照してください。

  • その他のパラメーターは、特定の機能の可用性やその他のアプリケーションの動作に影響します。YouTrack 固有の構成パラメーターの完全なリストについては、構成パラメーターを参照してください。

デフォルト設定とは異なる JVM オプションは、youtrack.jvmoptions という名前の内部ファイルに保存されます。YouTrack サービスを開始するたびに、YouTrack はこのファイルを読み取り、この構成に保存されているパラメーターを YouTrack インスタンスに適用します。

これらのパラメーターを更新するために使用できる方法は 2 つあります。

メソッド

説明

パラメーターを永続的に更新します

パラメーターの値を永続的に変更するには、次のいずれかを実行できます。

  • configure コマンドを使用してプログラムで値を設定します。

  • youtrack.jvmoptions ファイルで JVM オプションを手動で更新します。

パラメーターを一時的に更新します

アドホック開始パラメーターとして、JVM オプションを一時的に渡すことができます。パラメーターの値は、現在の実行に対してのみ設定されます。youtrack.jvmoptions ファイルは更新されないため、開始パラメーターを指定せずに YouTrack インスタンスを再始動すると、パラメーターは構成に保管されている値にリセットされます。

このオプションを使用して、環境への変更を永続的に適用する前にテストします。

永続的に JVM オプションを更新する

JVM オプションを永続的に更新する場合は、youtrack.jvmoptions ファイルを更新します。ファイルをプログラムで更新することも、ファイル内の設定を手動で変更することもできます。

YouTrack プロパティまたは JVM オプションを設定すると、そのプロパティはサーバーの再起動ごとに適用されます。

コマンドライン引数を使用して JVM オプションを設定する

configure コマンドを使用して、サーバーのプロパティと JVM オプションを設定できます。この方法は、あらゆるタイプの YouTrack インストールに使用できます。

コマンドラインから JVM オプションを設定するときは、次のガイドラインを考慮してください。

  • 常に YouTrack サービスを実行する OS ユーザーに代わって configure コマンドを実行してください。このコマンドは、構成ファイルとフォルダーを作成します。YouTrack サービスのユーザーは、これらのファイルとフォルダーにアクセスするための十分なアクセス許可を持っている必要があります。

  • JVM オプションのパラメーターを設定するには、-J という接頭部を付けて configure コマンドを入力します。-J 接頭辞は、JVM オプションがその後に宣言されていることを示します。構成したい各 JVM オプションに -J 接頭部を追加する必要があります。

  • D プレフィックスは、それに続く名前と値のペアが JVM 内のシステムプロパティとして使用されることを意味します。

  • 起動時に JVM によって YouTrack に渡されるオプションを定義するには、パラメーター名の前に - を使用します。youtrack configure -J-<jvm.property>[=<value>]

    例:

    youtrack configure -J-Dorg.eclipse.jetty.server.Request.maxFormKeys=10000 youtrack configure -J-Xmx1024m -J-XX:+HeapDumpOnOutOfMemoryError
  • JVM オプションを削除するには、パラメーター名の前に + を使用します: youtrack configure -J+<jvm.property>[=<value>]

    構造 +option=<value>+XX:<option>=<value>+D<property>=<value> は、まったく同じ値を持つ場合にのみ、対応するオプションを削除します。

    例:

    youtrack configure -J+Dorg.eclipse.jetty.server.Request.maxFormKeys=10000

    構造 +option+XX:<option>+D<property> は、値に関係なく、対応するオプションを削除します。

    例:

    youtrack configure -J+ea

Docker コンテナーのコマンドラインから JVM オプションを設定するには:

  1. YouTrack を停止します。

    docker exec <containerId> stop
  2. 次のコマンドを実行します。

    docker run --rm -it \ -v <path to conf directory>:/opt/youtrack/conf \ jetbrains/youtrack:<version> \ configure -J-<jvm.property>=<value>
    docker run --rm --it ^ -v <path to conf directory>:/opt/youtrack/conf ^ jetbrains/youtrack:<version> ^ configure -J-<jvm.property>=<value>
    • <jvm.property> を、更新するプロパティの名前に置き換えます。

    • <value> を設定したい値に置き換えます。

    例:

    configure -J-Dstatistics-upload=true
  3. YouTrack を開始します。

    docker start <containerId>

ZIP インストールのコマンドラインから JVM オプションを設定するには:

  1. コマンドラインインターフェースを開き、次のコマンドを入力して YouTrack サービスを停止します。

    youtrack.sh stop
  2. configure コマンドを入力します。例:

    <youtrack_home>bin/youtrack.sh configure -J-Dstatistics-upload=true
  3. 次のコマンドを使用して、YouTrack サービスを再起動します。

    youtrack.sh restart

JVM オプションを手動で更新する

youtrack.jvmoptions ファイルを編集することにより、JVM オプションを手動で構成できます。このファイルは、デフォルト構成を変更すると自動的に作成されます。ファイルの場所は、YouTrack インストールのディストリビューションタイプによって異なります。

サーバーの JVM オプションを変更していない場合は、ディレクトリにサンプル構成ファイルが含まれています。サンプル構成ファイルは .dist 拡張子を使用し、デフォルトの JVM オプションのリストが含まれています。編集したいファイルが存在しない場合

  • youtrack.jvmoptions.dist ファイルをコピーして youtrack.jvmoptions として保存します

    または

  • このディレクトリに youtrack.jvmoptions ファイルを作成し、サンプル構成ファイルの内容をそこに貼り付けます。

次に、ファイルの内容を編集して、次の手順で説明するように JVM オプションを構成できます。

Docker コンテナーで JVM オプションを手動で更新するには:

  1. YouTrack を停止します。

    docker exec <containerId> stop
  2. youtrack.jvmoptions ファイルを開きます。

    Docker イメージの場合、ファイルは、コンテナー内の /opt/youtrack/conf ディレクトリにマップされているホストマシンの conf ディレクトリにあります。

  3. YouTrack を開始します。

    docker start <containerId>

ZIP インストール用に JVM オプションを手動で更新するには:

  1. コマンドラインインターフェースを開き、次のコマンドを入力して YouTrack サービスを停止します。

    youtrack.sh stop
  2. youtrack.jvmoptions ファイルを開きます。

    ZIP 形式のディストリビューションの場合、ファイルは <YouTrack installation directory>/conf ディレクトリにあります。

  3. ファイル内の JVM オプションを直接編集します。事前定義された JVM オプションの値を設定するには、対応する行をコメントとしてマークする特殊文字を削除し、プロパティを目的の値に変更します。

  4. ファイルを保存して閉じます。

  5. 次のコマンドを使用して、YouTrack サービスを再起動します。

    youtrack.sh restart

JVM オプションを一時的に更新する

JVM オプションを一時的に変更する場合は、servicestart コマンドでアドホックパラメーターを使用できます。このメソッドは、youtrack.jvmoptions ファイルをバイパスし、指定されたパラメーターで YouTrack を実行します。アドホックパラメーターを指定しない後続の起動では、構成ファイルに格納されている JVM オプションを使用します。

Docker イメージでアドホックパラメーターとして JVM オプションを渡すには:

  1. 次のコマンドを使用して、YouTrack サービスを停止します。

    docker exec <containerId> stop
  2. configure-next-start コマンドを実行します。

    docker run -it --rm \ -v <path to conf directory>:/opt/youtrack/conf \ jetbrains/youtrack:<version> \ configure-next-start \ <ad hoc JVM options>
    docker run -it --rm ^ -v <path to conf directory>:/opt/youtrack/conf ^ jetbrains/youtrack:<version> ^ configure-next-start ^ <ad hoc JVM options>

    <ad hoc JVM options> の場合、YouTrack サービスの次回の開始時に適用する必要がある JVM オプションのリストを指定します。アドホック JVM オプションを次の形式で指定します。

    --J<JVM option>

    --J は、オプションが後に続くアドホックプレフィックスです。プレフィックスとオプションの間にスペースを追加しないでください。オプションの前にある記号は、オプションの適用方法を決定します。

    • - 記号を使用してオプションを追加します。

    • + 記号の付いたオプションは無視してください。値を指定すると、対応するオプションは、値がまったく同じである場合にのみ無視されます。

    例:

    docker run -it --rm \ -v <path to conf directory>:/opt/youtrack/conf jetbrains/youtrack:<version> \ configure-next-start \ --J-XX:+HeapDumpOnOutOfMemoryError \ --J-Xmx1024m
    docker run -it --rm ^ -v <path to conf directory>:/opt/youtrack/conf ^ jetbrains/youtrack:<version> ^ configure-next-start ^ --J-XX:+HeapDumpOnOutOfMemoryError ^ --J-Xmx1024m
  3. YouTrack サービスを再起動します。

    docker start <containerId>
    • YouTrack サービスは、指定された設定の使用を開始します。

    • youtrack.jvmoptions ファイルは変更されません。

ZIP インストールでアドホックパラメーターとして JVM オプションを渡すには:

  1. コマンドラインインターフェースで、次のコマンドを入力して YouTrack サービスを停止します。

    youtrack.sh stop
  2. ディレクトリを <youtrack_home>/bin に変更します。

    ZIP インストールの場合、<youtrack_home> ディレクトリは ZIP ディストリビューションがインストール中に解凍された場所です。

  3. youtrack.sh start コマンドを入力してから、開始時に YouTrack データベースに渡す設定を入力します。

    • --J プレフィックスを使用して、設定をアドホックパラメーターとして渡します。

    • プレフィックスの後に JVM オプションを続けます。プレフィックスとオプションの間にスペースを追加しないでください。オプションの前にある記号は、オプションの適用方法を決定します。

      • - 記号を使用してオプションを追加します。

      • + 記号の付いたオプションは無視してください。値を指定すると、対応するオプションは、値がまったく同じである場合にのみ無視されます。

    例:

    youtrack.sh start --J-XX:+HeapDumpOnOutOfMemoryError --J-Xmx1024m
    • YouTrack サービスは、指定された設定の使用を開始します。

    • youtrack.jvmoptions ファイルは変更されません。

以前の設定で YouTrack を実行するには、カスタムパラメーターを渡さずにサービスを再起動します。

JVM オプションの確認

YouTrack インストールの JVM オプションを変更した後、変更が適用されていることを確認することをお勧めします。これを行うには、list jvm-options コマンドを使用できます。次回の起動時に YouTrack インスタンスに適用される JVM プロパティのリストを生成します。コマンドの出力には、永続的な JVM オプションのみがリストされることに注意してください。YouTrack を実行するコマンドでアドホックに提供されるオプションは、同じ永続オプションの値をオーバーライドします。

デフォルトの JVM オプション

YouTrack を実行するために、すべてのインストールでデフォルトで次の JVM オプションが設定されています。

設定

JVM オプション

最大メタスペースメモリ

-XX:MaxMetaspaceSize

350m

最大 Java ヒープサイズ

-Xmx

1024m または 1g

次の JVM オプションは、YouTrack インストールのパフォーマンスを管理および改善できます。

設定

JVM オプション

最小メタスペースメモリ

-XX:MetaspaceSize

350m