Update N1C getting started guide with instructions on how to enable metrics collection for a NGINX Plus API with SSL enabled #1496
+134
−57
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…etrics collection for a NGINX Plus API with SSL enabled
github-actions
bot
added
documentation
✅ Deploy Preview will be available once build job completes!
|
craigell
reviewed
Nov 27, 2025
| ssl_certificate_key /etc/nginx/certs/nginx-selfsigned.key; | ||
|
|
||
| location /api/ { | ||
| # To restrict write methods (POST, PATCH, DELETE), uncomment: |
There was a problem hiding this comment.
Think we can take out the commented section for http basic auth. Keep the example clear for ssl only.
Comment on lines
+43
to
+49
| NGINX Agent configuration needs to be update with the following to enable the NGINX Agent to be able to call the NGINX Plus API. | ||
| ``` | ||
| data_plane_config: | ||
| nginx: | ||
| api_tls: | ||
| ca: "/etc/nginx/certs/nginx-selfsigned.crt" | ||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| NGINX Agent configuration needs to be update with the following to enable the NGINX Agent to be able to call the NGINX Plus API. | |
| ``` | |
| data_plane_config: | |
| nginx: | |
| api_tls: | |
| ca: "/etc/nginx/certs/nginx-selfsigned.crt" | |
| ``` | |
| #### Configure NGINX Agent to call the NGINX Plus API | |
| To enable the Agent to call the NGINX Plus API, follow the steps below: | |
| 1. `sudo vim /etc/nginx-agent/nginx-agent.conf` | |
| 2. Open the file for editing | |
| 3. Add the following configuration: | |
data_plane_config:
nginx:
api_tls:
ca: "/etc/nginx/certs/nginx-selfsigned.crt"
4. Save and Restart
`sudo systemctl restart nginx-agent`
5. Run the following `sudo journalctl -u nginx-agent | grep "NGINX Plus API"`
The following output should be shown: `NGINX Plus API found, NGINX Plus receiver enabled to scrape metrics`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