Docs » Splunk Distribution of the OpenTelemetry Collector の利用開始 » Collector コンポーネント » Collectorコンポーネント: プロセッサー » Redaction processor

Redaction processor 🔗

再編集プロセッサーは OpenTelemetry Collector のコンポーネントで、許可されたスパン属性のリストに一致しないスパン属性を削除します。また、ブロックされた値リストに一致するスパン属性値もマスクします。許可リストにないスパン属性は、値のチェックが行なわれる前に削除されます。

The supported pipeline type is traces. See パイプラインでデータを処理する for more information.

はじめに 🔗

以下の手順に従って、コンポーネントの設定とアクティベーションを行ってください:

  1. Splunk Distribution of the OpenTelemetry Collector をホストまたはコンテナプラットフォームにデプロイします:

  1. このドキュメントに記載されているようにプロセッサーを設定します。

  2. Collector を再起動します。

メイン構成 🔗

The following example shows the main configuration settings of the redaction processor:

processors:
  redaction:
    # allow_all_keys is a flag which when set to true, which can disables the
    # allowed_keys list. The list of blocked_values is applied regardless. If
    # you just want to block values, set this to true.
    allow_all_keys: false
    # allowed_keys is a list of span attribute keys that are kept on the span and
    # processed. The list is designed to fail closed. If allowed_keys is empty,
    # no span attributes are allowed and all span attributes are removed. To
    # allow all keys, set allow_all_keys to true.
    allowed_keys:
      - description
      - group
      - id
      - name
    # Ignore the following attributes, allow them to pass without redaction.
    # Any keys in this list are allowed so they don't need to be in both lists.
    ignored_keys:
      - safe_attribute
    # blocked_values is a list of regular expressions for blocking values of
    # allowed span attributes. Values that match are masked
    blocked_values:
      - "4[0-9]{12}(?:[0-9]{3})?" ## Visa credit card number
      - "(5[1-5][0-9]{14})"       ## MasterCard number
    # summary controls the verbosity level of the diagnostic attributes that
    # the processor adds to the spans when it redacts or masks other
    # attributes. In some contexts a list of redacted attributes leaks
    # information, while it is valuable when integrating and testing a new
    # configuration. Possible values:
    # - `debug` includes both redacted key counts and names in the summary
    # - `info` includes just the redacted key counts in the summary
    # - `silent` omits the summary attributes
    summary: debug

次に、設定ファイルの service セクションの必要なパイプラインにプロセッサーを含めます:

service:
  pipelines:
    traces:
      processors: [redaction]

How does the processor work? 🔗

無視された属性は最初に処理されるため、常に許可され、ブロックされることはありません。このフィールドは、テレメトリシステムに送信するデータが常に安全であることが分かっている場合にのみ使用する必要があります。

許可されたキーリストに含まれるスパン属性のみが保持されます。もし allowed_keys が空であれば、スパン属性は許可されません。この場合、すべてのスパン属性が削除されます。すべてのスパン属性を保持するには、allow_all_keys を明示的に true に設定しなければなりません。

blocked_values は許可されたキーの値に適用されます。許可されたキーの値がブロックされた値の正規表現に一致する場合、値の一致する部分は一定の長さのアスタリスクでマスクされます。例えば、notes が許可されたキーのリストにある場合、notes スパン属性は保持されます。しかし、もしブロックされた値のリストの正規表現にマッチしたクレジットカード番号のような値がnotes フィールドにあれば、その値はマスクされます。

ユースケース 🔗

Typical use-cases include:

  • 機密フィールドが誤ってトレースに漏れるのを防ぐ

  • 法的要件、プライバシー要件、セキュリティ要件を確実に遵守する

Data protection 🔗

EU 一般データ保護規則(GDPR)は、データ主体の明確な同意なしに、生年月日、住所、IPアドレスなどの個人データを国境を越えて移転することを禁じています。人気のあるトレース集計サービスは、EU ではなく米国にあります。データから個人データを消去するために再編集プロセッサーを使用することができます。

中華人民共和国の法律では、地理座標を中華人民共和国の国外に転送することを禁止しています。一般的なトレース集計サービスは米国にあり、中華人民共和国にはありません。再編集プロセッサーを使用して、データから地理座標を消去することができます。

ペイメントカード業界(PCI)データセキュリティ基準では、特定の事柄を記録したり、暗号化せずに保存したりすることを禁じています。再編集プロセッサーを使用すると、トレースからそれらを消去することができます。

設定 🔗

The following table shows the configuration options for the redaction processor:

Name

タイプ

説明

allow_all_keys

bool

すべてのスパン属性キーを許可します。allowed_keys リストを無効にするには、これを true に設定します。ブロックされた値のリストは関係なく適用されます。値をブロックするだけの場合、これを true に設定します。

allowed_keys

文字列

許可されたスパン属性のキーのリスト。リストにないスパン属性は削除されます。リストが空の場合は失敗します。すべてのキーを許可するには、allow_all_keys を設定する必要があります。

ignored_keys

文字列

編集されないスパン属性キーのリスト。このリストにあるスパン属性は、変更または削除されることなくフィルターを通過することが許可されます。

blocked_values

文字列

許可されたスパン属性の値をブロックするための正規表現のリスト。一致する値はマスクされます。

summary

文字列

プロセッサーが他の属性を冗長化またはマスクする際に、スパンに追加する診断属性の冗長化レベルを制御します。あるコンテキストでは、冗長化された属性のリストは情報を漏らしますが、新しい構成を統合してテストするときには価値があります。取り得る値は、debuginfosilent です。

トラブルシューティング 🔗

Splunk Observability Cloudをご利用のお客様で、Splunk Observability Cloudでデータを確認できない場合は、以下の方法でサポートを受けることができます。

Splunk Observability Cloudをご利用のお客様

見込み客および無料トライアルユーザー様

  • Splunk Answers のコミュニティサポートで質問し、回答を得る

  • Splunk #observability ユーザーグループの Slack チャンネルに参加して、世界中の顧客、パートナー、Splunk 社員とのコミュニケーションを図る。参加するには、Get Started with Splunk Community マニュアルの チャットグループ を参照してください。

このページは 2024年12月12日 に最終更新されました。