Skip to content

Update overview doc to include user-specified logging #550

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
mum4k merged 7 commits into from
Oct 5, 2020
Merged

Update overview doc to include user-specified logging #550

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fadb4fd
add customized logging to overview doc
jiajunye Sep 23, 2020
f8dfdd7
update format
jiajunye Sep 23, 2020
701ab40
enhance readability
jiajunye Sep 24, 2020
c5a9783
minor update
jiajunye Sep 25, 2020
3561acf
Merge branch 'master' into update_overview_doc
jiajunye Sep 25, 2020
3bedae8
fix typo
jiajunye Oct 2, 2020
0edbf0f
Merge branch 'master' into update_overview_doc
jiajunye Oct 2, 2020
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
8 changes: 8 additions & 0 deletions docs/root/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,3 +189,11 @@ other formats (e.g. human, fortio). It can be very useful to always store the
json output format, yet be able to easily get to one of the other output
formats. It’s like having the cake and eating it too!

## User-specified Nighthawk logging

Users of Nighthawk can specify custom format and destination (logging sink
delegate) for all Nighthawk logging messages. Nighthawk utilizes the Envoy's
logging mechanism by performing all logging via the **ENVOY_LOG** macro. To
customize this mechanism, users need to perform two steps:
1. Create a logging sink delegate inherited from [Envoy SinkDelegate](https://github.com/envoyproxy/envoy/blob/master/source/common/common/logger.h).
2. Construct a ServiceImpl object with an [Envoy Logger Context](https://github.com/envoyproxy/envoy/blob/master/source/common/common/logger.h) which contains user-specified log level and format.