「MongoDB」の版間の差分

提供: ArchWiki
ナビゲーションに移動 検索に移動
(mongodb-bin への言及と mongodb パッケージの注意点を追加)
 
(2人の利用者による、間の15版が非表示)
6行目: 6行目:
 
== インストール ==
 
== インストール ==
   
  +
MongoDB は再ライセンス上の問題により[[公式リポジトリ]]から削除されました [https://lists.archlinux.org/pipermail/arch-dev-public/2019-January/029430.html]。
{{Warning|事前に {{AUR|mongodb}} パッケージのコメントを確認することを推奨します。}}
 
{{AUR|mongodb}} あるいは {{AUR|mongodb-bin}} パッケージをインストールしてください。また、{{AUR|mongodb-tools}} か {{AUR|mongodb-tools-bin}} をインストールすることで {{ic|mongoimport}}, {{ic|mongoexport}}, {{ic|mongodump}}, {{ic|mongorestore}} などのツールを使うことができます。
 
   
  +
[[PKGBUILD]] が [[AUR]] で提供されています:
{{Note|{{AUR|mongodb}} パッケージを [[AUR ヘルパー]] や [[makepkg]] を使いインストールするには 260GB 以上の空き容量が、{{Pkg|devtools}} を使ったインストールには 20GB 程度の空き容量が必要です。}}
 
   
  +
*{{AUR|mongodb}} - ソースコードからビルドします。180GB 以上のディスク空き領域が必要で、おそらくビルドに数時間かかります。(例: Intel i7 で6.5時間、ハイエンドの NVMe と 32 Xeon cores で1時間。)
{{ic|mongodb.service}} デーモンを[[systemd#ユニットを使う|起動・有効化]]します。
 
  +
*{{AUR|mongodb-bin}} - ビルド済みの MongoDB バイナリを[https://repo.mongodb.org/apt/ubuntu/ 公式 MongoDB Ubuntu リポジトリ]から抽出します。ビルドに使用されたコンパイラオプションは不明です。
   
  +
選んだメインの [[PKGBUILD]] に対応する、[[AUR]] にある [[PKGBUILD]] を使ってツール({{ic|mongoimport}}、{{ic|mongoexport}}、{{ic|mongodump}}、{{ic|mongorestore}} など) を[[インストール]]してください:
mongodb サービスの最初の起動時に、巨大なファイルが作成され、(ジャーナルなどのデータのための) 予約領域が割り当てられます [https://docs.mongodb.com/manual/faq/storage/#preallocated-data-files]。ファイルの作成には時間がかかり、その間、データベースシェルを使うことはできません。
 
  +
  +
* {{AUR|mongodb-tools}}
  +
* {{AUR|mongodb-tools-bin}}
  +
* {{AUR|mongosh-bin}}
   
 
== 使用方法 ==
 
== 使用方法 ==
  +
  +
{{ic|mongodb.service}} デーモンを[[systemd#ユニットを使う|起動・有効化]]します。
  +
  +
{{Note|mongodb サービスは初回起動時に大きいファイルを作成することにより[https://docs.mongodb.com/manual/faq/storage/#preallocated-data-files 領域を事前に確保します](ジャーナルや他のデータ用)。この処理には時間が掛かり、その間、MongoDB シェルは使用不能となります。}}
   
 
データベースシェルにアクセスするには、ターミナルに以下を入力:
 
データベースシェルにアクセスするには、ターミナルに以下を入力:
   
 
$ mongo
 
$ mongo
  +
  +
または、認証設定がなされている場合:
  +
  +
$ mongo -u ''userName''
  +
  +
== 設定 ==
  +
  +
=== ファイルのフォーマット ===
  +
  +
MongoDB は 設定ファイルに YAML ベースのフォーマットを使用します。利用可能な設定オプションについては https://docs.mongodb.com/manual/reference/configuration-options/ を見てください。
  +
  +
{{hc|/etc/mongodb.conf|2=
  +
systemLog:
  +
destination: file
  +
path: "/var/log/mongodb/mongod.log"
  +
logAppend: true
  +
storage:
  +
journal:
  +
enabled: true
  +
processManagement:
  +
fork: true
  +
net:
  +
bindIp: 127.0.0.1
  +
port: 27017
  +
setParameter:
  +
enableLocalhostAuthBypass: false
  +
..
  +
}}
  +
  +
  +
=== 認証を要求する ===
  +
  +
{{warning|デフォルトでは MongoDB は認証を要求しません。MongoDB はデフォルトで localhost のインターフェイスのみをリッスンしますが、これでもローカルなユーザは認証せずに接続でき、データベースを晒すことになるかもしれません。望ましくないアクセスを防ぐためにアクセス制御を有効化することをおすすめします。}}
  +
  +
管理者のアクセス権を持つ MongoDB のユーザアカウントを作るには[https://docs.mongodb.com/manual/tutorial/enable-authentication/]:
  +
  +
{{hc|$ mongosh|
  +
use admin
  +
db.createUser(
  +
{
  +
user: "myUserAdmin",
  +
pwd: "abc123",
  +
roles: [ { role: "userAdminAnyDatabase", db: "admin" }, "readWriteAnyDatabase" ]
  +
}
  +
)}}
  +
  +
以下を {{ic|/etc/mongodb.conf}} に[[追加]]してください:
  +
  +
{{hc|/etc/mongodb.conf|
  +
security:
  +
authorization: "enabled"
  +
}}
  +
  +
{{ic|mongodb.service}} を[[再起動]]してください。
  +
  +
=== NUMA ===
  +
  +
MongoDB を Non-Uniform Access Memory (NUMA) で実行するとパフォーマンスに大きな影響を与えることがあります。[https://docs.mongodb.com/manual/administration/production-notes/#mongodb-and-numa-hardware]
  +
  +
システムが NUMA を使用しているかどうかを確認するには:
  +
  +
# dmesg | grep -i numa
  +
  +
また、NUMA が使用中で MongoDB が {{ic|numactl}} を通して起動されていない場合、{{ic|/var/log/mongodb/mongod.log}} に警告が残ります。({{ic|mongo}} シェルもこの警告を表示しますが、認証を有効化していない場合に限ります。)
  +
  +
システムが NUMA を使用している場合、パフォーマンスを向上させるためには MongoDB を {{ic|numactl}} を通して起動させる必要があります。
  +
  +
インストールしたパッケージに合わせて {{ic|mongodb.service}} を[[編集]]してください。
  +
  +
{{aur|mongodb}} を使用している場合、
  +
  +
ExecStart=/usr/bin/mongod $OPTIONS
  +
  +
から
  +
  +
ExecStart='''/usr/bin/numactl --interleave=all''' /usr/bin/mongod $OPTIONS
  +
  +
のように変更してください。
  +
{{aur|mongodb-bin}} を使用している場合、
  +
  +
ExecStart=/usr/bin/mongod --quiet --config /etc/mongodb.conf
  +
  +
から
  +
  +
ExecStart='''/usr/bin/numactl --interleave=all''' /usr/bin/mongod --quiet --config /etc/mongodb.conf
  +
  +
のように変更してください。
  +
ゾーンの回収も無効化する必要がありますが、arch では {{ic|/proc/sys/vm/zone_reclaim_mode}} はデフォルトで {{ic|0}} となっています。
  +
  +
必要に応じて {{ic|mongodb.service}} を[[Systemd#ユニットを使う|再有効化]]・[[再起動]]してください。
  +
  +
=== 完全な開始/停止 ===
  +
  +
デフォルトでは、[[systemd]] は、サービスに開始/停止を要求して90秒経ってもその要求を完了しない場合、そのサービスを即座に kill します。
  +
  +
{{aur|mongodb}} は MongoDB の起動が完了するまで [[systemd]] を待たせますが、{{aur|mongodb-bin}} はそのようなことをしません。両パッケージは、MongoDB に停止を要求して90秒以内にそれを完了しなかった場合、MongoDB を kill することを [[systemd]] に許可しています。
  +
  +
巨大な MongoDB データベースは、特にスワップが使用されている場合に、完全にシャットダウンするのに相当の時間がかかる可能性があります。(最上位機種の NVMe と 64GB の RAM、16 GB のスワップの環境でのアクティブな 450 GB のデータベースはシャットダウンするのに1時間かかる可能性があります。)
  +
  +
デフォルトでは、MongoDB はジャーナリングを使用します。[https://docs.mongodb.com/manual/reference/configuration-options/#storage-options] ジャーナリングを使用している場合、不完全なシャットダウンでデータが消失するリスクは無いはずです。しかし、シャットダウンが不完全だった場合、巨大な MongoDB データベースは起動し直すのに相当の時間がかかる可能性があります。この場合、完全なシャットダウンを要求するかどうかの選択は、遅いシャットダウンか遅い起動のどちらか一方を選ぶということになります。[https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/mongodb-user/KjBU_GcNcmw/gR2UxRIFAgAJ]
  +
  +
{{warning|ジャーナリングを無効化した場合、完全なシャットダウンを要求しないとデータが損失する危険性が高いので、完全なシャットダウンを要求する必要があります。[https://docs.mongodb.com/manual/tutorial/recover-data-following-unexpected-shutdown/]}}
  +
  +
90秒経っても [[systemd]] が MongoDB を kill しないようにするには、{{ic|mongodb.service}} を[[編集]]してください。
  +
  +
MongoDB が完全にシャットダウンできるようにするには、{{ic|[Service]}} セクションに以下を[[追加]]してください(巨大なデータベースでは、これによりシステムのシャットダウンが大幅に遅くなることがありますが、次回の起動は早くなります。):
  +
  +
TimeoutStopSec=infinity
  +
  +
MongoDB が起動し直すのに長い時間が必要になる場合、[[systemd]] が90秒ごとに MongoDB を kill して再起動させるのは大きな問題となる可能性があります [https://jira.mongodb.org/browse/SERVER-38086]。なので、{{aur|mongodb}} はそうならないようにします。{{aur|mongodb-bin}} を使用している場合、MongoDB が起動するまで [[systemd]] を待たせるには、{{ic|[Service]}} セクションに以下を[[追加]]してください:
  +
  +
TimeoutStartSec=infinity
   
 
== トラブルシューティング ==
 
== トラブルシューティング ==
72行目: 192行目:
 
# echo never > /sys/kernel/mm/transparent_hugepage/enabled
 
# echo never > /sys/kernel/mm/transparent_hugepage/enabled
 
# echo never > /sys/kernel/mm/transparent_hugepage/defrag
 
# echo never > /sys/kernel/mm/transparent_hugepage/defrag
  +
  +
=== Warning about Soft rlimits too low ===
  +
  +
If you are using systemd service, then edit the unit file by {{ic|systemctl edit mongodb.service}}:
  +
  +
[Service]
  +
# Other directives omitted
  +
# (file size)
  +
LimitFSIZE=infinity
  +
# (cpu time)
  +
LimitCPU=infinity
  +
# (virtual memory size)
  +
LimitAS=infinity
  +
# (locked-in-memory size)
  +
LimitMEMLOCK=infinity
  +
# (open files)
  +
LimitNOFILE=64000
  +
# (processes/threads)
  +
LimitNPROC=64000
  +
  +
See following link for further details: [https://docs.mongodb.com/manual/reference/ulimit/#review-and-set-resource-limits Further reference]

2022年5月4日 (水) 13:34時点における最新版

MongoDB (由来は humongous から) はオープンソースのドキュメント指向データベースです。MongoDB Inc. (旧 10gen) によって開発・サポートされています。MongoDB はデータベースシステムの NoSQL ファミリーの一員です。"古典的"なリレーショナルデータベースでそうあるように、データをテーブルに保存する代わりに、MongoDB は動的なスキーマ (MongoDB では BSON と呼称されるフォーマット) によって JSON ライクなドキュメントとして構造的データを保存して、特定のタイプのアプリケーションでデータを簡単かつ高速に扱えるようにします。

インストール

MongoDB は再ライセンス上の問題により公式リポジトリから削除されました [1]

PKGBUILDAUR で提供されています:

  • mongodbAUR - ソースコードからビルドします。180GB 以上のディスク空き領域が必要で、おそらくビルドに数時間かかります。(例: Intel i7 で6.5時間、ハイエンドの NVMe と 32 Xeon cores で1時間。)
  • mongodb-binAUR - ビルド済みの MongoDB バイナリを公式 MongoDB Ubuntu リポジトリから抽出します。ビルドに使用されたコンパイラオプションは不明です。

選んだメインの PKGBUILD に対応する、AUR にある PKGBUILD を使ってツール(mongoimportmongoexportmongodumpmongorestore など) をインストールしてください:

使用方法

mongodb.service デーモンを起動・有効化します。

ノート: mongodb サービスは初回起動時に大きいファイルを作成することにより領域を事前に確保します(ジャーナルや他のデータ用)。この処理には時間が掛かり、その間、MongoDB シェルは使用不能となります。

データベースシェルにアクセスするには、ターミナルに以下を入力:

$ mongo

または、認証設定がなされている場合:

$ mongo -u userName

設定

ファイルのフォーマット

MongoDB は 設定ファイルに YAML ベースのフォーマットを使用します。利用可能な設定オプションについては https://docs.mongodb.com/manual/reference/configuration-options/ を見てください。

/etc/mongodb.conf
systemLog:
   destination: file
   path: "/var/log/mongodb/mongod.log"
   logAppend: true
storage:
   journal:
      enabled: true
processManagement:
   fork: true
net:
   bindIp: 127.0.0.1
   port: 27017
setParameter:
   enableLocalhostAuthBypass: false
..


認証を要求する

警告: デフォルトでは MongoDB は認証を要求しません。MongoDB はデフォルトで localhost のインターフェイスのみをリッスンしますが、これでもローカルなユーザは認証せずに接続でき、データベースを晒すことになるかもしれません。望ましくないアクセスを防ぐためにアクセス制御を有効化することをおすすめします。

管理者のアクセス権を持つ MongoDB のユーザアカウントを作るには[2]:

$ mongosh
use admin
db.createUser(
  {
    user: "myUserAdmin",
    pwd: "abc123",
    roles: [ { role: "userAdminAnyDatabase", db: "admin" }, "readWriteAnyDatabase" ]
  }
)

以下を /etc/mongodb.conf追加してください:

/etc/mongodb.conf
security:
  authorization: "enabled"

mongodb.service再起動してください。

NUMA

MongoDB を Non-Uniform Access Memory (NUMA) で実行するとパフォーマンスに大きな影響を与えることがあります。[3]

システムが NUMA を使用しているかどうかを確認するには:

# dmesg | grep -i numa

また、NUMA が使用中で MongoDB が numactl を通して起動されていない場合、/var/log/mongodb/mongod.log に警告が残ります。(mongo シェルもこの警告を表示しますが、認証を有効化していない場合に限ります。)

システムが NUMA を使用している場合、パフォーマンスを向上させるためには MongoDB を numactl を通して起動させる必要があります。

インストールしたパッケージに合わせて mongodb.service編集してください。

mongodbAUR を使用している場合、

ExecStart=/usr/bin/mongod $OPTIONS

から

ExecStart=/usr/bin/numactl --interleave=all /usr/bin/mongod $OPTIONS

のように変更してください。 mongodb-binAUR を使用している場合、

ExecStart=/usr/bin/mongod --quiet --config /etc/mongodb.conf

から

ExecStart=/usr/bin/numactl --interleave=all /usr/bin/mongod --quiet --config /etc/mongodb.conf

のように変更してください。 ゾーンの回収も無効化する必要がありますが、arch では /proc/sys/vm/zone_reclaim_mode はデフォルトで 0 となっています。

必要に応じて mongodb.service再有効化再起動してください。

完全な開始/停止

デフォルトでは、systemd は、サービスに開始/停止を要求して90秒経ってもその要求を完了しない場合、そのサービスを即座に kill します。

mongodbAUR は MongoDB の起動が完了するまで systemd を待たせますが、mongodb-binAUR はそのようなことをしません。両パッケージは、MongoDB に停止を要求して90秒以内にそれを完了しなかった場合、MongoDB を kill することを systemd に許可しています。

巨大な MongoDB データベースは、特にスワップが使用されている場合に、完全にシャットダウンするのに相当の時間がかかる可能性があります。(最上位機種の NVMe と 64GB の RAM、16 GB のスワップの環境でのアクティブな 450 GB のデータベースはシャットダウンするのに1時間かかる可能性があります。)

デフォルトでは、MongoDB はジャーナリングを使用します。[4] ジャーナリングを使用している場合、不完全なシャットダウンでデータが消失するリスクは無いはずです。しかし、シャットダウンが不完全だった場合、巨大な MongoDB データベースは起動し直すのに相当の時間がかかる可能性があります。この場合、完全なシャットダウンを要求するかどうかの選択は、遅いシャットダウンか遅い起動のどちらか一方を選ぶということになります。[5]

警告: ジャーナリングを無効化した場合、完全なシャットダウンを要求しないとデータが損失する危険性が高いので、完全なシャットダウンを要求する必要があります。[6]

90秒経っても systemd が MongoDB を kill しないようにするには、mongodb.service編集してください。

MongoDB が完全にシャットダウンできるようにするには、[Service] セクションに以下を追加してください(巨大なデータベースでは、これによりシステムのシャットダウンが大幅に遅くなることがありますが、次回の起動は早くなります。):

TimeoutStopSec=infinity

MongoDB が起動し直すのに長い時間が必要になる場合、systemd が90秒ごとに MongoDB を kill して再起動させるのは大きな問題となる可能性があります [7]。なので、mongodbAUR はそうならないようにします。mongodb-binAUR を使用している場合、MongoDB が起動するまで systemd を待たせるには、[Service] セクションに以下を追加してください:

TimeoutStartSec=infinity

トラブルシューティング

MongoDB が起動しない

データベースのパスが正しく設定されているか確認してください:

$ cat /usr/lib/systemd/system/mongodb.service

"ExecStart" 行に "--dbpath /var/lib/mongodb" を追加してください:

ExecStart=/usr/bin/numactl --interleave=all mongod --quiet --config /etc/mongodb.conf --dbpath /var/lib/mongodb

最低でも (ジャーナルファイル用の) 3GB の空き容量があることを確認してください。容量が足りない場合 MongoDB が起動できないことがあります (その場合ユーザーにメッセージは表示されません):

$ df -h /var/lib/mongodb/

ロックファイルが存在しないかどうか確認:

# ls -lisa /var/lib/mongodb

ロックファイルが存在する場合、mongodb.service を停止してください。データベースのパスを指定してデータベースの修復を実行します (Arch Linux では /var/lib/mongodb/ がデフォルトの --dbpath です):

# mongod --dbpath /var/lib/mongodb/ --repair

修復が完了すると、dbpath に修復されたデータファイルと空の mongod.lock ファイルが作られます。

警告: ファイルを削除して、破損したファイルを使ってデータベースを起動して、データベースからデータの復旧を試みることもできます。ただし、データベースの状態を予想することはできません。詳しくは 上流のドキュメント を見てください。

root で修復を実行後、ファイルの所有者は root ユーザーになりますが、Arch Linux は別のユーザーで MongoDB を実行します。chown を使ってファイルの所有者を適切なユーザーに戻す必要があります (詳しくは こちら を参照):

# chown -R mongodb: /var/{log,lib}/mongodb/

mongodb の ドキュメント から設定ファイルをコピーした場合、以下の2行を削除して mongodb.service を再起動してください:

/etc/mongodb.conf
processManagement:
   fork: true

transparent_hugepage のカーネル設定について MongoDB がエラーを吐く

MongoDB の起動後、transparent_hugepage に関する警告が表示される場合、以下のファイルを編集することでシステム設定を永続的に無効化することができます (FreeDesktop tmpfiles.d マニュアル を参照):

/etc/tmpfiles.d/local.conf
w /sys/kernel/mm/transparent_hugepage/enabled - - - - never
w /sys/kernel/mm/transparent_hugepage/defrag - - - - never

sysctl を使ったり以下のように echo コマンドを使うことで一時的に無効化することもできます:

# echo never > /sys/kernel/mm/transparent_hugepage/enabled
# echo never > /sys/kernel/mm/transparent_hugepage/defrag

Warning about Soft rlimits too low

If you are using systemd service, then edit the unit file by systemctl edit mongodb.service:

[Service]
# Other directives omitted
# (file size)
LimitFSIZE=infinity
# (cpu time)
LimitCPU=infinity
# (virtual memory size)
LimitAS=infinity
# (locked-in-memory size)
LimitMEMLOCK=infinity
# (open files)
LimitNOFILE=64000
# (processes/threads)
LimitNPROC=64000

See following link for further details: Further reference