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.

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

Jump to bottom

reformat metrics section of readme for readability #807

Merged
merged 1 commit into from
Nov 18, 2023
Merged

reformat metrics section of readme for readability #807

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 13 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,18 +156,19 @@ Internal Metrics
----------------------------------
The internal metrics are configured inside the [graphite](https://github.com/go-graphite/carbonapi/blob/main/doc/configuration.md#graphite) subsection and sent to your destinated host on an specified interval. The metrics are:

cache_items - if caching is enabled, this metric will contain many metrics are stored in cache
cache_size - configured query cache size in bytes
request_cache_hits - how many requests were served from cache. (this is for requests to /render endpoint)
request_cache_misses - how many requests were not in cache. (this is for requests to /render endpoint)
request_cache_overhead_ns - how much time in ns it took to talk to cache (that is useful to assess if cache actually helps you in terms of latency) (this is for requests to /render endpoint)
find_requests - requests server by endpoint /metrics/find
requests - requests served by endpoint /render
requests_in_XX_to_XX - request response times in percentiles
timeouts - number of timeouts while fetching from backend
backend_cache_hits - how many requests were not read from backend
backend_cache_misses - how many requests were not found in the backend

| Metric Name | Description |
| ----------- | ----------- |
| cache_items | if caching is enabled, this metric will contain many metrics are stored in cache |
| cache_size | configured query cache size in bytes |
| request_cache_hits | how many requests were served from cache. (this is for requests to /render endpoint) |
| request_cache_misses | how many requests were not in cache. (this is for requests to /render endpoint) |
| request_cache_overhead_ns | how much time in ns it took to talk to cache (that is useful to assess if cache actually helps you in terms of latency) (this is for |requests to /render endpoint)
| find_requests | requests server by endpoint /metrics/find |
| requests | requests served by endpoint /render |
| requests_in_XX_to_XX | request response times in percentiles |
| timeouts | number of timeouts while fetching from backend |
| backend_cache_hits | how many requests were not read from backend |
| backend_cache_misses | how many requests were not found in the backend |

OSX Build Notes
---------------
Expand Down
Loading