アドオン記事テンプレート
最終更新日 2022年08月22日(月)
This article is a work in progress, or documents a feature that is not yet released to all users. This article is unlisted. Only those with the link can access it.
ADDON-NAME は、機能 X を提供するためのアドオンです。
機能 X をアプリケーションに追加すると、X、Y、および Z の利点が得られます。
ADDON-NAME には、アドオンの API を経由して、またはアドオンの [[Java|Ruby|Python|Node.js|Clojure|Scala|PHP|Go]]* 用クライアントライブラリを経由してアクセスします。
アドオンのプロビジョニング
次のようにして、CLI 経由で ADDON-NAME を Heroku アプリケーションにアタッチします。
利用可能なプランおよび地域の一覧については、(アドオン名) の要素に関するページを参照してください。
$ heroku addons:create ADDON-SLUG
Creating ADDON-SLUG on example-app... free
Your add-on has been provisioned successfully
ADDON-NAME をプロビジョニングした後、アタッチされたアプリの設定で ADDON-CONFIG-NAME 環境設定を使用できます。これは、[[“新しくプロビジョニングされた ADDON-NAME サービスインスタンスへのアクセスに使用される正規の URL” のような変数の目的]] を設定します。環境設定は heroku config:get コマンドで確認できます。
$ heroku config:get ADDON-CONFIG-NAME
http://user:pass@instance.ip/resourceid
ADDON-NAME をインストールした後、アプリケーションはアドオンと統合するように完全に設定されます。
ローカルの設定
環境設定
[[開発中にアドオンサービスを扱うことに該当しない場合は、このセクションを省略します。]]
アドオンをプロビジョニングした後、サービスを必要とする開発環境用に、アドオンの環境設定をローカルに複製します。
local Heroku CLI コマンドを使用して、アプリの Procfile で指定されたプロセスタイプを設定、実行、および管理します。Heroku Local は、.env ファイルから環境設定を読み取ります。ターミナルでアプリの環境設定を表示するには、heroku config を使用します。環境設定をローカルの .env ファイルに追加するには、次のコマンドを使用します。
$ heroku config:get ADDON-CONFIG-NAME -s >> .env
認証情報やその他の機密性が高い環境設定をソース管理にコミットしないでください。Git では、echo .env >> .gitignore を使用して .env ファイルを除外してください。
詳細は、Heroku Local の記事を参照してください。
サービスの設定
[[必要なローカル実行可能ファイル (Memcache アドオンの場合など) がある場合は、インストールの手順を含めます。ない場合は、セクション全体を省略します。]]
ローカル開発環境で使用するために ADDON-NAME をインストールできます。このプロセスでは通常、[[ソフトウェアをインストールし | サービスの別バージョンを作成し]]、ADDON-CONFIG-NAME をこの[[ローカル | リモート]]のサービスに設定します。
| プラットフォーム | インストールに使用するコード |
|---|---|
| macOS | brew install X |
| Windows | インストーラーへのリンク |
| Ubuntu Linux | apt-get install X |
| その他 | いくつかの生パッケージへのリンク |
言語固有の統合
Ruby on Rails
[[これを繰り返します ###Java、Node.js、Python、Scala、Play!、Grails、Clojure など、他のすべてのサポートされている言語およびフレームワーク向けの Rails セクション。Heroku は多言語プラットフォームです - 単一言語のサポートに閉じこもらないでください。]]
以下を Gemfile に追加して、ADDON-NAME クライアントライブラリを指定します。
gem 'ADDON-SLUG'
バンドラーでアプリケーションの依存関係を更新します。
$ bundle install
[[Rails のサービスを使用し、コードサンプルと統合する方法を簡単に説明します]]
Python/Django
[[Rails セクションの構造を繰り返します]]
Java、Node….
[[サポートされている言語ごとに Rails セクションの構造を繰り返します]]
モニタリングとログ記録
CLI を使用して ADDON-NAME の統計と現在の状態を表示します。
$ heroku ADDON-SLUG:command
example output
次の方法で Heroku ログストリーム内の ADDON-NAME アクティビティを監視します。[[アドオンのログ記録の認識がある場合は説明します]]
$ heroku logs -t | grep 'ADDON-SLUG pattern'
ダッシュボード
ADDON-NAME ダッシュボード内で使用できる機能についての詳細は、mysite.com/docs のドキュメントを参照してください。
ADDON-NAME ダッシュボードは [[ダッシュボードの機能を説明します]] を提供します。
CLI 経由でダッシュボードにアクセスします。
$ heroku addons:open ADDON-SLUG
Opening ADDON-SLUG for sharp-mountain-4005
または、Heroku Dashboard にアクセスして、問題のアプリケーションを選択します。Add-ons メニューから ADDON-NAME を選択します。
トラブルシューティング
[[機能 X]] が [[一般的な問題 Y]] であると思われない場合は、[[一般的な問題 Y の症状を探すための特定のコマンドを追加します]]。
プラン間の移行
アプリケーションの所有者は、移行プロセス中にアプリケーションが適切に機能するように、移行のタイミングを注意深く管理する必要があります。
[[特定の移行プロセスまたは移行のお役立ち情報。]]
新しいプランに移行するには、heroku addons:upgrade コマンドを使用します。
$ heroku addons:upgrade ADDON-SLUG:newplan
-----> Upgrading ADDON-SLUG:newplan to example-app.. done, v18 ($49/mo)
Your plan has been updated to: ADDON-SLUG:newplan
アドオンの削除
CLI を使用して ADDON-NAME を削除します。
この操作により、すべての関連データが破棄され、元に戻すことはできません。
$ heroku addons:destroy ADDON-SLUG
-----> Removing ADDON-SLUG from example-app... done, v20 (free)
ADDON-NAME を削除する前に、[[エクスポートが可能な場合は手順を説明します]] によってそのデータをエクスポートします。
サポート
ADDON-NAME のサポートとランタイムの問題はすべて、いずれかの Heroku サポートチャネル経由で送信してください。サポートに関連しない問題や製品のフィードバックは [[お客様のチャネル]] までお気軽にお寄せください。