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.

Sign up for GitHub

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

Jump to bottom

Implement ObservabilityPolicy API #1828

Closed
Tracked by #622
mpstefan opened this issue Apr 15, 2024 · 1 comment · Fixed by #2004
Closed
Tracked by #622

Implement ObservabilityPolicy API #1828

mpstefan opened this issue Apr 15, 2024 · 1 comment · Fixed by #2004
Assignees
@sjberman
Labels
area/nginx-configuration Relates to nginx configuration blocked Blocked by other issue enhancement New feature or request refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks
Milestone
v1.3.0

Comments

@mpstefan
Copy link
Collaborator

mpstefan commented Apr 15, 2024 •
edited
Loading

As a user of NGF
I want to configure tracing configuration for my route
So that I can collect traces for my route.

Acceptance

  • Tracing can be enabled and configured for a specific route.
  • Implementation functionality matches the enhancement proposal.
  • Maximum and minimum input on all settings are tested against NGINX to ensure the CRD only allows valid input.
  • A manual test is done to ensure that traces are sent to a collection platform when tracing is configured.
@mpstefan mpstefan mentioned this issue Apr 15, 2024
Closed
@mpstefan mpstefan added this to the v1.3.0 milestone Apr 15, 2024
@mpstefan mpstefan added area/nginx-configuration Relates to nginx configuration enhancement New feature or request blocked Blocked by other issue labels Apr 15, 2024
@mpstefan
Copy link
Collaborator Author

Blocked by #1827

@mpstefan mpstefan added refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks labels Apr 15, 2024
sjberman added a commit to sjberman/nginx-gateway-fabric that referenced this issue Apr 22, 2024
@sjberman
Support NginxProxy CRD and global tracing settings
eba3910 
Problem: As a user of NGF
I want to set the collection point for my traces for my installation of NGF
So that I can ensure all my traces are sent to the same collection platform.

Solution: Implement the NginxProxy CRD which contains the fields required to configure the collection point for tracing. This resource is attached to the GatewayClass. If the resource is not found, a condition will be set on the GatewayClass to indicate this. The GatewayClass will continue to be Accepted even if the parametersRef is invalid.

This configuration sets the `http` context-level otel directives. The otel module is loaded conditionally based on the existence of this configuration.

Note: tracing is not enabled by this configuration, this only sets high level options. nginxinc#1828 is required to actually enable tracing on a per-route basis.
sjberman added a commit to sjberman/nginx-gateway-fabric that referenced this issue Apr 22, 2024
@sjberman
Support NginxProxy CRD and global tracing settings
1cd8d6e 
Problem: As a user of NGF
I want to set the collection point for my traces for my installation of NGF
So that I can ensure all my traces are sent to the same collection platform.

Solution: Implement the NginxProxy CRD which contains the fields required to configure the collection point for tracing. This resource is attached to the GatewayClass. If the resource is not found, a condition will be set on the GatewayClass to indicate this. The GatewayClass will continue to be Accepted even if the parametersRef is invalid.

This configuration sets the `http` context-level otel directives. The otel module is loaded conditionally based on the existence of this configuration.

Note: tracing is not enabled by this configuration, this only sets high level options. nginxinc#1828 is required to actually enable tracing on a per-route basis.
This was referenced Apr 22, 2024
Closed
Merged
sjberman added a commit that referenced this issue Apr 24, 2024
@sjberman
Support NginxProxy CRD and global tracing settings
5f26403 
Problem: As a user of NGF
I want to set the collection point for my traces for my installation of NGF
So that I can ensure all my traces are sent to the same collection platform.

Solution: Implement the NginxProxy CRD which contains the fields required to configure the collection point for tracing. This resource is attached to the GatewayClass. If the resource is not found, a condition will be set on the GatewayClass to indicate this. The GatewayClass will continue to be Accepted even if the parametersRef is invalid.

This configuration sets the `http` context-level otel directives. The otel module is loaded conditionally based on the existence of this configuration.

Note: tracing is not enabled by this configuration, this only sets high level options. #1828 is required to actually enable tracing on a per-route basis.
sjberman added a commit that referenced this issue Apr 26, 2024
@sjberman
Support NginxProxy CRD and global tracing settings
a6c6a38 
Problem: As a user of NGF
I want to set the collection point for my traces for my installation of NGF
So that I can ensure all my traces are sent to the same collection platform.

