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

Add query to cache_hit trace event #64

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## master

- [PR#64](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/64)
Add query to cache_hit trace event ([@DmitryTsepelev][])

## 1.7.0 (2023-02-02)

- [PR#62](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/62)
Expand Down
2 changes: 1 addition & 1 deletion docs/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class MyPersistedQueriesTracer
case key
when "persisted_queries.fetch_query.cache_hit"
# data = { adapter: :redis }
# result = nil
# result = query string that got hit
# increment a counter metric to track cache hits
when "persisted_queries.fetch_query.cache_miss"
# data = { adapter: :redis }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,11 @@ def fetch_query(hash, options = {})
key = build_key(hash, compiled_query)

fetch(key).tap do |result|
event = result ? "cache_hit" : "cache_miss"
trace("fetch_query.#{event}", adapter: @name)
if result
trace("fetch_query.cache_hit", adapter: @name) { result }
else
trace("fetch_query.cache_miss", adapter: @name)
end
end
end

Expand Down
2 changes: 1 addition & 1 deletion spec/graphql/persisted_queries/schema_patch_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ def perform_request(with_tracer: false, with_query: true)
perform_request(with_tracer: true)
perform_request(with_tracer: true, with_query: false)
events = tracer.events["persisted_queries.fetch_query.cache_hit"]
expect(events).to eq([{ metadata: { adapter: :memory }, result: nil }])
expect(events).to eq([{ metadata: { adapter: :memory }, result: query }])
end
end

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ def save(hash, query)
expect(tracer.events).to eq(
"persisted_queries.fetch_query.cache_hit" => [{
metadata: { adapter: :testable },
result: nil
result: "welcome-to-paradise"
}]
)
end
Expand Down