Skip to content
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

Documentation skeleton #62

Merged
merged 2 commits into from
Apr 19, 2023
Merged

Documentation skeleton #62

merged 2 commits into from
Apr 19, 2023

Conversation

mariomac
Copy link
Contributor

Updates README and provides some placeholders to start writing the documentation and tutorials.

@mariomac mariomac requested a review from grcevski April 18, 2023 14:14
@codecov-commenter
Copy link

codecov-commenter commented Apr 18, 2023

Codecov Report

Merging #62 (0b3a16c) into main (43ae3d4) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #62   +/-   ##
=======================================
  Coverage   48.77%   48.77%           
=======================================
  Files          15       15           
  Lines        1060     1060           
=======================================
  Hits          517      517           
  Misses        501      501           
  Partials       42       42           
Flag Coverage Δ
unittests 48.77% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Contributor

@grcevski grcevski left a comment

Choose a reason for hiding this comment

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

LGTM! One minor comment, we can update that later :)

* Using ringbuffer instead of perf_buffer
* despite the name, ringbuffer is faster
* We return status code
* We provide goroutine wait time (since the connection is accepted until the request is processed) for more accurate
metrics on overload scenarios.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we mention we also capture request sizes for HTTP?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure! I forgot it

@mariomac mariomac merged commit a120ddb into grafana:main Apr 19, 2023
2 checks passed
@mariomac mariomac deleted the docs branch April 19, 2023 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants