Skip to content

Update admin.rst to include profile_path #611

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.

Sign up for GitHub

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
mattklein123 merged 13 commits into from
Mar 23, 2017
Merged

Update admin.rst to include profile_path #611

Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
6a3b748
Update handlerCpuProfiler and add profiler_path
hennna Mar 21, 2017
2059a8b
Clean up profiler and admin_test files
hennna Mar 21, 2017
45eeba9
Fix address asan build fail in Cpu::startProfiler()
hennna Mar 22, 2017
f9968bb
Clean up profiler and admin_test files v2
hennna Mar 22, 2017
9e3ae3d
Edit addressing comments
hennna Mar 22, 2017
a92b095
Merge remote-tracking branch 'upstream/master' into issue-596
hennna Mar 22, 2017
0aa7ac9
Allow admin profile_path JSON configurability
hennna Mar 22, 2017
8dd2764
Address comments for JSON configurability
hennna Mar 22, 2017
f588978
Update admin.rst
hennna Mar 22, 2017
4fb8283
Merge branch 'patch-1'
hennna Mar 23, 2017
5365759
Delete extra line
hennna Mar 23, 2017
6a2a3fb
Add blank lines between items
hennna Mar 23, 2017
f74ac43
Change port to address to match json schema
hennna Mar 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/configuration/overview/admin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,18 @@ Administration interface :ref:`operations documentation <operations_admin_interf

{
"access_log_path": "...",
"profile_path": "...",
"port": "..."

@RomanDzhabarov RomanDzhabarov Mar 23, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, not your change, but can you fix that to address

}

access_log_path
*(required, string)* The path to write the access log for the administration server. If no
access log is desired specify '/dev/null'.

profile_path
*(optional, string)* The cpu profiler output path for the administration server. If no profile
path is specified, the default is '/var/log/envoy/envoy.prof'.

address

@mattklein123 mattklein123 Mar 23, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: newline before this line.

@mattklein123 mattklein123 Mar 23, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I meant please keep a blank line between attributes as per the rest of the documentation.

@hennna hennna Mar 23, 2017

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry. I should have noticed that.

*(required, string)* The TCP address that the administration server will listen on, e.g.,
"tcp://127.0.0.1:1234". Note, "tcp://0.0.0.0:1234" is the wild card match for any IPv4 address
Expand Down