Solution: Implement the NginxProxy CRD which contains the fields required to configure the collection point for tracing. This resource is attached to the GatewayClass. If the resource is not found, a condition will be set on the GatewayClass to indicate this. The GatewayClass will continue to be Accepted even if the parametersRef is invalid.

This configuration sets the `http` context-level otel directives. The otel module is loaded conditionally based on the existence of this configuration.

Note: tracing is not enabled by this configuration, this only sets high level options. #1828 is required to actually enable tracing on a per-route basis.
sjberman added a commit that referenced this issue Apr 29, 2024
@sjberman
Support NginxProxy CRD and global tracing settings
c5c41c8 
Problem: As a user of NGF
I want to set the collection point for my traces for my installation of NGF
So that I can ensure all my traces are sent to the same collection platform.

Solution: Implement the NginxProxy CRD which contains the fields required to configure the collection point for tracing. This resource is attached to the GatewayClass. If the resource is not found, a condition will be set on the GatewayClass to indicate this. The GatewayClass will continue to be Accepted even if the parametersRef is invalid.

This configuration sets the `http` context-level otel directives. The otel module is loaded conditionally based on the existence of this configuration.

Note: tracing is not enabled by this configuration, this only sets high level options. #1828 is required to actually enable tracing on a per-route basis.
@sjberman sjberman self-assigned this Apr 29, 2024
sjberman added a commit that referenced this issue Apr 29, 2024
@sjberman
Support NginxProxy CRD and global tracing settings
2dd6e3d 
Problem: As a user of NGF
I want to set the collection point for my traces for my installation of NGF
So that I can ensure all my traces are sent to the same collection platform.

Solution: Implement the NginxProxy CRD which contains the fields required to configure the collection point for tracing. This resource is attached to the GatewayClass. If the resource is not found, a condition will be set on the GatewayClass to indicate this. The GatewayClass will continue to be Accepted even if the parametersRef is invalid.

This configuration sets the `http` context-level otel directives. The otel module is loaded conditionally based on the existence of this configuration.

Note: tracing is not enabled by this configuration, this only sets high level options. #1828 is required to actually enable tracing on a per-route basis.
sjberman added a commit that referenced this issue Apr 29, 2024
@sjberman
Support NginxProxy CRD and global tracing settings
68811f9 
Problem: As a user of NGF
I want to set the collection point for my traces for my installation of NGF
So that I can ensure all my traces are sent to the same collection platform.

Solution: Implement the NginxProxy CRD which contains the fields required to configure the collection point for tracing. This resource is attached to the GatewayClass. If the resource is not found, a condition will be set on the GatewayClass to indicate this. The GatewayClass will continue to be Accepted even if the parametersRef is invalid.

This configuration sets the `http` context-level otel directives. The otel module is loaded conditionally based on the existence of this configuration.

Note: tracing is not enabled by this configuration, this only sets high level options. #1828 is required to actually enable tracing on a per-route basis.
sjberman added a commit that referenced this issue Apr 29, 2024
@sjberman
Support NginxProxy CRD and global tracing settings (#1870)
7c3da8d 
Problem: As a user of NGF
I want to set the collection point for my traces for my installation of NGF
So that I can ensure all my traces are sent to the same collection platform.

Solution: Implement the NginxProxy CRD which contains the fields required to configure the collection point for tracing. This resource is attached to the GatewayClass. If the resource is not found, a condition will be set on the GatewayClass to indicate this. The GatewayClass will continue to be Accepted even if the parametersRef is invalid.

This configuration sets the `http` context-level otel directives. The otel module is loaded conditionally based on the existence of this configuration.

Note: tracing is not enabled by this configuration, this only sets high level options. #1828 is required to actually enable tracing on a per-route basis.
@sjberman sjberman moved this from 🆕 New to 🏗 In Progress in NGINX Gateway Fabric May 15, 2024
@sjberman sjberman mentioned this issue May 21, 2024
Merged
6 tasks
@sjberman sjberman moved this from 🏗 In Progress to 👀 In Review in NGINX Gateway Fabric May 21, 2024
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in NGINX Gateway Fabric May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sjberman sjberman

Labels
area/nginx-configuration Relates to nginx configuration blocked Blocked by other issue enhancement New feature or request refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks
Projects
NGINX Gateway Fabric
Archived in project
Milestone
v1.3.0
Development

Successfully merging a pull request may close this issue.

Support tracing via the ObservabilityPolicy sjberman/nginx-gateway-fabric
2 participants
@mpstefan @sjberman