データセンター アプリケーションで REST API を使用してサポート zip を作成する

サポート zip は、ご利用のアプリケーションの構成内容をアトラシアン サポートが理解し、お客様の問題を解決する上で役立ちます。

サポート zip を生成する最も一般的な方法は、アプリケーションの管理メニューからの作成です。ただし、Data Center アプリケーションでは、REST API を使用して zip を作成するほうが便利な場合があります。アプリケーションをクラスター化している場合、REST API を使用することで、現在アクセスしているノードだけでなく、すべてのノードから zip を生成できます。 サポート zip の作成に詳細を確認する 

REST API のリファレンス

このページでは、curl と Windows PowerShell を使用した、データセンター アプリケーションでの REST API の使用例について説明します。任意のスクリプト言語をご利用いただけます。 

• curl の公式ドキュメントを確認する

• PowerShell の公式ドキュメントを確認する

• Server (非クラスタ) アプリケーションのサポート zip を作成する方法を確認する 

次の REST エンドポイントを利用できます。

すべてのノードでサポート zip を生成

データセンター インスタンスのすべてのノードのサポート zip をコマンド ラインから生成するには、次のコマンドを実行します。 

curl -s -X POST -H 'Content-Type: application/json' -u <username>:<password> http://<base-url.example.com:8080>/rest/troubleshooting/latest/support-zip/cluster

これはクラスタ タスク ID とノード情報を返します。例:

{
   "clusterTaskId":"eec930c0-687c-4a07-b625-02e95022b8ad",
   "nodeIds":["jira1","jira2"]
}

クラスタ タスク ID は各ノードにあるすべての個々のサポート zip タスクをグループ化します。ここでそれぞれの進捗を確認します。  

# Specify your username, password and Base URL (including a context path if one is being used) below
$user = '<username>'
$pass = '<password>'
$baseurl = 'http://<base-url.example.com:8080>'

# no need to change anything below this line
$pair = "$($user):$($pass)"
$encodedCreds = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($pair))
$basicAuthValue = "Basic $encodedCreds"

$headers = @{}
$headers.Add("Authorization", $basicAuthValue)
$headers.Add("X-Atlassian-Token", "no-check")

Invoke-WebRequest -Method POST -Uri "$baseurl/rest/troubleshooting/latest/support-zip/cluster" -UseBasicParsing -Headers $headers

StatusCode        : 200
StatusDescription : OK
Content           : {"clusterTaskId":"eec930c0-687c-4a07-b625-02e95022b8ad","nodeIds":["jira1","jira2"]"}

特定のノードでサポート zip を生成する

特定のノードを指定するには、リクエストに次のように nodeIds を含めます。

curl -s -X POST -H 'Content-Type: application/json' -u <username>:<password> http://<base-url.example.com:8080>/rest/troubleshooting/latest/support-zip/cluster -d '{"nodeIds":["jira1","jira2"]}'

この例では、ノード ID は Jira1 と Jira2 です。ご利用の環境ではノード名が異なる場合があります。  

リクエストの進行状況を確認する

特に大規模なインスタンスの場合、zip の生成には時間がかかる場合があります。タスクの進行状況を確認するには、次のコマンドを実行します。

curl -s -X GET -u <username>:<password> http://<base-url.example.com:8080>/rest/troubleshooting/latest/support-zip/status/cluster/<clusterTaskId>

この例でのクラスタ タスク ID は eec930c0-687c-4a07-b625-02e95022b8ad です。 

# Specify your username, password and Base URL (including a context path if one is being used) below
$user = '<username>'
$pass = '<password>'
$baseurl = 'http://<base-url.example.com:8080>'
$clustertaskid = '<clusterTaskId>'

# no need to change anything below this line
$pair = "$($user):$($pass)"
$encodedCreds = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($pair))
$basicAuthValue = "Basic $encodedCreds"

$headers = @{}
$headers.Add("Authorization", $basicAuthValue)
$headers.Add("X-Atlassian-Token", "no-check")

(Invoke-WebRequest -Uri "$baseurl/rest/troubleshooting/latest/support-zip/status/cluster/$clustertaskid" -UseBasicParsing -Headers $headers).Content

これは、各ノードでの zip 生成の現在の状況を返します。この例では、zip は完成していて、共有ホーム ディレクトリからダウンロードまたは転送できます。 

