From 2cbffe101d5f92224cf24aab85ce6c6593ba5759 Mon Sep 17 00:00:00 2001 From: Msksgm Date: Tue, 28 Jan 2025 22:14:47 +0900 Subject: [PATCH 1/3] docs: translated demo/docker-deployment into ja --- content/ja/docs/demo/docker-deployment.md | 138 ++++++++++++++++++++++ hugo.yaml | 4 + 2 files changed, 142 insertions(+) create mode 100644 content/ja/docs/demo/docker-deployment.md diff --git a/content/ja/docs/demo/docker-deployment.md b/content/ja/docs/demo/docker-deployment.md new file mode 100644 index 000000000000..a7b37e3e7df9 --- /dev/null +++ b/content/ja/docs/demo/docker-deployment.md @@ -0,0 +1,138 @@ +--- +title: Docker デプロイ +linkTitle: Docker +aliases: [docker_deployment] +default_lang_commit: 24146bd1368e4c6082c7d6077efd29dba0d51055 +cSpell:ignore: otlphttp spanmetrics tracetest tracetesting +--- + + + +## 前提条件 {#prerequisites} + +- Docker +- [Docker Compose](https://docs.docker.com/compose/install/) + v2.0.0+ +- Make (オプション) +- アプリケーション用に 6 GB の RAM + +## デモの取得と実行 {#get-and-run-the-demo} + +1. デモリポジトリをクローンしてください。 + + ```shell + git clone https://github.com/open-telemetry/opentelemetry-demo.git + ``` + +2. デモフォルダに移動します。 + + ```shell + cd opentelemetry-demo/ + ``` + +3. デモを起動[^1]します。 + + {{< tabpane text=true >}} {{% tab Make %}} + +```shell +make start +``` + + {{% /tab %}} {{% tab Docker %}} + +```shell +docker compose up --force-recreate --remove-orphans --detach +``` + + {{% /tab %}} {{< /tabpane >}} + +4. (オプション) API オブザーバビリティ駆動テストの有効化[^1]します。 + + {{< tabpane text=true >}} {{% tab Make %}} + +```shell +make run-tracetesting +``` + + {{% /tab %}} {{% tab Docker %}} + +```shell +docker compose -f docker-compose-tests.yml run traceBasedTests +``` + + {{% /tab %}} {{< /tabpane >}} + +## ウェブストアとテレメトリーの確認 {#verify-the-web-store-and-telemetry} + +イメージがビルドされ、コンテナが開始されると以下にアクセスできるようになります。 + +- Web store: +- Grafana: +- Load Generator UI: +- Jaeger UI: +- Tracetest UI: 、`make run-tracetesting` の使用時のみ +- Flagd configurator UI: + +## デモのプライマリーポート番号の変更 {#changing-the-demos-primary-port-number} + +デフォルトでは、デモアプリケーションは 8080 ポートにバウンドされたすべてのブラウザのトラフィックに対してプロキシを開始します。 +ポート番号を変更するには、デモを開始する前に環境変数 `ENVOY_PORT` を設定してください。 + +- 次の設定は 8081 ポートを利用する場合の例です[^1]。 + + {{< tabpane text=true >}} {{% tab Make %}} + +```shell +ENVOY_PORT=8081 make start +``` + + {{% /tab %}} {{% tab Docker %}} + +```shell +ENVOY_PORT=8081 docker compose up --force-recreate --remove-orphans --detach +``` + + {{% /tab %}} {{< /tabpane >}} + +## 独自のバックエンドを導入する {#bring-your-own-backend} + +おそらく、あなたがすでに所持しているオブザーバビリティバックエンド（たとえば、Jaeger、Zipkin、または[選択したベンダー](/ecosystem/vendors/)のいずれかの既存インスタンス）のデモアプリケーションとしてウェブストアを利用したいでしょう。 + +OpenTelemetry コレクターはテレメトリーデータを複数のバックエンドに送信するのに利用可能です。 +デフォルトで、デモアプリケーションのコレクターは 2 つのファイルから設定をマージします。 + +- `otelcol-config.yml` +- `otelcol-config-extras.yml` + +あなたのバックエンドに追加するために、エディターで [src/otel-collector/otelcol-config-extras.yml](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/otel-collector/otelcol-config-extras.yml) ファイルを開いてください。 + +- 新しいエクスポーターを追加することで始めます。 例えば、もしあなたのバックエンドが OTLP over HTTP をサポートしているのであれば、以下を追加してください。 + + ```yaml + exporters: + otlphttp/example: + endpoint: + ``` + +- そして、`exporters` をあなたのバックエンドに使いたいテレメトリーパイプラインに上書きしてください。 + + ```yaml + service: + pipelines: + traces: + exporters: [spanmetrics, otlphttp/example] + ``` + +{{% alert title="Note" color="info" %}} +YAML の値をコレクターとマージすると、オブジェクトはマージされて、配列は置き換えられます。 +`spanmetrics` エクスポーターを上書きする場合は、`traces` パイプラインのエクスポーターの配列に含める必要があります。 +このエクスポーターを含めないとエラーが発生します。 +{{% /alert %}} + +ベンダーのバックエンドは認証のために追加のパラメーターを必要とするかもしれません。ドキュメントを確認してください。 +一部のバックエンドは異なるエクスポーターが必要です。それらのエクスポーターとドキュメントについて[opentelemetry-collector-contrib/exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter) で入手できます。 + +`otelcol-config-extras.yml` を更新した後に、`make start` を実行してデモを開始してください。 +しばらくして、あなたのバックエンドにトレースが流れるのも確認できるはずです。 + +[^1]: {{% param notes.docker-compose-v2 %}} diff --git a/hugo.yaml b/hugo.yaml index 71a6c99b973e..8a5aa29411b1 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -28,6 +28,10 @@ languages: languageName: 日本語 (Japanese) params: description: OpenTelemetryプロジェクト公式サイト + notes: + docker-compose-v2: | + `docker-compose` は非推奨です. 詳細は、 + [Migrate to Compose V2](https://docs.docker.com/compose/migrate/) を確認してください。 pt: # cSpell:ignore Português Projeto languageName: Português languageCode: pt-BR From 6980720d243666bc77c7b10fcebf3448c8eb0dea Mon Sep 17 00:00:00 2001 From: Msksgm Date: Mon, 10 Feb 2025 14:10:56 +0900 Subject: [PATCH 2/3] docs: translate App Name into ja --- content/ja/docs/demo/docker-deployment.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/ja/docs/demo/docker-deployment.md b/content/ja/docs/demo/docker-deployment.md index a7b37e3e7df9..421f60b4c97e 100644 --- a/content/ja/docs/demo/docker-deployment.md +++ b/content/ja/docs/demo/docker-deployment.md @@ -66,12 +66,12 @@ docker compose -f docker-compose-tests.yml run traceBasedTests イメージがビルドされ、コンテナが開始されると以下にアクセスできるようになります。 -- Web store: +- ウェブストア: - Grafana: -- Load Generator UI: +- 負荷生成 UI: - Jaeger UI: -- Tracetest UI: 、`make run-tracetesting` の使用時のみ -- Flagd configurator UI: +- トレーステスト UI: 、`make run-tracetesting` の使用時のみ +- Flagd 設定 UI: ## デモのプライマリーポート番号の変更 {#changing-the-demos-primary-port-number} From 5cc4c046ba4abb7622cdb5fb07c27a11752d6804 Mon Sep 17 00:00:00 2001 From: Msksgm Date: Mon, 10 Feb 2025 14:11:10 +0900 Subject: [PATCH 3/3] =?UTF-8?q?fix:=20turn=20`=E4=BE=8B=E3=81=88=E3=81=B0`?= =?UTF-8?q?=20into=20`=E3=81=9F=E3=81=A8=E3=81=88=E3=81=B0`=20to=20improve?= =?UTF-8?q?=20readbility?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/ja/docs/demo/docker-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/ja/docs/demo/docker-deployment.md b/content/ja/docs/demo/docker-deployment.md index 421f60b4c97e..7c2588812d84 100644 --- a/content/ja/docs/demo/docker-deployment.md +++ b/content/ja/docs/demo/docker-deployment.md @@ -106,7 +106,7 @@ OpenTelemetry コレクターはテレメトリーデータを複数のバック あなたのバックエンドに追加するために、エディターで [src/otel-collector/otelcol-config-extras.yml](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/otel-collector/otelcol-config-extras.yml) ファイルを開いてください。 -- 新しいエクスポーターを追加することで始めます。 例えば、もしあなたのバックエンドが OTLP over HTTP をサポートしているのであれば、以下を追加してください。 +- 新しいエクスポーターを追加することで始めます。 たとえば、もしあなたのバックエンドが OTLP over HTTP をサポートしているのであれば、以下を追加してください。 ```yaml exporters: