First sidecar module: OpenTelemetry

[dmathieu]

What this PR does / why we need it:

This PR reuses the principles laid in #7593 to setup a sidecar module for OpenTelemetry, so the base image can be made much smaller, and only run core.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation only

How Has This Been Tested?

I manually built this image locally, and the helm changes have E2E tests.

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I've read the CONTRIBUTION guide
• I have added tests to cover my changes.
• All new and existing tests passed.

[k8s-ci-robot]

Hi @dmathieu. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[dmathieu]

/assign @rikatz

[rikatz]

/ok-to-test

[dmathieu]

If somebody wishes to try this locally, I've built and pushed the otel image to DockerHub. The following helm values will allow running:

controller:
  kind: DaemonSet
  image:
    repository: ingress-controller/controller
    tag: 1.0.0-dev
  service:
    type: ClusterIP
  extraModules:
    - name: opentelemetry
      image: dmathieu/nginx-otel

[strongjz]

/kind feature
/priority longterm-important
/triage accepted

[k8s-ci-robot]

@strongjz: The label(s) priority/longterm-important cannot be applied, because the repository doesn't have them.

In response to this:

/kind feature
/priority longterm-important
/triage accepted

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[iamNoah1]

/priority important-longterm

[rikatz]

/label tide/merge-method-squash
/lgtm
/approve
Thanks!

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dmathieu, rikatz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• charts/ingress-nginx/OWNERS [rikatz]
• images/OWNERS [rikatz]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[cskinfill]

now that this is merged, i was looking for documentation on how to use it. the existing docs at https://kubernetes.github.io/ingress-nginx/user-guide/third-party-addons/opentracing/ only reference opentracing.

[rcjsuen]

I think we then need #7621 based on #5883 (comment).

[dmathieu]

Yeah, we need it. I'm planning to start porting that PR within the next few days.

[kuzaxak]

Hi, tested it with a sidecar module. Receiving an error:
"/modules_mount/etc/nginx/modules/modules/otel_ngx_module.so" failed (Error relocating /modules_mount/etc/nginx/modules/modules/otel_ngx_module.so: _ZN13opentelemetry5proto5trace2v14Span8CopyFromERKS3_: symbol not found)

Looks like some dependency wasn't added to the package.

Full output of ldd:

cp /modules_mount/etc/nginx/modules/modules/otel_ngx_module.so /etc/nginx/modules/otel_ngx_module.so

ldd /etc/nginx/modules/otel_ngx_module.so
        /lib/ld-musl-x86_64.so.1 (0x7fcabcfd6000)
        /usr/local/lib/libmimalloc.so => /usr/local/lib/libmimalloc.so (0x7fcabcf0d000)
        libstdc++.so.6 => /usr/lib/libstdc++.so.6 (0x7fcabcd6c000)
        libgcc_s.so.1 => /usr/lib/libgcc_s.so.1 (0x7fcabcd52000)
        libc.musl-x86_64.so.1 => /lib/ld-musl-x86_64.so.1 (0x7fcabcfd6000)
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_array_create: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto5trace2v14Span8CopyFromERKS3_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto8resource2v18Resource8CopyFromERKS3_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto8resource2v18ResourceC1EPN6google8protobuf5ArenaE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto5trace2v113ResourceSpansEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_http_get_indexed_variable: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto8resource2v18Resource12InternalSwapEPS3_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto5trace2v14SpanD1Ev: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN4grpc13CreateChannelERKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERKSt10shared_ptrINS_18ChannelCredentialsEE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: pcre_exec: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto6common2v18AnyValueEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_http_script_run: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_http_add_variable: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto6common2v18AnyValue11clear_valueEv: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto5trace2v14SpanC1EPN6google8protobuf5ArenaE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto5trace2v16StatusEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto9collector5trace2v126ExportTraceServiceResponseC1EPN6google8protobuf5ArenaE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf8internal20RepeatedPtrFieldBase7ReserveEi: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto8resource2v18ResourceD1Ev: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto5trace2v19Span_LinkEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto6common2v122InstrumentationLibraryD1Ev: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN4grpc26InsecureChannelCredentialsEv: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_http_get_variable_index: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto9collector5trace2v125ExportTraceServiceRequestC1EPN6google8protobuf5ArenaE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto6common2v122InstrumentationLibrary12InternalSwapEPS3_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_http_script_compile: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto9collector5trace2v126ExportTraceServiceResponseD1Ev: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_palloc: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto5trace2v127InstrumentationLibrarySpansEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto5trace2v110Span_EventEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto6common2v110ArrayValueEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto6common2v18KeyValueEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto6common2v122InstrumentationLibraryEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry2v13sdk6common6Random20GenerateRandomBufferENS0_5nostd4spanIhLm18446744073709551615EEE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_pool_cleanup_add: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_array_push: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_pcalloc: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_atoi: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto6common2v122InstrumentationLibraryC1EPN6google8protobuf5ArenaE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_log_error_core: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN4grpc13ClientContextC1Ev: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_http_script_variables_count: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf8internal14ArenaStringPtr3SetENS2_12EmptyDefaultERKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEPNS0_5ArenaE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf8internal14ArenaStringPtr3SetENS2_12EmptyDefaultEONSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEPNS0_5ArenaE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_strncasecmp: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto9collector5trace2v112TraceService7NewStubERKSt10shared_ptrIN4grpc16ChannelInterfaceEERKNS6_11StubOptionsE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto5trace2v14SpanEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_regex_compile: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto6common2v122InstrumentationLibrary8CopyFromERKS3_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN4grpc14SslCredentialsERKNS_21SslCredentialsOptionsE: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_conf_log_error: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf5Arena18CreateMaybeMessageIN13opentelemetry5proto8resource2v18ResourceEJEEEPT_PS1_DpOT0_: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN13opentelemetry5proto9collector5trace2v125ExportTraceServiceRequestD1Ev: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN4grpc13ClientContextD1Ev: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_http_module: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_http_core_module: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: _ZN6google8protobuf8internal26fixed_address_empty_stringB5cxx11E: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_conf_set_flag_slot: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_conf_set_flag_slot: symbol not found
Error relocating /etc/nginx/modules/otel_ngx_module.so: ngx_conf_set_flag_slot: symbol not found