diff --git a/content/ja/docs/languages/sdk-configuration/_index.md b/content/ja/docs/languages/sdk-configuration/_index.md new file mode 100644 index 000000000000..3dfa39900568 --- /dev/null +++ b/content/ja/docs/languages/sdk-configuration/_index.md @@ -0,0 +1,11 @@ +--- +title: SDKの設定 +linkTitle: SDKの設定 +aliases: [/docs/concepts/sdk-configuration] +weight: 1 +default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309 +--- + +OpenTelemetry SDK は、各言語と環境変数によるコンフィギュレーションをサポートしています。 +以下のページでは、SDK を設定するために使用できる環境変数について説明します。 +環境変数で設定された値は、SDK APIを使用したコード内の同等の設定を上書きします。 diff --git a/content/ja/docs/languages/sdk-configuration/general.md b/content/ja/docs/languages/sdk-configuration/general.md new file mode 100644 index 000000000000..47c9ba019dc6 --- /dev/null +++ b/content/ja/docs/languages/sdk-configuration/general.md @@ -0,0 +1,172 @@ +--- +title: 一般的なSDK設定 +linkTitle: 一般 +aliases: [general-sdk-configuration] +default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309 +cSpell:ignore: ottrace +--- + +{{% alert title="Note" color="info" %}} + +環境変数のサポートはオプションです。 +各言語の実装がどの環境変数をサポートしているかの詳細については、[実装準拠マトリックス](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md#environment-variables)を参照してください。 + +{{% /alert %}} + +## `OTEL_SERVICE_NAME` + +[`service.name`](/docs/specs/semconv/resource/#service) リソース属性の値を設定します。 + +**デフォルト値:** `"unknown_service"` + +`OTEL_RESOURCE_ATTRIBUTES` に `service.name` も指定されている場合は、`OTEL_SERVICE_NAME` が優先されます。 + +**例:** + +`export OTEL_SERVICE_NAME="your-service-name"` + +## `OTEL_RESOURCE_ATTRIBUTES` + +リソース属性として使用されるキーと値のペア。 +詳細は[リソースSDK](/docs/specs/otel/resource/sdk#specifying-resource-information-via-an-environment-variable)を参照してください。 + +**デフォルト値:** 空 + +一般的なリソースタイプで従うべきセマンティック規約については、[リソースのセマンティック規約](/docs/specs/semconv/resource/#semantic-attributes-with-sdk-provided-default-value)を参照してください。 + +**例:** + +`export OTEL_RESOURCE_ATTRIBUTES="key1=value1,key2=value2"` + +## `OTEL_TRACES_SAMPLER` + +SDKによるトレースのサンプリングに使用するサンプラーを指定します。 + +**デフォルト値:** `"parentbased_always_on"` + +**例:** + +`export OTEL_TRACES_SAMPLER="traceidratio"` + +`OTEL_TRACES_SAMPLER` に指定できる値の一覧は以下です。 + +- `"always_on"`: `AlwaysOnSampler` +- `"always_off"`: `AlwaysOffSampler` +- `"traceidratio"`: `TraceIdRatioBased` +- `"parentbased_always_on"`: `ParentBased(root=AlwaysOnSampler)` +- `"parentbased_always_off"`: `ParentBased(root=AlwaysOffSampler)` +- `"parentbased_traceidratio"`: `ParentBased(root=TraceIdRatioBased)` +- `"parentbased_jaeger_remote"`: `ParentBased(root=JaegerRemoteSampler)` +- `"jaeger_remote"`: `JaegerRemoteSampler` +- `"xray"`: + [AWS X-Ray Centralized Sampling](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-sampling.html) + (_サードパーティ_) + +## `OTEL_TRACES_SAMPLER_ARG` + +`OTEL_TRACES_SAMPLER` で定義されているサンプラーの引数を指定します。 +指定した値は `OTEL_TRACES_SAMPLER` が設定されている場合にのみ使用されます。 +各サンプラータイプは、期待される入力があれば、それを定義します。 +無効な入力や認識できない入力はエラーとしてログに記録されます。 + +**デフォルト値:** 空 + +**例:** + +```shell +export OTEL_TRACES_SAMPLER="traceidratio" +export OTEL_TRACES_SAMPLER_ARG="0.5" +``` + +`OTEL_TRACES_SAMPLER` の値によって、`OTEL_TRACES_SAMPLER_ARG` は以下のように設定されます。 + +- `traceidratio` と `parentbased_traceidratio` サンプラーの場合: サンプリング確率。[0..1]の範囲で指定します。未設定の場合、デフォルトは1.0。 +- `jaeger_remote` と `parentbased_jaeger_remote` の場合: 値はカンマ区切りのリストです。 + - 例: + `"endpoint=http://localhost:14250,pollingIntervalMs=5000,initialSamplingRate=0.25"` + - `endpoint`: サービスのサンプリング戦略を提供する gRPC サーバの `scheme://host:port` 形式のエンドポイント ([sampling.proto](https://github.com/jaegertracing/jaeger-idl/blob/main/proto/api_v2/sampling.proto)). + - `pollingIntervalMs`: サンプラーがサンプリング戦略の更新のためにバックエンドをポーリングする頻度をミリ秒単位で指定します。 + - `initialSamplingRate`: [0..1]の範囲で、サンプリング戦略を取得するためにバックエンドに到達できない場合のサンプリング確率として使用されます。サンプリング戦略の取得に成功すると、この値は意味を持たなくなり、新しいアップデートが取得されるまでリモート戦略が使用されるようになります。 + +## `OTEL_PROPAGATORS` + +カンマ区切りのリストで使用するプロパゲーターを指定します。 + +**デフォルト値:** `"tracecontext,baggage"` + +**Example:** + +`export OTEL_PROPAGATORS="b3"` + +`OTEL_PROPAGATORS` に指定できる値の一覧は以下です。 + +- `"tracecontext"`: [W3C Trace Context](https://www.w3.org/TR/trace-context/) +- `"baggage"`: [W3C Baggage](https://www.w3.org/TR/baggage/) +- `"b3"`: [B3 Single](/docs/specs/otel/context/api-propagators#configuration) +- `"b3multi"`: + [B3 Multi](/docs/specs/otel/context/api-propagators#configuration) +- `"jaeger"`: + [Jaeger](https://www.jaegertracing.io/docs/1.21/client-libraries/#propagation-format) +- `"xray"`: + [AWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader) + (_サードパーティ_) +- `"ottrace"`: + [OT Trace](https://github.com/opentracing?q=basic&type=&language=) (_サードパーティ_) +- `"none"`: 自動設定されたプロパゲータがない。 + +## `OTEL_TRACES_EXPORTER` + +トレースに使用するエクスポーターを指定します。 +実装によっては、カンマ区切りのリストになります。 + +**デフォルト値:** `"otlp"` + +**例:** + +`export OTEL_TRACES_EXPORTER="jaeger"` + +指定できる値の一覧は以下です。 + +- `"otlp"`: [OTLP][] +- `"jaeger"`: Jaegerデータモデルでのエクスポート +- `"zipkin"`: [Zipkin](https://zipkin.io/zipkin-api/) +- `"console"`: [Standard Output](/docs/specs/otel/trace/sdk_exporters/stdout/) +- `"none"`: トレース用に自動設定されたエクスポーターがない。 + +## `OTEL_METRICS_EXPORTER` + +メトリクスに使用するエクスポーターを指定します。 +実装によっては、カンマ区切りのリストになります。 + +**デフォルト値:** `"otlp"` + +**例:** + +`export OTEL_METRICS_EXPORTER="prometheus"` + +`OTEL_METRICS_EXPORTER` に指定できる値の一覧は以下です。 + +- `"otlp"`: [OTLP][] +- `"prometheus"`: + [Prometheus](https://github.com/prometheus/docs/blob/main/content/docs/instrumenting/exposition_formats.md) +- `"console"`: [標準出力](/docs/specs/otel/metrics/sdk_exporters/stdout/) +- `"none"`: メトリクスのエクスポーターが自動的に設定されない。 + +## `OTEL_LOGS_EXPORTER` + +ログにどのエクスポーターを使用するかを指定します。 +実装によっては、カンマ区切りのリストになります。 + +**デフォルト値:** `"otlp"` + +**例:** + +`export OTEL_LOGS_EXPORTER="otlp"` + +`OTEL_LOGS_EXPORTER` に指定できる値の一覧は以下です。 + +- `"otlp"`: [OTLP][] +- `"console"`: [標準出力](/docs/specs/otel/logs/sdk_exporters/stdout/) +- `"none"`: ログのエクスポーターが自動的に設定されない。 + +[otlp]: /docs/specs/otlp/ diff --git a/content/ja/docs/languages/sdk-configuration/otlp-exporter.md b/content/ja/docs/languages/sdk-configuration/otlp-exporter.md new file mode 100644 index 000000000000..faf0d6661ca8 --- /dev/null +++ b/content/ja/docs/languages/sdk-configuration/otlp-exporter.md @@ -0,0 +1,220 @@ +--- +title: OTLPエクスポーター設定 +linkTitle: OTLPエクスポーター +aliases: [otlp-exporter-configuration] +default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309 +--- + +## エンドポイントの設定 {#endpoint-configuration} + +以下の環境変数により、トレース、メトリクス、およびログのためのOTLP/gRPCまたはOTLP/HTTPエンドポイントを構成できます。 + +### `OTEL_EXPORTER_OTLP_ENDPOINT` + +任意のシグナルタイプ用の基本エンドポイントURLで、オプションでポート番号を指定します。 +同じエンドポイントに複数のシグナルを送信し、1つの環境変数でエンドポイントを制御したい場合に便利です。 + +**デフォルト値:** + +- gRPC: `"http://localhost:4317"` +- HTTP: `"http://localhost:4318"` + +**例:** + +- gRPC: `export OTEL_EXPORTER_OTLP_ENDPOINT="https://my-api-endpoint:443"` +- HTTP: `export OTEL_EXPORTER_OTLP_ENDPOINT="http://my-api-endpoint/"` + +OTLP/HTTPの場合、この環境変数が設定されると、SDKのエクスポーターはシグナル固有のURLを構築します。 +つまり、トレース、メトリクス、ログを送信する場合、上記の例から以下のURLが構築されます。 + +- トレース: `"http://my-api-endpoint/v1/traces"` +- メトリクス: `"http://my-api-endpoint/v1/metrics"` +- ログ: `"http://my-api-endpoint/v1/logs"` + +### `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` + +トレースデータ専用のエンドポイントURL。 +オプションでポート番号を指定できます。 +OTLP/HTTP を使用している場合は、通常 `v1/traces` で終わります。 + +**デフォルト値:** + +- gRPC: `"http://localhost:4317"` +- HTTP: `"http://localhost:4318/v1/traces"` + +**例:** + +- gRPC: + `export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="https://my-api-endpoint:443"` +- HTTP: + `export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="http://my-api-endpoint/v1/traces"` + +### `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT` + +オプションでポート番号を指定することができます。 +OTLP/HTTP を使用する場合は、通常 `v1/metrics` で終わります。 + +**デフォルト値:** + +- gRPC: `"http://localhost:4317"` +- HTTP: `"http://localhost:4318/v1/metrics"` + +**例:** + +- gRPC: + `export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT="https://my-api-endpoint:443"` +- HTTP: + `export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT="http://my-api-endpoint/v1/metrics"` + +### `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT` + +ログデータ専用のエンドポイントURL。 +オプションでポート番号を指定できます。 +OTLP/HTTP を使う場合は、通常 `v1/logs` で終わります。 + +**デフォルト値:** + +- gRPC: `"http://localhost:4317"` +- HTTP: `"http://localhost:4318/v1/logs"` + +**例:** + +- gRPC: `export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT="https://my-api-endpoint:443"` +- HTTP: + `export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT="http://my-api-endpoint/v1/logs"` + +## ヘッダーの設定 {#header-configuration} + +以下の環境変数を使用すると、gRPC または HTTP リクエストの発信時に追加するヘッダーを、キーと値のペアのリストとして設定できます。 + +### `OTEL_EXPORTER_OTLP_HEADERS` + +すべての送信データ(トレース、メトリクス、ログ)に適用するヘッダーのリスト。 + +**デフォルト値:** なし + +**例:** +`export OTEL_EXPORTER_OTLP_HEADERS="api-key=key,other-config-value=value"` + +### `OTEL_EXPORTER_OTLP_TRACES_HEADERS` + +すべての送信トレースに適用するヘッダーのリスト。 + +**デフォルト値:** なし + +**例:** +`export OTEL_EXPORTER_OTLP_TRACES_HEADERS="api-key=key,other-config-value=value"` + +### `OTEL_EXPORTER_OTLP_METRICS_HEADERS` + +すべての送信メトリクスに適用するヘッダーのリスト。 + +**デフォルト値:** なし + +**例:** +`export OTEL_EXPORTER_OTLP_METRICS_HEADERS="api-key=key,other-config-value=value"` + +### `OTEL_EXPORTER_OTLP_LOGS_HEADERS` + +すべての送信ログに適用するヘッダーのリスト。 + +**デフォルト値:** なし + +**例:** +`export OTEL_EXPORTER_OTLP_LOGS_HEADERS="api-key=key,other-config-value=value"` + +## タイムアウトの設定 {#timeout-configuration} + +以下の環境変数は、OTLPエクスポーターがデータのネットバッチを送信する前に待つ最大時間(ミリ秒単位)を設定します。 + +### `OTEL_EXPORTER_OTLP_TIMEOUT` + +すべての送信データ(トレース、メトリクス、ログ)のタイムアウト値をミリ秒単位で指定します。 + +**デフォルト値:** `10000` (10秒) + +**例:** `export OTEL_EXPORTER_OTLP_TIMEOUT=500` + +### `OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` + +すべての送信トレースのタイムアウト値(ミリ秒)。 + +**デフォルト値:** 10000 (10秒) + +**例:** `export OTEL_EXPORTER_OTLP_TRACES_TIMEOUT=500` + +### `OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` + +すべての送信メトリクスのタイムアウト値をミリ秒単位で指定します。 + +**デフォルト値:** 10000 (10秒) + +**例:** `export OTEL_EXPORTER_OTLP_METRICS_TIMEOUT=500` + +### `OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` + +すべての送信ログのタイムアウト値(ミリ秒)。 + +**デフォルト値:** 10000 (10s) + +**例:** `export OTEL_EXPORTER_OTLP_LOGS_TIMEOUT=500` + +## プロトコルの設定 {#protocol-configuration} + +以下の環境変数は、OTLPエクスポーターが使用するOTLPトランスポートプロトコルを設定します。 + +### `OTEL_EXPORTER_OTLP_PROTOCOL` + +すべてのテレメトリーデータに使用するOTLPトランスポートプロトコルを指定します。 + +**デフォルト値:** SDK依存ですが、通常は `http/protobuf` か `grpc` のいずれかです。 + +**例:** `export OTEL_EXPORTER_OTLP_PROTOCOL=grpc` + +指定できる値は以下です。 + +- OTLP/gRPCを使う場合は `grpc` +- OTLP/HTTP + protobuf を使う場合は `http/protobuf` +- OTLP/HTTP + JSON を使う場合は `http/json` + +### `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` + +トレースデータに使用するOTLPトランスポートプロトコルを指定します。 + +**デフォルト値:** SDK依存ですが、通常は `http/protobuf` か `grpc` のいずれかです。 + +**例:** `export OTEL_EXPORTER_OTLP_TRACES_PROTOCOL=grpc` + +指定できる値は以下です。 + +- OTLP/gRPCを使う場合は `grpc` +- OTLP/HTTP + protobuf を使う場合は `http/protobuf` +- OTLP/HTTP + JSON を使う場合は `http/json` + +### `OTEL_EXPORTER_OTLP_METRICS_PROTOCOL` + +メトリクスデータに使用するOTLPトランスポートプロトコルを指定します。 + +**デフォルト値:** SDK依存ですが、通常は `http/protobuf` か `grpc` のいずれかです。 + +**例:** `export OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=grpc` + +指定できる値は以下です。 + +- OTLP/gRPCを使う場合は `grpc` +- OTLP/HTTP + protobuf を使う場合は `http/protobuf` +- OTLP/HTTP + JSON を使う場合は `http/json` + +### `OTEL_EXPORTER_OTLP_LOGS_PROTOCOL` + +ログデータに使用するOTLPトランスポートプロトコルを指定します。 + +**デフォルト値:** SDK依存ですが、通常は `http/protobuf` か `grpc` のいずれかです。 + +**例:** `export OTEL_EXPORTER_OTLP_LOGS_PROTOCOL=grpc` + +指定できる値は以下です。 + +- OTLP/gRPCを使う場合は `grpc` +- OTLP/HTTP + protobuf を使う場合は `http/protobuf` +- OTLP/HTTP + JSON を使う場合は `http/json`