Set opentelemetry span name in transformation filter #368

ashishb-solo · 2024-09-28T02:23:04Z

This pull request adds the ability to set the span name in the transformation filter.

We add a new field in the transformation template to allow setting modifying the span. The new field currently only accepts the span name as a field, but attributes/baggage/other data could also be added as fields to be modified here as well.

If route.decorator.operation is set, we should not update the field in this filter - we intend for the operation field to take precedence over this value, which is set at the virtual host level and intended to be used as a default instead.

Here is an envoy configuration for testing - note the presence of route.decorator.operation, and how uncommenting it causes Envoy to use that field as the span name instead of the hostname.

# required for toggling runtime reloadable features
layered_runtime:
  layers:
  - name: admin
    admin_layer: {}

# taken from https://www.envoyproxy.io/docs/envoy/latest/start/quick-start/configuration-static
# or view-source:https://www.envoyproxy.io/docs/envoy/latest/_downloads/92dcb9714fb6bc288d042029b34c0de4/envoy-demo.yaml
admin:
  address:
    socket_address: { address: 127.0.0.1, port_value: 9901 }

static_resources:

  listeners:
  - name: listener_0
    address:
      socket_address:
        address: 0.0.0.0
        port_value: 10000
    filter_chains:
    - filters:
      - name: envoy.filters.network.http_connection_manager
        typed_config:
          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
          stat_prefix: ingress_http
          generate_request_id: true
          access_log:
          - name: envoy.access_loggers.stdout
            typed_config:
              "@type": type.googleapis.com/envoy.extensions.access_loggers.stream.v3.StdoutAccessLog
              # log_format:
              #   text_format_source:
              #     inline_string: "test\n"
          tracing:
            provider:
              name: envoy.tracers.opentelemetry
              typed_config:
                "@type": type.googleapis.com/envoy.config.trace.v3.OpenTelemetryConfig
                grpc_service:
                  envoy_grpc:
                    cluster_name: opentelemetry_collector
                  timeout: 0.250s
                service_name: gateway-proxy
          codec_type: AUTO
          http_filters:
          - name: io.solo.transformation
            typed_config:
              '@type': type.googleapis.com/envoy.api.v2.filter.http.FilterTransformations
          # - name: io.solo.filters.http.span_decorators
          #   typed_config:
          #     "@type": type.googleapis.com/envoy.config.filter.http.span_decorators.v3.SpanDecorators
          #     # span_name: "HTTP CONNECTION MANAGER"
          - name: envoy.filters.http.router
            typed_config:
              "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
          route_config:
            name: local_route
            virtual_hosts:
            - name: local_service
              domains: ["*"]
              typed_per_filter_config:
                io.solo.transformation:
                  '@type': type.googleapis.com/envoy.api.v2.filter.http.RouteTransformations
                  transformations:
                    - request_match:
                        request_transformation:
                          transformation_template:
                            span_transformer:
                              name:
                                text: '{{ header("host") }}'
                                # text: '{{clusterMetadata("io.solo.hostname")}}'
                            headers:
                              test_header:
                                text: TEST_VALUE
              #   io.solo.filters.http.span_decorators:
              #     "@type": type.googleapis.com/envoy.config.filter.http.span_decorators.v3.SpanDecorators
              #     span_name: "VIRTUAL HOST"
              routes:
              - match:
                  prefix: "/"
                route:
                  cluster: echo-server
                # if these fields are uncommented, they will override the value set in the transformation template
                # decorator:
                #   operation: "HEY_EVERYONE_THIS_IS_A_CUSTOM_SPAN_NAME!!!"

  clusters:
  - name: opentelemetry_collector
    type: STRICT_DNS
    connect_timeout: 5s
    http2_protocol_options: {}
    dns_lookup_family: V4_ONLY
    metadata: {}
    load_assignment:
      cluster_name: opentelemetry_collector
      endpoints:
        - lb_endpoints:
            - endpoint:
                address:
                  socket_address:
                    address: 127.0.0.1
                    port_value: 4317
                health_check_config:
                  hostname: otel-collector
                hostname: otel-collector
              metadata:
                filter_metadata:
                  envoy.transport_socket_match:
                    otel-collector;otel-collector:4317: true
    typed_extension_protocol_options:
      envoy.extensions.upstreams.http.v3.HttpProtocolOptions:
        '@type': >-
          type.googleapis.com/envoy.extensions.upstreams.http.v3.HttpProtocolOptions
        explicit_http_config:
          http2_protocol_options: {}
  - name: echo-server
    type: STATIC
    load_assignment:
      cluster_name: echo-server
      endpoints:
        - lb_endpoints:
            - endpoint:
                address:
                  socket_address:
                    address: 127.0.0.1
                    port_value: 11100
  - name: service_envoyproxy_io
    type: LOGICAL_DNS
    # Comment out the following line to test on v6 networks
    dns_lookup_family: V4_ONLY
    load_assignment:
      cluster_name: service_envoyproxy_io
      endpoints:
      - lb_endpoints:
        - endpoint:
            address:
              socket_address:
                address: www.envoyproxy.io
                port_value: 443
    transport_socket:
      name: envoy.transport_sockets.tls
      typed_config:
        "@type": type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext
        sni: www.envoyproxy.io

