generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 89
Add steps to enable NGINX Plus API and NGINX OSS stub_status for metrics reporting #227
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
4e58cde
Add steps to enable NGINX Plus API and NGINX OSS stub_status for metr…
travisamartin 2b2f88b
Merge branch 'main' into 1433-enable-nginx-plus-api
ADubhlaoich d75b5b3
edits
travisamartin 4598c15
Merge branch '1433-enable-nginx-plus-api' of https://github.com/nginx…
travisamartin 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
33 changes: 33 additions & 0 deletions
33
content/includes/use-cases/monitoring/enable-nginx-oss-stub-status.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,33 @@ | ||
--- | ||
docs: | ||
files: | ||
- content/nim/monitoring/overview-metrics.md | ||
- content/nginx-one/getting-started.md | ||
--- | ||
|
||
To collect basic metrics about server activity for NGINX Open Source, 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; | ||
} | ||
} | ||
``` | ||
|
||
This configuration: | ||
|
||
- Enables the stub status API. | ||
- 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). | ||
|
||
After saving the changes, reload NGINX to apply the new configuration: | ||
|
||
```shell | ||
nginx -s reload | ||
``` |
33 changes: 33 additions & 0 deletions
33
content/includes/use-cases/monitoring/enable-nginx-plus-api.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,33 @@ | ||
--- | ||
docs: | ||
files: | ||
- content/nim/monitoring/overview-metrics.md | ||
- content/nginx-one/getting-started.md | ||
--- | ||
|
||
To collect comprehensive metrics for NGINX Plus--including bytes streamed, information about upstream systems and caches, and counts of all HTTP status codes--add the following to your NGINX Plus configuration file (for example, `/etc/nginx/nginx.conf` or an included file): | ||
travisamartin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```nginx | ||
# Enable the /api/ location with appropriate access control | ||
# to use the NGINX Plus API. | ||
# | ||
location /api/ { | ||
api write=on; | ||
allow 127.0.0.1; | ||
deny all; | ||
} | ||
``` | ||
|
||
This configuration: | ||
|
||
- Enables the NGINX Plus API. | ||
- Allows requests only from `127.0.0.1` (localhost). | ||
- Blocks all other requests for security. | ||
|
||
For more details, see the [NGINX Plus API module documentation](https://nginx.org/en/docs/http/ngx_http_api_module.html). | ||
|
||
After saving the changes, reload NGINX to apply the new configuration: | ||
|
||
```shell | ||
nginx -s reload | ||
``` |
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.
Uh oh!
There was an error while loading. Please reload this page.