Skip to content

Commit 8afa5cd

Browse files
opentelemetrybotopentelemetrybot
committed
Merge remote-tracking branch 'origin/main' into opentelemetrybot/semconv-integration-v1.32.0-dev
2 parents 782a832 + 1dc5b52 commit 8afa5cd

File tree

5 files changed

+538
-0
lines changed

5 files changed

+538
-0
lines changed

‎content/ja/docs/contributing/acknowledgements.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: 謝辞
3+
description: 本サイトの内容に関するソースへの謝辞
4+
aliases: [/acknowledgements, /docs/acknowledgements]
5+
default_lang_commit: 722beb5b9ecf8a603b2f5ae6128e3c3509f52fcf
6+
cSpell:ignore: Pigram
7+
---
8+
9+
本サイトの一部のコンテンツについて、以下のソースに感謝の意を表します。
10+
11+
1. [APM is Dying and That's Okay - Lightstep](https://lightstep.com/blog/apm-is-dying-and-thats-okay)
12+
2. [Alexandria Pigram](https://github.com/alexandriastech)（[Honeycomb](https://www.honeycomb.io/) による、[トレース](/docs/concepts/signals/traces/)に関するトレーシングの内容）
13+
3. [What is OpenTelemetry - Dynatrace](https://www.dynatrace.com/news/blog/what-is-opentelemetry-2/)
14+
4. [Understanding OpenTracing, OpenCensus, and OpenMetrics - BMC](https://www.bmc.com/blogs/opentracing-opencensus-openmetrics/)
15+
5. [Ask Miss O11y: Baggage in OTel - Honeycomb](https://www.honeycomb.io/blog/ask-miss-o11y-opentelemetry-baggage/)
16+
6. [Observability Whitepaper - CNCF Tag Observability](https://github.com/cncf/tag-observability/blob/whitepaper-v1.0.0/whitepaper.md)（[シグナル](/docs/concepts/signals/)に関する内容）

‎content/ja/docs/contributing/development.md

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
title: 開発環境のセットアップとビルド、サーブなどのコマンド
3+
linkTitle: 開発環境セットアップなど
4+
description: この Web サイトの開発環境をセットアップする方法を学びます。
5+
weight: 60
6+
default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309
7+
---
8+
9+
以下の手順では、この Web サイトの開発環境をセットアップする方法を説明します。
10+
11+
## クラウド IDE のセットアップ {#cloud-ide-setup}
12+
13+
これらの手順は [Gitpod.io] 用ですが、お好みのクラウド IDE に合わせて調整してください。
14+
15+
1. このリポジトリをフォークします。詳細は [リポジトリのフォーク方法][fork] を参照してください。
16+
2. [gitpod.io/workspaces] から新しいワークスペースを作成する（初回のみ）か、フォークしたリポジトリ上の既存のワークスペースを開きます。
17+
また、次の形式のリンクを開くこともできます。
18+
`https://gitpod.io#https://github.com/YOUR_GITHUB_ID/opentelemetry.io`
19+
20+
> **注記**: このリポジトリで作業するための権限がある場合や、単に内容を確認したい場合は、
21+
> <https://gitpod.io/#https://github.com/open-telemetry/opentelemetry.io> を開いてください。
22+
23+
Gitpod はリポジトリ固有のパッケージを自動的にインストールします。
24+
25+
これで、[ビルド](#build)、[サーブ](#serve)、または Web サイトファイルの更新を行う準備が整いました。
26+
27+
## ローカルセットアップ {#local-setup}
28+
29+
1. <{{% param github_repo %}}> でWeb サイトのリポジトリ[フォーク][fork]した後に、[クローン][clone]します。
30+
2. リポジトリのディレクトリに移動します。
31+
3. Node.js の [**Active LTS** リリース][nodejs-rel] をインストールまたはアップグレードします。Node.js インストレーションの管理には [nvm][] の使用を推奨します。Linux では以下のコマンドを実行してください。.nvmrc ファイルで指定されたバージョンにインストールとアップグレードします。
32+
33+
```sh
34+
nvm install
35+
```
36+
37+
Windows で [インストールする場合][nodejs-win] は、[nvm-windows][] を使用してください。
38+
39+
```cmd
40+
> nvm install lts && nvm use lts
41+
```
42+
43+
4. npm パッケージとその他の依存関係をインストールします。
44+
45+
```sh
46+
npm install
47+
```
48+
49+
これで、[ビルド](#build)、[サーブ](#serve)、または Web サイトファイルの更新を行う準備が整いました。
50+
51+
### ビルド {#build}
52+
53+
サイトをビルドするには、次のコマンドを実行します。
54+
55+
```sh
56+
npm run build
57+
```
58+
59+
生成されたサイトのファイルは `public` ディレクトリ内にあります。
60+
61+
### サーブ {#serve}
62+
63+
サイトをサーブするには、次のコマンドを実行します。
64+
65+
```sh
66+
npm run serve
67+
```
68+
69+
サイトは [localhost:1313][] でサーブされます。
70+
71+
[Netlify] のリダイレクトをテストする必要がある場合は、次のコマンドを実行し、[localhost:8888][] にアクセスしてください。
72+
73+
```sh
74+
npm run serve:netlify
75+
```
76+
77+
この `serve` コマンドは、ディスクではなくメモリ上のファイルを提供します。
78+
79+
macOS で `too many open files` や `pipe failed` というエラーが発生する場合は、ファイルディスクリプタの制限を増やす必要があるかもしれません。
80+
詳しくは [Hugo のイシューの #6109](https://github.com/gohugoio/hugo/issues/6109) を参照してください。
81+
82+
### コンテンツとサブモジュール {#content-and-submodules}
83+
84+
Web サイトは以下のコンテンツを基に構築されます。
85+
86+
- `content/`、`static/` などの [Hugo][] のデフォルトディレクトリ
87+
- [hugo.yaml][] の `mounts` で定義されたマウントポイント
88+
- これらは [content-modules][] の Git サブモジュールから直接取得される場合や、
89+
`content-modules` 内で前処理されたコンテンツが `tmp/` に配置される場合があります。
90+
91+
[hugo.yaml]: https://github.com/open-telemetry/opentelemetry.io/blob/main/hugo.yaml
92+
[content-modules]: https://github.com/open-telemetry/opentelemetry.io/tree/main/content-modules
93+
94+
### サブモジュールの変更 {#submodule-changes}
95+
96+
[content-modules][] のサブモジュール内のコンテンツを変更する場合は、まずそのサブモジュールのリポジトリに対して PR（サブモジュールの変更を含む）を送信する必要があります。
97+
サブモジュールの PR が承認された後にのみ、サブモジュールを更新し、この Web サイトに変更を反映できます。
98+
99+
これは、サブモジュールそのものを更新するよりも、対応するサブモジュールの元のリポジトリで作業することが、`content-modules` の変更を管理する最も簡単な方法です。
100+
101+
経験豊富なコントリビューターは、サブモジュール内で直接作業することも可能です。
102+
その場合、（サブモジュールの）変更を直接ビルドおよびサーブできます。
103+
デフォルトでは CI スクリプトが呼び出しのたびに、サブモジュールを取得します。
104+
作業中にこの動作を防ぐには、環境変数 `GET=no` を設定してください。
105+
サブモジュールの PR を提出する前に、サブモジュールに対して `git fetch --unshallow` を実行する必要もあります。
106+
または、`DEPTH=100` を設定してサブモジュールを再取得してください。
107+
108+
[clone]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
109+
[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
110+
[gitpod.io]: https://gitpod.io
111+
[gitpod.io/workspaces]: https://gitpod.io/workspaces
112+
[hugo]: https://gohugo.io
113+
[localhost:1313]: http://localhost:1313
114+
[localhost:8888]: http://localhost:8888
115+
[netlify]: https://netlify.com
116+
[nodejs-rel]: https://nodejs.org/en/about/previous-releases
117+
[nodejs-win]: https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows
118+
[nvm]: https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating
119+
[nvm-windows]: https://github.com/coreybutler/nvm-windows

‎content/ja/docs/languages/sdk-configuration/_index.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: SDKの設定
3+
linkTitle: SDKの設定
4+
aliases: [/docs/concepts/sdk-configuration]
5+
weight: 1
6+
default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309
7+
---
8+
9+
OpenTelemetry SDK は、各言語と環境変数によるコンフィギュレーションをサポートしています。
10+
以下のページでは、SDK を設定するために使用できる環境変数について説明します。
11+
環境変数で設定された値は、SDK APIを使用したコード内の同等の設定を上書きします。

‎content/ja/docs/languages/sdk-configuration/general.md

+172
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
---
2+
title: 一般的なSDK設定
3+
linkTitle: 一般
4+
aliases: [general-sdk-configuration]
5+
default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309
6+
cSpell:ignore: ottrace
7+
---
8+
9+
{{% alert title="Note" color="info" %}}
10+
11+
環境変数のサポートはオプションです。
12+
各言語の実装がどの環境変数をサポートしているかの詳細については、[実装準拠マトリックス](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md#environment-variables)を参照してください。
13+
14+
{{% /alert %}}
15+
16+
## `OTEL_SERVICE_NAME`
17+
18+
[`service.name`](/docs/specs/semconv/resource/#service) リソース属性の値を設定します。
19+
20+
**デフォルト値:** `"unknown_service"`
21+
22+
`OTEL_RESOURCE_ATTRIBUTES` に `service.name` も指定されている場合は、`OTEL_SERVICE_NAME` が優先されます。
23+
24+
**例:**
25+
26+
`export OTEL_SERVICE_NAME="your-service-name"`
27+
28+
## `OTEL_RESOURCE_ATTRIBUTES`
29+
30+
リソース属性として使用されるキーと値のペア。
31+
詳細は[リソースSDK](/docs/specs/otel/resource/sdk#specifying-resource-information-via-an-environment-variable)を参照してください。
32+
33+
**デフォルト値:** 空
34+
35+
一般的なリソースタイプで従うべきセマンティック規約については、[リソースのセマンティック規約](/docs/specs/semconv/resource/#semantic-attributes-with-sdk-provided-default-value)を参照してください。
36+
37+
**例:**
38+
39+
`export OTEL_RESOURCE_ATTRIBUTES="key1=value1,key2=value2"`
40+
41+
## `OTEL_TRACES_SAMPLER`
42+
43+
SDKによるトレースのサンプリングに使用するサンプラーを指定します。
44+
45+
**デフォルト値:** `"parentbased_always_on"`
46+
47+
**例:**
48+
49+
`export OTEL_TRACES_SAMPLER="traceidratio"`
50+
51+
`OTEL_TRACES_SAMPLER` に指定できる値の一覧は以下です。
52+
53+
- `"always_on"`: `AlwaysOnSampler`
54+
- `"always_off"`: `AlwaysOffSampler`
55+
- `"traceidratio"`: `TraceIdRatioBased`
56+
- `"parentbased_always_on"`: `ParentBased(root=AlwaysOnSampler)`
57+
- `"parentbased_always_off"`: `ParentBased(root=AlwaysOffSampler)`
58+
- `"parentbased_traceidratio"`: `ParentBased(root=TraceIdRatioBased)`
59+
- `"parentbased_jaeger_remote"`: `ParentBased(root=JaegerRemoteSampler)`
60+
- `"jaeger_remote"`: `JaegerRemoteSampler`
61+
- `"xray"`:
62+
[AWS X-Ray Centralized Sampling](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-sampling.html)
63+
(_サードパーティ_)
64+
65+
## `OTEL_TRACES_SAMPLER_ARG`
66+
67+
`OTEL_TRACES_SAMPLER` で定義されているサンプラーの引数を指定します。
68+
指定した値は `OTEL_TRACES_SAMPLER` が設定されている場合にのみ使用されます。
69+
各サンプラータイプは、期待される入力があれば、それを定義します。
70+
無効な入力や認識できない入力はエラーとしてログに記録されます。
71+
72+
**デフォルト値:** 空
73+
74+
**例:**
75+
76+
```shell
77+
export OTEL_TRACES_SAMPLER="traceidratio"
78+
export OTEL_TRACES_SAMPLER_ARG="0.5"
79+
```
80+
81+
`OTEL_TRACES_SAMPLER` の値によって、`OTEL_TRACES_SAMPLER_ARG` は以下のように設定されます。
82+
83+
- `traceidratio` と `parentbased_traceidratio` サンプラーの場合: サンプリング確率。[0..1]の範囲で指定します。未設定の場合、デフォルトは1.0。
84+
- `jaeger_remote` と `parentbased_jaeger_remote` の場合: 値はカンマ区切りのリストです。
85+
- 例:
86+
`"endpoint=http://localhost:14250,pollingIntervalMs=5000,initialSamplingRate=0.25"`
87+
- `endpoint`: サービスのサンプリング戦略を提供する gRPC サーバの `scheme://host:port` 形式のエンドポイント ([sampling.proto](https://github.com/jaegertracing/jaeger-idl/blob/main/proto/api_v2/sampling.proto)).
88+
- `pollingIntervalMs`: サンプラーがサンプリング戦略の更新のためにバックエンドをポーリングする頻度をミリ秒単位で指定します。
89+
- `initialSamplingRate`: [0..1]の範囲で、サンプリング戦略を取得するためにバックエンドに到達できない場合のサンプリング確率として使用されます。サンプリング戦略の取得に成功すると、この値は意味を持たなくなり、新しいアップデートが取得されるまでリモート戦略が使用されるようになります。
90+
91+
## `OTEL_PROPAGATORS`
92+
93+
カンマ区切りのリストで使用するプロパゲーターを指定します。
94+
95+
**デフォルト値:** `"tracecontext,baggage"`
96+
97+
**Example:**
98+
99+
`export OTEL_PROPAGATORS="b3"`
100+
101+
`OTEL_PROPAGATORS` に指定できる値の一覧は以下です。
102+
103+
- `"tracecontext"`: [W3C Trace Context](https://www.w3.org/TR/trace-context/)
104+
- `"baggage"`: [W3C Baggage](https://www.w3.org/TR/baggage/)
105+
- `"b3"`: [B3 Single](/docs/specs/otel/context/api-propagators#configuration)
106+
- `"b3multi"`:
107+
[B3 Multi](/docs/specs/otel/context/api-propagators#configuration)
108+
- `"jaeger"`:
109+
[Jaeger](https://www.jaegertracing.io/docs/1.21/client-libraries/#propagation-format)
110+
- `"xray"`:
111+
[AWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader)
112+
(_サードパーティ_)
113+
- `"ottrace"`:
114+
[OT Trace](https://github.com/opentracing?q=basic&type=&language=) (_サードパーティ_)
115+
- `"none"`: 自動設定されたプロパゲータがない。
116+
117+
## `OTEL_TRACES_EXPORTER`
118+
119+
トレースに使用するエクスポーターを指定します。
120+
実装によっては、カンマ区切りのリストになります。
121+
122+
**デフォルト値:** `"otlp"`
123+
124+
**例:**
125+
126+
`export OTEL_TRACES_EXPORTER="jaeger"`
127+
128+
指定できる値の一覧は以下です。
129+
130+
- `"otlp"`: [OTLP][]
131+
- `"jaeger"`: Jaegerデータモデルでのエクスポート
132+
- `"zipkin"`: [Zipkin](https://zipkin.io/zipkin-api/)
133+
- `"console"`: [Standard Output](/docs/specs/otel/trace/sdk_exporters/stdout/)
134+
- `"none"`: トレース用に自動設定されたエクスポーターがない。
135+
136+
## `OTEL_METRICS_EXPORTER`
137+
138+
メトリクスに使用するエクスポーターを指定します。
139+
実装によっては、カンマ区切りのリストになります。
140+
141+
**デフォルト値:** `"otlp"`
142+
143+
**例:**
144+
145+
`export OTEL_METRICS_EXPORTER="prometheus"`
146+
147+
`OTEL_METRICS_EXPORTER` に指定できる値の一覧は以下です。
148+
149+
- `"otlp"`: [OTLP][]
150+
- `"prometheus"`:
151+
[Prometheus](https://github.com/prometheus/docs/blob/main/content/docs/instrumenting/exposition_formats.md)
152+
- `"console"`: [標準出力](/docs/specs/otel/metrics/sdk_exporters/stdout/)
153+
- `"none"`: メトリクスのエクスポーターが自動的に設定されない。
154+
155+
## `OTEL_LOGS_EXPORTER`
156+
157+
ログにどのエクスポーターを使用するかを指定します。
158+
実装によっては、カンマ区切りのリストになります。
159+
160+
**デフォルト値:** `"otlp"`
161+
162+
**例:**
163+
164+
`export OTEL_LOGS_EXPORTER="otlp"`
165+
166+
`OTEL_LOGS_EXPORTER` に指定できる値の一覧は以下です。
167+
168+
- `"otlp"`: [OTLP][]
169+
- `"console"`: [標準出力](/docs/specs/otel/logs/sdk_exporters/stdout/)
170+
- `"none"`: ログのエクスポーターが自動的に設定されない。
171+
172+
[otlp]: /docs/specs/otlp/

0 commit comments

Comments
 (0)