Should work but does not seem to at the moment

solo-changelog-bot · 2024-09-28T02:27:25Z

Issues linked to changelog:
solo-io/gloo#9848

…y-set-operation-patch

nfuden · 2024-10-01T14:05:28Z

source/extensions/filters/http/transformation/inja_transformer.cc

+    if (callbacks.route()
+        && callbacks.route()->decorator()
+        && !callbacks.route()->decorator()->getOperation().empty()) {
+      callbacks.activeSpan().setOperation(callbacks.route()->decorator()->getOperation());


TODO delete this

This was refactored in 3d7463c

ashishb-solo · 2024-10-01T15:05:43Z

test/extensions/filters/http/transformation/inja_transformer_test.cc

+
+  InjaTransformer transformer(transformation, rng_, google::protobuf::BoolValue(), tls_);
+  std::unique_ptr<Tracing::MockSpan> mock_span = std::make_unique<Tracing::MockSpan>();
+  const std::unique_ptr<Router::MockDecorator> mock_decorator = std::make_unique<NiceMock<Router::MockDecorator>>();


are there simpler ways to set up these mocks?

This is the default value that is set from the HCM - we do not need to write it a second time.

nfuden

Tested it out on my local as well. I like it!

* Add setOperation patch * Add changelog * Transformation initial implementation Should work but does not seem to at the moment * Implement unit test for setting span name * Update changelog * Remove extra entry from changelog * Do not override route.decorator.operation * Add test for null route in callbacks * Remove redundant call to setOperation This is the default value that is set from the HCM - we do not need to write it a second time.

…368) (#369) * Set opentelemetry span name in transformation filter (#368) * Add setOperation patch * Add changelog * Transformation initial implementation Should work but does not seem to at the moment * Implement unit test for setting span name * Update changelog * Remove extra entry from changelog * Do not override route.decorator.operation * Add test for null route in callbacks * Remove redundant call to setOperation This is the default value that is set from the HCM - we do not need to write it a second time. * Move changelog * Move changelog... again!

ashishb-solo added 6 commits September 19, 2024 21:21

Add setOperation patch

a1edacd

Merge tag 'v1.30.6-patch1' into opentelemetry-set-operation-patch

835ec37

Add changelog

74fb9ce

Transformation initial implementation

dbeabf3

Should work but does not seem to at the moment

Implement unit test for setting span name

258b74f

Update changelog

ddbc228

ashishb-solo added 4 commits September 27, 2024 22:28

Merge remote-tracking branch 'origin/release-v1.30' into opentelemetr…

6f8b1ef

…y-set-operation-patch

Remove extra entry from changelog

b1714d0

Do not override route.decorator.operation

690f908

Add test for null route in callbacks

2e69711

ashishb-solo changed the title ~~Opentelemetry set operation patch~~ Set opentelemetry span name in transformation filter Oct 1, 2024

nfuden reviewed Oct 1, 2024

View reviewed changes

ashishb-solo commented Oct 1, 2024

View reviewed changes

Remove redundant call to setOperation

3d7463c

This is the default value that is set from the HCM - we do not need to write it a second time.

nfuden approved these changes Oct 1, 2024

View reviewed changes

soloio-bulldozer bot merged commit 9c14c3a into release-v1.30 Oct 1, 2024
4 checks passed

soloio-bulldozer bot deleted the opentelemetry-set-operation-patch branch October 1, 2024 17:26

ashishb-solo mentioned this pull request Oct 1, 2024

Opentelemetry span name k8sgateway/k8sgateway#10123

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set opentelemetry span name in transformation filter #368

Set opentelemetry span name in transformation filter #368

ashishb-solo commented Sep 28, 2024 •

edited

Loading

solo-changelog-bot bot commented Sep 28, 2024

nfuden Oct 1, 2024

ashishb-solo Oct 1, 2024

ashishb-solo Oct 1, 2024

ashishb-solo Oct 1, 2024

nfuden left a comment

Set opentelemetry span name in transformation filter #368

Set opentelemetry span name in transformation filter #368

Conversation

ashishb-solo commented Sep 28, 2024 • edited Loading

solo-changelog-bot bot commented Sep 28, 2024

nfuden Oct 1, 2024

Choose a reason for hiding this comment

ashishb-solo Oct 1, 2024

Choose a reason for hiding this comment

ashishb-solo Oct 1, 2024

Choose a reason for hiding this comment

ashishb-solo Oct 1, 2024

Choose a reason for hiding this comment

nfuden left a comment

Choose a reason for hiding this comment

ashishb-solo commented Sep 28, 2024 •

edited

Loading