{
  "clusterTaskId": "eec930c0-687c-4a07-b625-02e95022b8ad",
  "tasks": [
    {
      "taskId": "aaa192c8-f033-4df4-8530-95bcf328c646",
      "progressPercentage": 100,
      "progressMessage": "Your support ZIP can be found in your home directory at: /<shared-home>/export/JIRA_jira2_support_2018-06-11-23-35-12.zip or you can download a copy.",
      "nodeId": "jira2",
      "fileName": "JIRA_jira2_support_2018-06-11-23-35-12.zip"
    },
    {
      "taskId": "d7086507-2d2d-464b-9a7f-9b580ed85956",
      "progressPercentage": 100,
      "progressMessage": "Your support ZIP can be found in your home directory at: /<shared-home>/export/JIRA_jira1_support_2018-06-11-23-35-09.zip or you can download a copy.",
      "nodeId": "jira1"
    }
  ]
}

/status/clustertaskID がノードを返さない場合、ノードが応答していないか、そのノードで zip 生成が開始されていない可能性があります。リクエストがすべてのノードに到達してプロセスが開始されるまで数分間待ち、もう一度試してみてください。 

特定のパラメータでサポート zip を生成する

管理コンソール経由でサポート zip を生成すると、含める項目を選択したり、必要に応じてファイル サイズを制限したり、選択した期間のログ ファイルをエクスポートしたりできます。これは、REST API を使用して zip を生成する場合も可能です。

たとえば、ログ ファイルとヘルス チェックの結果をノード 1 ~ 2 から取得し、ファイル サイズは制限したくない場合、次のコマンドを使用できます。

curl -s -X POST -H 'Content-Type: application/json' -u <username>:<password> http://<base-url.example.com:8080>/rest/troubleshooting/latest/support-zip/cluster -d '{"nodeIds":["jira1","jira2"], "items":["application-logs", "tomcat-logs", "healthchecks"], "limitFileSizes": false}'

1. 33 以前から受け入れられる REST API 値 

auth-cfg

application-config

application-properties

confluence-customisations

healthchecks

application-logs

cache-cfg

Fecru-out

fecru-pluginstate-properties

MODZ

fecru-plugin-cfg

thread-dump

tomcat-config

tomcat-logs

tomcat-access-logs

cluster-nodes

cloud-migration-logs

jfr-bundle

synchrony-config

1.49.0 で追加された REST API パラメーター

新しい API パラメーターは、トラブルシューティングおよびサポート ツール 1.49.0 以降で使用できます。

// File size constraint with default value (100MB per each file) applied
{
...,
"limitFileSizes":"true"
}

// No file size limits are applied
{
...,
"limitFileSizes":"false"
}

// File size constraint with default value (100MB per each file) applied
{
...
}

// File size constraint with value of 25MB per each file applied
{
...,
"limitFileSizes":"false",
"fileConstraintSize":"25"
}

{
...,
"limitFileSizes":"true",
"fileConstraintSize":"25"
}

{
...,
"fileConstraintSize":"25"
}

// File age constraint for files modified in current day applied
{
...,
"fileConstraintLastModified":"0"
}

/**
* File size constraint with value of 25MB per each file applied
* File age constraint for files modified in the past 5 days applied
*/
{
...,
"fileConstraintSize":"25",
"fileConstraintLastModified":"5"
}

サポート zip ファイルのダウンロード

サポート zip は、共有ホーム ディレクトリ内の場所に保存されます。このディレクトリへのアクセスが難しい場合、またはプロセスを自動化したい場合は、次のように REST API を使用してダウンロードできます。

curl -u <username>:<password> http://<base-url.example.com:8080>/rest/troubleshooting/latest/support-zip/download/<filename> -o support.zip

この例では、<filename> が 出力されたファイル名の JIRA_jira2_support_2018-06-11-23-35-12.zip と support.zip になります。ノードを指定する必要はなく、リクエストのステータスを確認したときに返されるファイル名のみが必要です。 

トラブルシューティング

• サポート zip を生成するには、システム管理者権限が必要です。適切な権限がない場合、リクエストは権限エラーで失敗します。 
• /status/clustertaskID がノードを返さない場合、ノードが応答していないか、そのノードで zip 生成が開始されていない可能性があります。リクエストがすべてのノードに到達してプロセスが開始されるまで数分間待ち、もう一度試してみてください。 
• 404 エラーが表示される場合、Jira が実行中で、アトラシアン トラブルシューティングとサポート ツール アドオンの 1.10.5 以降がインストールされていることを確認してください。アプリはいつでも更新できます。アプリ更新の詳細を確認する

• 'XSRF check failed' エラーが返される場合、各リクエストに X-Atlassian-Token ヘッダーを追加できます。値は no-check に設定します。リクエストにこのヘッダーを追加することで、サーバー側の XSRF チェックを迂回し、リクエストを実現できます。これは Confluence の場合は必須です。例:
  
  

  curl -u <username>:<password> -X POST http://<app-node1.example.com:8080>/rest/troubleshooting/latest/support-zip/local -H "X-Atlassian-Token: no-check"