feat: bump apache httpd and nginx instrumentation to latest version #3488
Conversation
| @@ -549,7 +549,7 @@ List of all available attributes can be found at [otel-webserver-module](https:/ | |||
|
|
|||
| #### Using Nginx autoinstrumentation | |||
|
|
|||
| For `Nginx` autoinstrumentation, Nginx versions 1.22.0, 1.23.0, and 1.23.1 are supported at this time. The Nginx configuration file is expected to be `/etc/nginx/nginx.conf` by default, if it's different, see following example on how to change it. Instrumentation at this time also expects, that `conf.d` directory is present in the directory, where configuration file resides and that there is a `include <config-file-dir-path>/conf.d/*.conf;` directive in the `http { ... }` section of Nginx configuration file (like it is in the default configuration file of Nginx). You can also adjust OpenTelemetry SDK attributes. Example: | |||
| For `Nginx` autoinstrumentation, Nginx versions 1.22.0, 1.23.0, 1.23.1, 1.24.0, 1.25.3, 1.25.5, and 1.26.0 are supported at this time. The Nginx configuration file is expected to be `/etc/nginx/nginx.conf` by default, if it's different, see following example on how to change it. Instrumentation at this time also expects, that `conf.d` directory is present in the directory, where configuration file resides and that there is a `include <config-file-dir-path>/conf.d/*.conf;` directive in the `http { ... }` section of Nginx configuration file (like it is in the default configuration file of Nginx). You can also adjust OpenTelemetry SDK attributes. Example: | |||
There was a problem hiding this comment.
Are you confident all of these versions are actually supported? When we previously bumped this, there was some disagreement over this.
There was a problem hiding this comment.
I was just basing this off of the release notes. 1.24.0 and 1.25.3 were added in 1.0.4 and 1.26.0 and 1.25.5 were added in 1.1.0. Support for 1.22.0, 1.23.0, and 1.23.1 correspond with the release notes for version 1.0.2, and in 1.0.3 no change in supported versions was noted. So it seems like the supported versions weren't added for the 1.0.4 release. But I'm purely basing this off the notes here. I haven't actually deployed or tested anything yet, I just noted the outdated version and thought I'd help update it as it seemed simple enough.
There was a problem hiding this comment.
This is the instrumentation we test the least, so I'm always a bit more cautious when the version is bumped. For example, if you look at the README, it claims to only support 1.24 and 1.25.
On the other hand, it looks like this was already the case for 1.0.4, which we blindly upgraded to without any complaints, so maybe this instrumentation simply isn't used that much, or its users carefully set the image tag in their CRs.
@pavolloffay @jaronoff97 @frzifus WDYT? Do we just bite the bullet and upgrade?
There was a problem hiding this comment.
@swiatekm I just checked the created container and it the versions 1.25.5 and 1.26.0 in it for NGINX.
There was a problem hiding this comment.
Can we extend the test for some period of time to just check a few versions at the same time? wdyt?
|
I am wiling to test it if otel add the supports for 1.26.x version at least. Currently, i see error that so nginx..xxxx.so file is missing after integrating auto-instrumentation. |
davidspek
force-pushed
the
feat/bump-httpd
branch
2 times, most recently
from
b543361 to
7de40f5
Compare
|
@116davinder Just a note that I had an issue with |
|
Annotations apiVersion: v1
kind: Pod
metadata:
annotations:
instrumentation.opentelemetry.io/container-names: test-example-api-pod
instrumentation.opentelemetry.io/inject-nginx: opentelemetry-operator-system/auto-instrumentation
resource.opentelemetry.io/service.name: test-example-apiNginx Image: Main Nginx Container Startup Error 2024/11/27 17:56:23 [emerg] 1#1: dlopen() "/opt/opentelemetry-webserver/agent/WebServerModule/Nginx/1.26.2/ngx_http_opentelemetry_module.so" failed (Error loading shared library /opt/opentelemetry-webserver/agent/WebServerModule/Nginx/1.26.2/ngx_http_opentelemetry_module.so: No such file or directory) in /etc/nginx/nginx.conf:2
nginx: [emerg] dlopen() "/opt/opentelemetry-webserver/agent/WebServerModule/Nginx/1.26.2/ngx_http_opentelemetry_module.so" failed (Error loading shared library /opt/opentelemetry-webserver/agent/WebServerModule/Nginx/1.26.2/ngx_http_opentelemetry_module.so: No such file or directory) in /etc/nginx/nginx.conf:2otel-attach-nginx container logs NGINX_AGENT_DIR_FULL=$1
NGINX_AGENT_CONF_DIR_FULL=$2
NGINX_CONFIG_FILE=$3
NGINX_SID_PLACEHOLDER=$4
NGINX_SID_VALUE=$5
echo "Input Parameters: $@"
set -x
cp -r /opt/opentelemetry/VERSION.txt /opt/opentelemetry/WebServerModule /opt/opentelemetry/conf /opt/opentelemetry/install.sh /opt/opentelemetry/logs /opt/opentelemetry/sdk_lib ${NGINX_AGENT_DIR_FULL}
NGINX_VERSION=$(cat ${NGINX_AGENT_CONF_DIR_FULL}/version.txt)
NGINX_AGENT_LOG_DIR=$(echo "${NGINX_AGENT_DIR_FULL}/logs" | sed 's,/,\/,g')
cat ${NGINX_AGENT_DIR_FULL}/conf/opentelemetry_sdk_log4cxx.xml.template | sed 's,__agent_log_dir__,'${NGINX_AGENT_LOG_DIR}',g' > ${NGINX_AGENT_DIR_FULL}/conf/opentelemetry_sdk_log4cxx.xml
echo -e $OTEL_NGINX_AGENT_CONF > ${NGINX_AGENT_CONF_DIR_FULL}/opentelemetry_agent.conf
sed -i "s,${NGINX_SID_PLACEHOLDER},${OTEL_NGINX_SERVICE_INSTANCE_ID},g" ${NGINX_AGENT_CONF_DIR_FULL}/opentelemetry_agent.conf
sed -i "1s,^,load_module ${NGINX_AGENT_DIR_FULL}/WebServerModule/Nginx/${NGINX_VERSION}/ngx_http_opentelemetry_module.so;\n,g" ${NGINX_AGENT_CONF_DIR_FULL}/${NGINX_CONFIG_FILE}
sed -i "1s,^,env OTEL_RESOURCE_ATTRIBUTES;\n,g" ${NGINX_AGENT_CONF_DIR_FULL}/${NGINX_CONFIG_FILE}
mv ${NGINX_AGENT_CONF_DIR_FULL}/opentelemetry_agent.conf ${NGINX_AGENT_CONF_DIR_FULL}/conf.d
Input Parameters: /opt/opentelemetry-webserver/agent /opt/opentelemetry-webserver/source-conf nginx.conf <<SID-PLACEHOLDER>>
+ cp -r /opt/opentelemetry/VERSION.txt /opt/opentelemetry/WebServerModule /opt/opentelemetry/conf /opt/opentelemetry/install.sh /opt/opentelemetry/logs /opt/opentelemetry/sdk_lib /opt/opentelemetry-webserver/agent
+ cat /opt/opentelemetry-webserver/source-conf/version.txt
+ NGINX_VERSION=1.26.2
+ echo /opt/opentelemetry-webserver/agent/logs
+ sed 's,/,\/,g'
+ NGINX_AGENT_LOG_DIR=/opt/opentelemetry-webserver/agent/logs
+ cat /opt/opentelemetry-webserver/agent/conf/opentelemetry_sdk_log4cxx.xml.template
+ sed s,__agent_log_dir__,/opt/opentelemetry-webserver/agent/logs,g
+ echo -e NginxModuleEnabled 'ON;' NginxModuleOtelExporterEndpoint 'http://opentelemetry-collector.opentelemetry-operator-system:4318;' NginxModuleOtelSpanExporter 'otlp;' NginxModuleResolveBackends 'ON;' NginxModuleServiceInstanceId '<<SID-PLACEHOLDER>>;' NginxModuleServiceName 'test-example-api;' NginxModuleServiceNamespace 'test-frontend;' NginxModuleTraceAsError 'ON;'
+ sed -i 's,<<SID-PLACEHOLDER>>,test-example-api-deployment-857f6b6b8b-ndnrt,g' /opt/opentelemetry-webserver/source-conf/opentelemetry_agent.conf
+ sed -i '1s,^,load_module /opt/opentelemetry-webserver/agent/WebServerModule/Nginx/1.26.2/ngx_http_opentelemetry_module.so;\n,g' /opt/opentelemetry-webserver/source-conf/nginx.conf
+ sed -i '1s,^,env OTEL_RESOURCE_ATTRIBUTES;\n,g' /opt/opentelemetry-webserver/source-conf/nginx.conf
+ mv /opt/opentelemetry-webserver/source-conf/opentelemetry_agent.conf /opt/opentelemetry-webserver/source-conf/conf.d |
|
It doesn't support 1.26.2, only 1.26.0. And for the alpine image you'll still run into the error. |
Signed-off-by: David van der Spek <[email protected]>
Signed-off-by: David van der Spek <[email protected]>
Signed-off-by: David van der Spek <[email protected]>
davidspek
force-pushed
the
feat/bump-httpd
branch
from
7de40f5 to
2ef8fa5
Compare
Description:
Updates apache httpd and nginx instrumentation to the latest version.
Link to tracking Issue(s):
Testing:
Documentation: