Rocket.chat on heppoko blog

Rocket.Chat 移行後にアップロードファイルの URL が古いままになっている

Thu, 19 Oct 2023 00:00:00 +0900

Rocket.Chat を移行したのですが、アップロード済みファイルの URL と、サイト URL のリセット値が、移行前の古い URL のままになっていました。

概要

Rocket.Chat を移行し、ドメイン (サイトURL) が変わった
その際、Rocket.Chatを 3.10.14 から 6.2.12 にアップグレードしている
- MongoDB も 4.0 から 5.0 にアップグレード
Rocket.Chat 起動時に指定する環境変数 ROOT_URL は移行後の URL を設定済み
Rocket.Chat の管理者メニューで設定できる サイト URL も移行後の URL を設定済み

この状況で、以下の２つの不具合を確認しました。

アップロード済みのファイルの URL (ダウンロードリンク) が移行前の古い URL になっている
Rocket.Chat の管理者メニューで設定できる サイト URL について、リセットボタンを押すと移行前の古い URL がセットされる

先に結論

1. については MongoDB のデータを直接修正すれば直りました。
2. については未解決です。

MongoDB のデータを確認することにしたきっかけ

いろいろググっていく中で以下のページに辿り着きました。

https://www.ryadel.com/en/rocket-chat-change-root_url-site-url-rocketchat/

こちらの方法を試しても今回発生している不具合は直りませんでしたが、これをきっかけに MongoDB の中身を調査していくことで修正できました。

MongoDB の中身の確認方法については以下が参考になりました。

調査の過程と修正方法

Rocket.Chat と MongoDB は docker で動かしています。
なので、まず MongoDB の docker コンテナに入ります。

$ docker exec -it rocketchat-mongo bash

コンテナに入ったら MongoDB シェルを開き、rocketchat のデータベースを選択します。

# mongo
> use rocketchat

コレクションを表示してみます。

> show collections

たくさん表示されますが、ここから不具合内容に該当する箇所を推測して調査していきます。

1. アップロードファイルのダウンロードリンクについて

前述の 1. についてですが、こちらはアップロードファイルに関することなので、rocketchat_uploads の中身を表示してみました。

> db.rocketchat_uploads.find()

20件のみ表示されますが、適当なデータ一件について中身をみると以下のような感じになっていました。

{
 "_id": "27JzjqpXHxAHBzaxp",
 "name": "hoge.jpg",
 "size": 51268,
 "type": "image/jpeg",
 "rid": "MgKrXXN4XmQwtMMjgjXnWzpNvR6YrRpH4F",
 "userId": "jXnWzpNvR6YrRpH4F",
 "store": "GridFS:Uploads",
 "_updatedAt": ISODate("2023-07-26T03:58:50.233Z"),
 "instanceId": "R252ARSHBKR3RrXHY",
 "identify": {
 "format": "jpeg",
 "size": {
 "width": 495,
 "height": 700
 }
 },
 "complete": true,
 "etag": "HoMjiYj2fbb799RFK",
 "path": "/ufs/GridFS:Uploads/27JzjqpXHxAHBzaxp/%E5%90%8D%E7%A7%B0%E6%9C%AA%E8%A8%AD%E5%AE%9A%201.jpg",
 "progress": 1,
 "token": "68c8A8CAb8",
 "uploadedAt": ISODate("2023-07-26T03:58:50.852Z"),
 "uploading": false,
 "url": "http://old_domain:port/ufs/GridFS:Uploads/27JzjqpXHxAHBzaxp/%E5%90%8D%E7%A7%B0%E6%9C%AA%E8%A8%AD%E5%AE%9A%201.jpg",
 "typeGroup": "image"
}

見てわかる通り、url のフィールドにファイルへの絶対パスが記録されているため、これを修正しないと直らないんじゃないかと思いました。

というわけで、以下のコマンドでドメインの部分のみを置換します。

db.rocketchat_uploads.find().forEach(function(row) {
 row.url = row.url.replace(new RegExp("old_domain", 'g'), "new_domain");
 db.rocketchat_uploads.save(row);
});

これで Rocket.Chat のほうを確認すると、URL が直っていました。

