How to validate Hipchat Server/Data Center imports and exports

お困りですか?

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

コミュニティに質問

概要

This page documents functions built into the Hipchat Server/Data Center Toolkit ("the Toolkit") related to validating the export/import of data from Hipchat Server (HCS) to Hipchat Data Center (HCDC) and the suggested method for its use during a migration.

要件

The Toolkit must be executed from the HCS/HCDC terminal/command-line interface.

Where do I get it?

The toolkit can be downloaded from this link: https://s3.amazonaws.com/hipchat-toolkit/hipchat_toolkit.run

The toolkit is built to be run from the terminal/command-line interface (CLI) of HCS or of a HCDC node. The command below can be used from the terminal/CLI to download directly to HCS or an HCDC node, assuming it can connect to Amazon S3:

wget https://s3.amazonaws.com/hipchat-toolkit/hipchat_toolkit.run

After downloading the script, and optionally transferring it to a HCS instance or HCDC node, run the following to make it executable:

chmod +x hipchat_toolkit.run

Available Functions

The following functions are built into the data branch of the Toolkit for use during a migration.

(info) Each command's output can be captured as a log file through redirection. For example:

./hipchat_toolkit.run data import_log_stats -l /var/log/hipchat/hcapp.log > import_stats.out

export_log_stats

Outputs statistics from a Hipchat Server/DC export process.

Use this function after exporting Hipchat data. Please note that HCS/HCDC has an automatic log rotation mechanism, so the correct log file may be zipped in the /var/log/hipchat (HCS) or /file_store/shared/logs (HCDC) directory.

用途

$ ./hipchat_toolkit.run data export_log_stats
Usage:
-l <full location of hcapp.log> : log file which contains the export messages (must contain entry "Starting export of" and following)

Sample output

$ ./hipchat_toolkit.run data export_log_stats -l /var/log/hipchat/hcapp.log
...
[2017-10-24T14:35:18] [INFO] - Parsing logs for export with ID: 249ddddb-3124-4b42-9ca8-51f79b035e28
  Start timestamp: 2017-10-20T21:03:34.341134+00:00
  Finish timestamp: 2017-10-20T21:06:35.224271+00:00
  Duration: 3 minutes and 1 seconds
  Users: 5643
  Rooms: 398
  No attachment failure detected in log. 

export_archive_stats

Outputs counts of data contained in an export archive file.

Use this function after  exporting Hipchat data.

用途

$ ./hipchat_toolkit.run data export_archive_stats
Usage:
-a <absolute path to export archive file> : .tar.gz.aes file generated by the HipChat export service

Optional:
-d <absolute path to expansion directory>: the directory where the export archive will be decrypted and decompressed
If expansion directory is not specified, /file_store/shared/tmp/export_archive_stats will be used.

Sample output

$ ./hipchat_toolkit.run data export_archive_stats -a /home/admin/hipchat-2017-10-24_15-38-21.tar.gz.aes
[2017-10-24T19:45:00] [INFO] - Counting complete
  Users: 5643
  Rooms: 398 (26 archived)
  Room messages: 269591 (60 GuestAccessMessages)
  1-1 messages: 0
  Room attachments: 	0 (0.0B)
  1-1 attachments: 0 (0)
[2017-10-24T19:45:00] [INFO] - Cleaning up working directory. 

Output notes

The number of archived rooms and GuestAccessMessages both factor into the total number of messages that will be imported. At this stage, these numbers are not an indication of success or failure.

import_log_stats

Outputs statistics from a Hipchat Server/DC import process.

Use this function after importing Hipchat data. Please note that HCS/HCDC has an automatic log rotation mechanism, so the correct log file may be zipped in the /var/log/hipchat (HCS) or /file_store/shared/logs (HCDC) directory.

用途

$ ./hipchat_toolkit.run data import_log_stats
Usage:
-l <full location of hcapp.log> : log file which contains the import messages (must contain entry "Starting import job" and following)

Sample output

$ ./hipchat_toolkit.run data import_log_stats -l /var/log/hipchat/hcapp.log
...
[2017-10-24T19:39:16] [INFO] - Parsing logs for import with ID: e949d7c0-6cdf-4fff-aac7-b9cb3b505d11
  Start timestamp: 2017-10-24T18:46:42.880169+00:00
  Finish timestamp: 2017-10-24T19:24:31.605364+00:00
  Duration: 37 minutes and 49 seconds
  Users: 5643 (1 on server before import)
  Rooms: 398
  Room import errors:
  Failed messages: 16
  Failed attachments: 0

Output notes

If an unacceptably high number of messages fail during an import, please reach out to support. Please be sure to include the versions of HCS/HCDC involved in the export and import, in addition to the following log files from each server involved in the export/import:

  • /var/log/hipchat/runtime.log
  • /var/log/hipchat/hcapp.log
  • /var/log/hipchat/coral.log

This will allow for a quicker start on troubleshooting the issue.

database_stats

Outputs counts of data contained in a HCDC database.

Use this function after importing Hipchat data into Hipchat Data Center.

用途

$ ./hipchat_toolkit.run data database_stats

Sample output

$ ./hipchat_toolkit.run data database_stats
...
[2017-10-24T19:48:28] [INFO] - Tallying values
  Users: 5643
  Rooms: 399 (12 archived)
  Room messages: 269586
  1-1 messages: 0
  Room attachments: 1054
  1-1 attachments: 0

Output notes

When exporting and importing data between HCS/HCDC environments, the number of room messages in the database will not directly match the number in the export archive file based on the following factors:

  • GuestAccessMessages in the archive file will fail to import
  • a duplicate message will be posted for each archived room in the export archive (the duplicate message is sent to the archived room stating that the room is archived)
  • any failed messages in the import logs will not be counted in the message total

As a result, the number of room messages listed in the export archive stats can be calculated with the following equation:

export_archive_stats:room messages - export_archive_stats:GuestAccessMessages + export_archive_stats:archived rooms - import_log_stats:failed messages

また、次の内容をご確認ください。

  • The number of rooms listed may be incremented based on how many rooms that existed prior to importing an archive file.
    For example, in a freshly installed HCS/HCDC instance, there should only be one room called "Default", so there will be one more room in database_stats than in export_archive_stats.
  • Placeholders for files sent through Hipchat are created during an import whether or not they are included in an export, so there will be some number of Room and/or 1-1 attachments counted whether or not attachments are included in the export archive.
最終更新日 2018 年 11 月 2 日

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

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