Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bump webserver to v1.0.4 #2408

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,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.24.0 and 1.25.3 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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're effectively dropping support for versions <1.24, then this is a breaking change and should be documented as such imo.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I agree! How should that be reflected? Should I bump the major?

Only problem is that it can be confusing that the semantic version deviates from the upstream.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to add a changelog entry with type breaking_change. Run make chlog-new and have a look at the added changelog record.

I'm wondering if we should actually have the operator pick the right version based on the nginx image version. WDYT @jaronoff97 @pavolloffay ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with the bump to 1.0.4 is all support for those versions dropped? We definitely should add a changelog calling out the dropping of support. I'm wondering if we should also add a compat matrix for the versions / images to let people know.


```yaml
apiVersion: opentelemetry.io/v1alpha1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ spec:
spec:
containers:
- name: myapp
image: nginxinc/nginx-unprivileged:1.23.1
image: nginxinc/nginx-unprivileged:1.25.3
imagePullPolicy: Always
securityContext:
runAsUser: 1000
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ spec:
fsGroup: 3000
containers:
- name: myapp
image: nginxinc/nginx-unprivileged:1.23.1
image: nginxinc/nginx-unprivileged:1.25.3
imagePullPolicy: Always
securityContext:
runAsUser: 1000
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ spec:
fsGroup: 3000
containers:
- name: myapp
image: nginxinc/nginx-unprivileged:1.23.1
image: nginxinc/nginx-unprivileged:1.25.3
imagePullPolicy: Always
securityContext:
runAsUser: 1000
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ spec:
fsGroup: 3000
containers:
- name: myapp
image: nginxinc/nginx-unprivileged:1.23.1
image: nginxinc/nginx-unprivileged:1.25.3
imagePullPolicy: Always
securityContext:
allowPrivilegeEscalation: false
Expand Down
2 changes: 1 addition & 1 deletion versions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ autoinstrumentation-apache-httpd=1.0.4

# Represents the current release of Apache Nginx instrumentation.
# Should match autoinstrumentation/apache-httpd/version.txt
autoinstrumentation-nginx=1.0.3
autoinstrumentation-nginx=1.0.4
Loading