2. サイト URL` のリセット値について

次に前述の 2. についてですが、設定に関することなので rocketchat_settings を確認してみました。こちらはついては中身を全てを見たかったので、以下のようにして json ファイルに出力して確認しました。

$ mongoexport -d rocketchat -c rocketchat_settings -o rocketchat_settings.json --type=json mongodb://localhost:27017

で、中身を確認してみましたが、それらしい設定は見当たりませんでした。
他のコレクションもいろいろ確認してみましたが、それらしい設定は見つかっていません。

というわけで未解決ですが、特に実害はないので放っておいてます。

参考 URL

Rocket.Chat のアップグレード手順

Wed, 11 Oct 2023 00:00:00 +0900

アップグレード手順については以下に記載されています。

https://docs.rocket.chat/deploy/deploy-rocket.chat/updating-rocket.chat

アップグレードのフローが以下になります。

https://whimsical.com/upgrade-version-path-rocket-chat-51eoS7aUunTan5wLt2CBHU

これに従ってアップデートしますが、いくつかはまったポイントがありました。

環境

アップグレード前のバージョンは以下です。

Rocket.Chat Version: 3.10.4
NodeJS Version: 12.18.4 - x64
MongoDB Version: 4.0.28
MongoDB Engine: wiredTiger
Platform: linux

Rocket.Chat も MongoDB も docker で動かしています。

Rocket.Chat 3.18.7 へのアップグレード

現在のバージョンが 3.10.4 なので、3系の最新の 3.18.7 にアップグレードしました。
すると、データベースバージョンのエラーが表示されたました。

+----------------------------------------------------------------------+
| |
| ERROR! SERVER STOPPED |
| |
| Your database migration failed: |
| Start date cannot be later than expire date |
| |
| Please make sure you are running the latest version and try again. |
| If the problem persists, please contact support. |
| |
| This Rocket.Chat version: 3.18.7 |
| Database locked at version: 213 |
| Database target version: 232 |
| |
| Commit: 660c9f5e896982932e1d02d35ddd6013c6b03e11 |
| Date: Mon May 30 19:06:57 2022 -0300 |
| Branch: HEAD |
| Tag: 3.18.7 |
| |
+----------------------------------------------------------------------+

対策は以下に書いてありました。

https://martinschoeler.github.io/docs/administrator-guides/database-migration/

MongoDB のコンテナに入り、以下のコマンドを実行してバージョンを強制的に一つ上げます。

# mongo
> use rocketchat
> db.migrations.update({_id: 'control'},{$set:{locked:false,version:231}})

これで Rocket.Chat を再起動すれば OK でした。

Rocket.Chat 3.18.7 から 4.8.7 へのアップグレード

次に4系の最新の 4.8.7 にアップグレードしました。
これはすんなりいきました。

MongoDB のアップグレード

上記のフローによれば、Rocket.Chat を5系にアップグレードする前に、MongoDB を 5.0 以上までアップグレードする必要があります。
方法については以下に記載されています。

https://docs.growi.org/ja/admin-guide/admin-cookbook/upgrade-mongodb.html

MongoDB 4.0 から 4.2 へのアップグレード

現在のバージョンが 4.0 なので、まずは 4.2 にアップグレードしました。これはすんなりいきました。

MongoDB 4.2 から 4.4 へのアップグレード

次に 4.4 にアップグレードしたところ、以下のようなエラーとなりました。

{"t":{"$date":"2023-10-13T00:38:13.842+00:00"},"s":"W", "c":"STORAGE", "id":22347, "ctx":"initandlisten","msg":"Failed to start up WiredTiger under any compatibility version. This may be due to an unsupported upgrade or downgrade."}
{"t":{"$date":"2023-10-13T00:38:13.842+00:00"},"s":"F", "c":"STORAGE", "id":28595, "ctx":"initandlisten","msg":"Terminating.","attr":{"reason":"95: Operation not supported"}}
{"t":{"$date":"2023-10-13T00:38:13.842+00:00"},"s":"F", "c":"-", "id":23091, "ctx":"initandlisten","msg":"Fatal assertion","attr":{"msgid":28595,"file":"src/mongo/db/storage/wiredtiger/wiredtiger_kv_engine.cpp","line":958}}
{"t":{"$date":"2023-10-13T00:38:13.843+00:00"},"s":"F", "c":"-", "id":23092, "ctx":"initandlisten","msg":"\n\n***aborting after fassert() failure\n\n"}

MongoDB を 4.2 に戻してコンテナに入り、以下のコマンドを実行します。

# mongo
> db.adminCommand( { setFeatureCompatibilityVersion: "4.2" } )

これで Rocket.Chat を再起動すれば OK でした。

MongoDB 4.4 から 5.0 へのアップグレード

次に 5.0 にアップグレードしたところ、同様のエラーとなりました。
MongoDB を 4.4 に戻してコンテナに入り、以下のコマンドを実行します。

# mongo
> db.adminCommand( { setFeatureCompatibilityVersion: "4.4" } )

これで Rocket.Chat を再起動すれば OK でした。

Rocket.Chat 4.8.7 から 5.4.10 へのアップグレード

MongoDB を 5.0 までアップグレードしたので、次は Rocket.Chat を5系の最新の 5.4.10 にアップグレードしました。
すると以下のエラーが表示されました。

/app/bundle/programs/server/node_modules/fibers/future.js:313
 throw(ex);
 ^

MongoServerSelectionError: connect ECONNREFUSED 127.0.0.1:27017
 at Timeout._onTimeout (/app/bundle/programs/server/npm/node_modules/meteor/npm-mongo/node_modules/mongodb/lib/sdam/topology.js:312:38)
 at listOnTimeout (internal/timers.js:557:17)
 at processTimers (internal/timers.js:500:7) {
 reason: TopologyDescription {
 type: 'ReplicaSetNoPrimary',
 servers: Map(1) {
 'localhost:27017' => ServerDescription {
 _hostAddress: HostAddress { isIPv6: false, host: 'localhost', port: 27017 },
 address: 'localhost:27017',
 type: 'Unknown',
 hosts: [],
 passives: [],
 arbiters: [],
 tags: {},
 minWireVersion: 0,
 maxWireVersion: 0,
 roundTripTime: -1,
 lastUpdateTime: 17764280,
 lastWriteDate: 0,
 error: MongoNetworkError: connect ECONNREFUSED 127.0.0.1:27017
 at connectionFailureError (/app/bundle/programs/server/npm/node_modules/meteor/npm-mongo/node_modules/mongodb/lib/cmap/connect.js:381:20)
 at Socket.<anonymous> (/app/bundle/programs/server/npm/node_modules/meteor/npm-mongo/node_modules/mongodb/lib/cmap/connect.js:301:22)
 at Object.onceWrapper (events.js:520:26)
 at Socket.emit (events.js:400:28)
 at emitErrorNT (internal/streams/destroy.js:106:8)
 at emitErrorCloseNT (internal/streams/destroy.js:74:3)
 at processTicksAndRejections (internal/process/task_queues.js:82:21)
 }
 },
 stale: false,
 compatible: true,
 heartbeatFrequencyMS: 10000,
 localThresholdMS: 15,
 setName: 'rs0',
 maxSetVersion: 2,
 maxElectionId: ObjectId {
 [Symbol(id)]: Buffer(12) [Uint8Array] [
 127, 255, 255, 255, 0,
 0, 0, 0, 0, 0,
 0, 10
 ]
 },
 commonWireVersion: 13,
 logicalSessionTimeoutMinutes: undefined
 }
}

解決策は以下にありました。

https://github.com/RocketChat/Rocket.Chat/releases/tag/5.0.0

環境変数 MONGO_URL MONGO_OPLOG_URL に directConnection=true を追加します。
例えば、MONGO_URL=mongodb://mongo/rocketchat?replicaSet=rs0&directConnection=true のような感じです。

これで Rocket.Chat を再起動すれば OK でした。

Rocket.Chat を最新にアップデート

最後に、Rocket.Chat を現在の最新バージョンである 6.3.9 にアップグレードしました。以上で完了です。

Grafana から Rocket.Chat へ通知を行う

Tue, 13 Dec 2022 00:00:00 +0900

Grafana 自体は Rocket.Chat に対応していませんが、Webhook を使うことで Rocket.Chat に通知できます。
アラートの基本的な設定方法については以下を参照してください。

Grafana でアラートを設定する

ここでは Rocket.Chat への通知の設定のみ記載します。

Rocket.Chat 側の設定

管理画面のメニューから サービス連携 を選択し、Incoming で新規作成を行います。
スクリプトを有効にし、以下のスクリプトを記入します。


class Script {

 process_incoming_request({ request }) {
 let color = "#00FF00"; // green
 switch(request.content.state) {
 case 'ok':
 color = '#00FF00';
 break;
 case 'paused':
 color = '#666666';
 break;
 case 'alerting':
 color = '#FF0000';
 break;
 case 'pending':
 color = '#CCCCCC';
 break;
 case 'no_data':
 color = '#333333';
 break;
 default:
 color = '#666666';
 }
 return {
 content:{
 text: request.content.title,
 "attachments": [{
 "color": color,
 "title": request.content.title,
 "title_link": request.content.ruleUrl,
 "text": request.content.message,
 "image_url": request.content.imageUrl,
 }]
 }
 };
 }
}

その他、投稿先チャンネルや投稿ユーザーなどの基本的な設定を行います。
Grafana の設定で Webhook URL が必要になるのでコピーしておきます。

Grafana 側の設定

Grafana のサイドメニューから Alert rules を選択し、Contact Points で以下の設定を行います。

New contact point をクリック
Name にはわかりやすい名前を適当に入力する
Contact point type で Webhook を選択する
Webhook URL に上記で取得した URL を入力する

Rocket.Chat に関する設定は以上で完了です。

参考 URL

https://gist.github.com/ATofighi/79895715ae0a8f5bdeff058a64012275