ローカルモードでの Flex Gateway 分散トレースの設定
OpenTelemetry により、分散システムでテレメトリーデータを計測、生成、収集、エクスポートするための統合された基準が提供されます。Flex Gateway では OpenTelemetry をサポートしているため、ゲートウェイで管理するすべての API トラフィックの分散トレースデータの生成を設定できます。このインテグレーションにより、API 要求フローをより詳しく視覚化できるため、システムの動作をより簡単に分析し、問題をトラブルシューティングして、Flex Gateway API と外部サービス間のインタラクションを理解できます。
Anypoint Monitoring Telemetry Exporter を使用することで、Flex Gateway トレースデータを Azure Monitor や Splunk HEC のほか、OpenTelemetry 互換ツールなどのサードパーティオブザーバビリティおよび分析プラットフォームに送信できます。この機能によって、エンドツーエンドオブザーバビリティを活用し、API トレースを他のシステムのデータと相関させ、環境の包括的なビューを構築できます。
始める前に
Flex Gateway で OpenTelemetry を使用するには、以下に精通している必要があります。
-
分散トレースの概念 (トレースやスパンなど)。
分散トレースや OpenTelemetry を初めて使用する場合、 「OpenTelemetry とは」および 「分散トレースを理解する」から始めることをお勧めします。
Flex Gateway API の分散トレースの設定
トレースにより、Flex Gateway API のインタラクションを追跡できます。複数のシステムおよびサービスが関連する場合、分散トレースで分散環境に流れる API 要求を追跡し、API の実行の包括的なビューを提供します。
YAML 設定リソースを使用した分散トレースの有効化と設定
この設定リソースを編集してから適用し、分散トレースを有効にします。この設定リソースは、すべての API インスタンスに適用されます。 次の例では、すべてのトレースのサンプリングを 0% に設定し、サンプリングはポリシーを使用して API ごとに設定されます。
apiVersion: gateway.mulesoft.com/v1beta1
kind: Configuration
metadata:
name: tracing
namespace: test-ns
spec:
tracing:
provider:
type: anypoint
properties:
timeout: 10s #
sampling: # Set all sampling to 0% - this example shows enabling samping for the gateway, but only generating trace data for sampling on a per-API basis using the Tracing policy.
client: 0
random: 0
overall: 0
#
# Add labels such as these example labels, if you want to configure labels globally. You can also configure labels on a per-API basis by using the Tracing policy.
labels:
- name: c-env-tag
type: environment
keyName: FLEX_NAME
defaultValue: DEFAULT_VAL
- name: c-header-tag
type: requestHeader
keyName: :method
defaultValue: DEFAULT_METHOD
- name: c-literal-tag
type: literal
defaultValue: the-tag