Skip to content

README.ja.md

Latest commit

 

History

History
112 lines (79 loc) · 9.35 KB

README.ja.md

File metadata and controls

112 lines (79 loc) · 9.35 KB
Raw

English · 简⁠体⁠中⁠文 · 繁⁠體⁠中⁠文 · 日⁠本⁠語 · 한⁠국⁠어 · Español · Français · Deutsch · Português · Italiano · Русский · हिन्दी · فارسی · Nederlands · Dansk · Svenska · Norsk

OneUptime

License Release

OneUptime はオープンソースのオブザーバビリティプラットフォームです。ウェブサイト、API、サーバーが動いていることを確認し、アプリが送るログ、メトリクス、トレースを集め、何かが壊れたときはオンコール担当者を呼び出し、ステータスページで顧客に知らせます。これらはすべて 1 つの製品の中で行われるため、問題に気づいたツールがそのままチームを呼び出します。

OneUptime Cloud で使うことも、自分のサーバーで動かすこともできます。

インシデント中の OneUptime: タイムライン、オンコール担当者、ステータスページ、OneUptime AI の調査

できること

  • モニタリング: ウェブサイト、API、ポート、DNS、証明書を、世界中のプローブや自社ネットワークの内側からチェックします。サーバー、Kubernetes、Docker、VMware、データベース、ネットワーク機器も見守ります。
  • インシデントとオンコール: 各インシデントを 1 つのタイムラインで扱います。オンコール担当者を電話、SMS、メール、プッシュ通知、Slack、Microsoft Teams で呼び出し、誰かが応答するまでエスカレーションします。
  • ステータスページ: 公開または非公開のステータスページで顧客に状況を伝え、予定メンテナンスもそこで告知します。
  • ログ、メトリクス、トレース: OpenTelemetry で送信し、検索し、ダッシュボードを作れます。例外、プロファイル、リアルユーザーモニタリング、セキュリティイベントも同じ場所にあります。
  • ワークフローと Runbook: 定型作業を自動化し、Jira、ServiceNow など、チームがすでに使っているツールと接続します。
  • OneUptime AI: 新しいインシデントやアラートを調査し、出典付きの根本原因分析を投稿します。修正をオンにすると、チームがレビューする修正のプルリクエストを開くこともできます。
  • API、CLI、Terraform: スクリプトや CI から OneUptime を自動化し、モニター、ステータスページ、オンコールをコードとして管理します。

そのほかのことはすべてドキュメントにあります。

使い始める

OneUptime Cloud

サインアップしてプロジェクトを作成します。無料プランにクレジットカードは不要です。

Docker Compose でセルフホストする

8 GB 以上のメモリを持つ Linux サーバーと、Docker、Docker Compose、Git、Node.js が必要です。

手順 3 の前に、config.env の HOST に OneUptime へのアクセスに使うドメイン名または IP アドレスを http:// なしで設定します。localhost のままにするのは、自分のコンピューターで OneUptime を試す場合だけにしてください。

# 1. Clone the release branch
git clone --depth 1 --single-branch --branch release https://github.com/OneUptime/oneuptime.git
cd oneuptime

# 2. Create your config
cp config.example.env config.env

# 3. Start everything
npm start

npm start はサーバーを確認し、config.env のすべてのシークレットにそれぞれランダムな値を設定して、OneUptime を起動します。npm start が OneUptime is up! と表示したら、http://localhost またはサーバーのアドレスを開いてサインアップします。最初のアカウントがインスタンスの管理者になります。

サーバーのサイズ、HTTPS、バックアップ、更新については Docker Compose ガイドを参照してください。

Helm で Kubernetes にインストールする

大規模な本番環境や高可用性が必要なら、Helm チャートをインストールします。host には、OneUptime にアクセスするときに使うドメイン名または IP アドレスを指定します。

helm repo add oneuptime https://helm-chart.oneuptime.com/
helm install my-oneuptime oneuptime/oneuptime --set host=oneuptime.example.com

ストレージ、HTTPS、データベース、アップグレードについてはチャートの README を参照してください。

Community と Enterprise

  • Community Edition: 無料のオープンソースで、ここまでに挙げたすべてと、SAML と OIDC のシングルサインオンを含みます。
  • Enterprise Edition: SCIM プロビジョニング、監査ログ、チームコンプライアンス、インスタンスヘルスダッシュボードと優先サポートを追加します。本番環境で使うにはライセンスが必要です。詳しくは営業にお問い合わせください。

2 つのエディションの比較はドキュメントにあります。

サポート

コントリビュート

バグ修正、機能、ドキュメント、テストのどれも歓迎します。ソースから OneUptime を動かす方法はローカル開発ガイドに、プルリクエストとライセンスの仕組みはコントリビューションガイドラインにあります。最初の一歩には good first issue ラベルの付いた Issue がおすすめです。

OneUptime が役に立ったら、このリポジトリにスターを付けるか、プロジェクトをスポンサーしてください。

ライセンス

OneUptime は Apache License 2.0 のもとで公開されているオープンソースです。ただし ee/ ディレクトリは例外です。このディレクトリには Enterprise Edition が含まれ、OneUptime Enterprise License のもとでライセンスされています。Community Edition のイメージには ee/ のコードは一切含まれません。この区分は、リポジトリのルートにある LICENSE ファイルに定められています。