generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 123
Update N1C getting started guide with instructions on how to enable metrics collection for a NGINX Plus API with SSL enabled #1496
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
Draft
dhurley
wants to merge
3
commits into
main
Choose a base branch
from
add-plus-api-with-ssl-agent-instructions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
53 changes: 53 additions & 0 deletions
53
content/includes/use-cases/monitoring/enable-nginx-oss-metrics.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| nd-product: MSC | ||
| nd-files: | ||
| - content/nginx-one-console/getting-started.md | ||
| - content/nginx-one-console/nginx-configs/metrics/enable-metrics.md | ||
| - content/nim/monitoring/overview-metrics.md | ||
| - content/nim/nginx-instances/add-instance.md | ||
| --- | ||
|
|
||
| To collect basic metrics about server activity for NGINX Open Source: | ||
|
|
||
| 1. **Enable the stub status API** | ||
|
|
||
| Add the following to your NGINX configuration file: | ||
|
|
||
| ```nginx | ||
| server { | ||
| listen 127.0.0.1:8080; | ||
| location /api { | ||
| stub_status; | ||
| allow 127.0.0.1; | ||
| deny all; | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| {{<call-out type="important" title="Important">}} | ||
| Make sure that the `server` and `location` blocks are in the same single configuration file, and not split across multiple files using `include` directives. | ||
| {{</call-out>}} | ||
|
|
||
| This configuration: | ||
|
|
||
| - Enables the stub status API endpoint | ||
| - Allows requests only from `127.0.0.1` (localhost). | ||
| - Blocks all other requests for security. | ||
|
|
||
| For more details, see the [NGINX Stub Status module documentation](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html). | ||
|
|
||
| 2. **Configure access logging** | ||
|
|
||
| Enable access logging in your NGINX configuration to collect detailed traffic metrics. Ensure that the following log format is used: | ||
|
|
||
| ```nginx | ||
| log_format main '$remote_addr - $remote_user [$time_local] "$request" ' | ||
| '$status $body_bytes_sent "$http_referer" ' | ||
| '"$http_user_agent" "$http_x_forwarded_for" ' | ||
| '"$bytes_sent" "$request_length" "$request_time" ' | ||
| '"$gzip_ratio" $server_protocol '; | ||
|
|
||
| access_log /var/log/nginx/access.log main; | ||
| ``` | ||
|
|
||
| This log format captures key metrics including request timing, response sizes and client information. |
29 changes: 0 additions & 29 deletions
29
content/includes/use-cases/monitoring/enable-nginx-oss-stub-status.md
This file was deleted.
Oops, something went wrong.
58 changes: 58 additions & 0 deletions
58
content/includes/use-cases/monitoring/enable-nginx-plus-api-with-ssl.md
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,58 @@ | ||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||
| nd-product: MSC | ||||||||||||||||||||||||||||||||||||
| nd-files: | ||||||||||||||||||||||||||||||||||||
| - content/nginx-one-console/getting-started.md | ||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| If SSL is enabled on the NGINX Plus API with self-signed certificates like this example: | ||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| ```nginx | ||||||||||||||||||||||||||||||||||||
| # This block enables the NGINX Plus API and dashboard with SSL | ||||||||||||||||||||||||||||||||||||
| # For configuration and security recommendations, see: | ||||||||||||||||||||||||||||||||||||
| # https://docs.nginx.com/nginx/admin-guide/monitoring/live-activity-monitoring/#configuring-the-api | ||||||||||||||||||||||||||||||||||||
| server { | ||||||||||||||||||||||||||||||||||||
| # Change the listen port if 9000 conflicts | ||||||||||||||||||||||||||||||||||||
| # (8080 is the conventional API port) | ||||||||||||||||||||||||||||||||||||
| listen 9000 ssl; | ||||||||||||||||||||||||||||||||||||
| ssl_certificate /etc/nginx/certs/nginx-selfsigned.crt; | ||||||||||||||||||||||||||||||||||||
| ssl_certificate_key /etc/nginx/certs/nginx-selfsigned.key; | ||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| location /api/ { | ||||||||||||||||||||||||||||||||||||
| # To restrict write methods (POST, PATCH, DELETE), uncomment: | ||||||||||||||||||||||||||||||||||||
| # limit_except GET { | ||||||||||||||||||||||||||||||||||||
| # auth_basic "NGINX Plus API"; | ||||||||||||||||||||||||||||||||||||
| # auth_basic_user_file /path/to/passwd/file; | ||||||||||||||||||||||||||||||||||||
| # } | ||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| # Enable API in write mode | ||||||||||||||||||||||||||||||||||||
| api write=on; | ||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| # To restrict access by network, uncomment the following lines and set your network: | ||||||||||||||||||||||||||||||||||||
| # allow 192.0.2.0/24; # replace with your network | ||||||||||||||||||||||||||||||||||||
| # allow 127.0.0.1/32; # allow local NGINX Agent to call the NGINX Plus API to retrieve metrics | ||||||||||||||||||||||||||||||||||||
| # deny all; | ||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| # Serve the built-in dashboard at /dashboard.html | ||||||||||||||||||||||||||||||||||||
| location = /dashboard.html { | ||||||||||||||||||||||||||||||||||||
| root /usr/share/nginx/html; | ||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| {{<call-out type="important" title="Important">}} | ||||||||||||||||||||||||||||||||||||
| Make sure that the `server` and `location` blocks are in the same single configuration file, and not split across multiple files using `include` directives. | ||||||||||||||||||||||||||||||||||||
| {{</call-out>}} | ||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| 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" | ||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||
|
Comment on lines
+47
to
+53
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
data_plane_config: |
||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| Here is an example of how to generate self-signed certificates | ||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||
| openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/nginx/certs/nginx-selfsigned.key -out /etc/nginx/certs/nginx-selfsigned.crt -subj "/CN=localhost" -addext "subjectAltName=IP:127.0.0.1" | ||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think we can take out the commented section for http basic auth. Keep the example clear for ssl only.