Conversation
Move NIM-side OpenTelemetry configuration from troubleshooting into the setup guide for viewing NGINX Gateway Fabric security events. Add step to create /etc/nms/otel-collector-config.yaml with the OTLP receiver pipeline. Update troubleshooting section to reference the setup page.
✅ Deploy Preview will be available once build job completes!
|
| ### Resolution | ||
|
|
||
| Check the following on NGINX Instance Manager, in order: | ||
| First, make sure you've completed all NIM-side setup steps described in [Configure NGINX Instance Manager]({{< ref "/nim/security-monitoring/ngf-security-events.md#configure-nginx-instance-manager" >}}), including enabling the OpenTelemetry collector and creating the collector configuration file. |
There was a problem hiding this comment.
f5-product-names, enable-disable, sentence-length: "NIM-side" abbreviates a product name — don't abbreviate NGINX product names. "enabling" should read "turning on" to match how both pages describe this collector as "turned on". The sentence also runs past the 20-word task limit, so split it:
First, complete the setup steps on NGINX Instance Manager. See [Configure NGINX Instance Manager]({{< ref "/nim/security-monitoring/ngf-security-events.md#configure-nginx-instance-manager" >}}). These include turning on the OpenTelemetry collector and creating the collector configuration file.
|
|
||
| Before NGINX Gateway Fabric can send security events to NGINX Instance Manager, configure NGINX Instance Manager to receive them. | ||
|
|
||
| ### Enable the OpenTelemetry collector |
There was a problem hiding this comment.
enable-disable: use "turn on" instead of "enable". The troubleshooting page describes this same collector as "turned on", so this heading reads better as Turn on the OpenTelemetry collector. Leave the collector_config.enable: true config value unchanged, since it must match the config key.
| logs: | ||
| receivers: [otlp] | ||
| processors: [batch, secevt] | ||
| exporters: [debug] |
There was a problem hiding this comment.
Technical accuracy, for a subject matter expert to confirm (flagged separately from style): this pipeline's only exporter is debug, which writes events to the collector's log output. The page's stated outcome is that events appear in the Security Dashboard. Confirm whether the secevt processor delivers events to Security Monitoring on its own, or whether the pipeline also needs an exporter that forwards events to NGINX Instance Manager. As written, someone who copies this config may see events logged but not shown in the dashboard.
|
This pull request adds a Configure NGINX Instance Manager section to the NGINX Gateway Fabric security events page and repoints the troubleshooting resolution to it. Style findings
Technical accuracy
|
Summary
Improves the setup experience for viewing NGINX Gateway Fabric security
events in NGINX Instance Manager by surfacing required NIM-side
configuration in the setup guide rather than only in troubleshooting.
Changes
ngf-security-events.mdAdded a new Configure NGINX Instance Manager section between
Requirements and the NGF-side export steps. It covers:
collector_config.enable: trueinnms.conf)/etc/nms/otel-collector-config.yamlwith the OTLP receiver,batch/secevt processors, and debug exporter pipeline
4317(gRPC) is reachable from the Kubernetes clustertroubleshooting.mdUpdated the NGINX Gateway Fabric security events don't appear in the
dashboard resolution to direct readers to the setup page first, making
it clear the troubleshooting checklist applies after setup is complete —
not as a substitute for it.
Previously, the only place these NIM configuration steps appeared was in
the troubleshooting guide. Users following the setup flow had no
indication that OTel needed to be explicitly enabled and configured on
the NIM side, leading to a broken experience that only surfaced at
troubleshooting time.