mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-28 04:34:01 +08:00
112 lines
3.6 KiB
Python
112 lines
3.6 KiB
Python
# Copyright The OpenTelemetry Authors
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import unittest
|
|
from unittest.mock import patch
|
|
|
|
from opentelemetry.util.http import (
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS,
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST,
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE,
|
|
SanitizeValue,
|
|
get_custom_headers,
|
|
normalise_request_header_name,
|
|
normalise_response_header_name,
|
|
)
|
|
|
|
|
|
class TestCaptureCustomHeaders(unittest.TestCase):
|
|
@patch.dict(
|
|
"os.environ",
|
|
{
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST: "User-Agent,Test-Header"
|
|
},
|
|
)
|
|
def test_get_custom_request_header(self):
|
|
custom_headers_to_capture = get_custom_headers(
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST
|
|
)
|
|
self.assertEqual(
|
|
custom_headers_to_capture, ["User-Agent", "Test-Header"]
|
|
)
|
|
|
|
@patch.dict(
|
|
"os.environ",
|
|
{
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE: "content-type,content-length,test-header"
|
|
},
|
|
)
|
|
def test_get_custom_response_header(self):
|
|
custom_headers_to_capture = get_custom_headers(
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE
|
|
)
|
|
self.assertEqual(
|
|
custom_headers_to_capture,
|
|
[
|
|
"content-type",
|
|
"content-length",
|
|
"test-header",
|
|
],
|
|
)
|
|
|
|
@patch.dict(
|
|
"os.environ",
|
|
{
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS: "My-Secret-Header,My-Secret-Header-2"
|
|
},
|
|
)
|
|
def test_get_custom_sanitize_header(self):
|
|
sanitized_fields = get_custom_headers(
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS
|
|
)
|
|
self.assertEqual(
|
|
sanitized_fields,
|
|
["My-Secret-Header", "My-Secret-Header-2"],
|
|
)
|
|
|
|
@patch.dict(
|
|
"os.environ",
|
|
{
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS: "My-Secret-Header,My-Secret-Header-2"
|
|
},
|
|
)
|
|
def test_sanitize(self):
|
|
sanitized_fields = get_custom_headers(
|
|
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS
|
|
)
|
|
|
|
sanitize = SanitizeValue(sanitized_fields)
|
|
|
|
self.assertEqual(
|
|
sanitize.sanitize_header_value(
|
|
header="My-Secret-Header", value="My-Secret-Value"
|
|
),
|
|
"[REDACTED]",
|
|
)
|
|
|
|
self.assertEqual(
|
|
sanitize.sanitize_header_value(
|
|
header="My-Not-Secret-Header", value="My-Not-Secret-Value"
|
|
),
|
|
"My-Not-Secret-Value",
|
|
)
|
|
|
|
def test_normalise_request_header_name(self):
|
|
key = normalise_request_header_name("Test-Header")
|
|
self.assertEqual(key, "http.request.header.test_header")
|
|
|
|
def test_normalise_response_header_name(self):
|
|
key = normalise_response_header_name("Test-Header")
|
|
self.assertEqual(key, "http.response.header.test_header")
|