Updated README.md, SECURITY.md and OSS Docs Structure #124
Conversation
This file contains 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
Need to remove the reference to the email list from the README to avoid confusion
…larified mock control plane usage via REST
…Prometheus and Grafana in the Collecting Metrics section.
corrected to "aggregated"
lcrilly
suggested changes
Nov 29, 2022
… nginx-agent.tar.gz, warn user to use ./ before the package name when installing packages with apt, provide alternate Go installation instructions.
craigell
reviewed
Nov 30, 2022
| ### NGINX Open Source | ||
| When running alongside an open source instance of NGINX, Agent requires that NGINX Access and Error logs are turned on and contain all default variables. | ||
|
|
||
| ### NGINX Plus |
There was a problem hiding this comment.
NGINX Open Source and NGINX Plus headers are different headers than the others?
## NGINX Open Source
craigell
reviewed
Nov 30, 2022
|
|
||
| ## Getting started with Agent | ||
| ## Logging | ||
| Agent uses formatted log files to collect metrics. Expanding log formats and instance counts will also increase the size of Agent log files. We recommend adding a separate partition for `/var/log/nginx-agent`. Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services. |
There was a problem hiding this comment.
We should mention that they can change the log location via the nginx-agent.conf
log: level: info path: /var/log/nginx-agent/
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
Overhaul of README.md file in support of open source launch. Moved open source docs out of /docs dir and updated SECURITY.md file to align with F5 guidelines.
Checklist
Before creating a PR, run through this checklist and mark each as complete.
CONTRIBUTINGdocumentREADME.md)