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

Rename gc_total_time to gc_time #874

Merged
merged 2 commits into from
Aug 4, 2022
Merged

Rename gc_total_time to gc_time #874

merged 2 commits into from
Aug 4, 2022

Conversation

tombruijn
Copy link
Member

@tombruijn tombruijn commented Aug 4, 2022

Update naming to only be about the time measured.

It no longer reports the total time, but reports the delta of two
measurements.

Part of #868

Update naming to only be about the time measured.

It no longer reports the total time, but reports the delta of two
measurements.

Part of #868
@backlog-helper
Copy link

backlog-helper bot commented Aug 4, 2022

✔️ All good!

New issue guide | Backlog management | Rules | Feedback

I forgot to add it to the original commit. Let's squash merge the PR
this is a part of.

[skip ci]
type: "change"
---

Rename the (so far privately reported) `gc_total_time` metric to `gc_time`. It no longer reports the total time of Garbage Collection measured, but only the time between two (minutely) measurements.
Copy link
Contributor

Choose a reason for hiding this comment

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

What is meant by "privately reported"?

Copy link
Member Author

Choose a reason for hiding this comment

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

I mean we don't show it anywhere. We added it for the Ruby VM dashboard but then took the graph display it out at the last minute. People could make a graph themselves, but they'd have to find it in the reported metrics list and then they probably don't know what the values mean. So privately because it wasn't shown anywhere and it's not documented anywhere.

@tombruijn tombruijn merged commit dc50d88 into main Aug 4, 2022
tombruijn added a commit to appsignal/public_config that referenced this pull request Aug 4, 2022
Add the Garbage Collection time graph back to the Ruby VM dashboard
after it was added and removed in PR
#38.

I've updated the metric name to `gc_time` in Ruby gem PR:
appsignal/appsignal-ruby#874

This graph will not have any data by default. We need a way to redirect
users to our docs on how to enable this. We also need to write docs for
this, basically saying: Add `GC::Profiler.enable` to your app, but not
in production or not for long in production because it may adversely
impact the performance of your app.

Also, to update existing dashboards, I refer to the dashboard update
issue we should pick up:
appsignal/appsignal-server#4770

Part of appsignal/appsignal-ruby#868
tombruijn added a commit to appsignal/public_config that referenced this pull request Aug 4, 2022
Add the Garbage Collection time graph back to the Ruby VM dashboard
after it was added and removed in PR
#38.

I've updated the metric name to `gc_time` in Ruby gem PR:
appsignal/appsignal-ruby#874

This graph will not have any data by default. We need a way to redirect
users to our docs on how to enable this. We cannot link to this from the
graph description.

We also need to write docs for this, basically saying: Add
`GC::Profiler.enable` to your app, but not in production or not for long
in production because it may adversely impact the performance of your
app.

Also, to update existing dashboards, I refer to the dashboard update
issue we should pick up:
appsignal/appsignal-server#4770

Part of appsignal/appsignal-ruby#868
tombruijn added a commit to appsignal/public_config that referenced this pull request Aug 5, 2022
Add the Garbage Collection time graph back to the Ruby VM dashboard
after it was added and removed in PR
#38.

I've updated the metric name to `gc_time` in Ruby gem PR because it
doesn't report the total time anymore:
appsignal/appsignal-ruby#874
appsignal/appsignal-ruby#867

This graph will not have any data by default. We need a way to direct
users to our docs on how to enable this. We cannot link to this from the
graph description that I could tell, the graph description does not
support any link format.

We need to write some docs for this, basically saying: Add
`GC::Profiler.enable` to your app, but not in production or not for long
in production because it may negatively impact the performance of your
app.

Also, to update existing dashboards, I refer to the dashboard update
issue we should pick up:
appsignal/appsignal-server#4770

Part of appsignal/appsignal-ruby#868
@tombruijn tombruijn mentioned this pull request Aug 5, 2022
10 tasks
tombruijn added a commit to appsignal/public_config that referenced this pull request Aug 15, 2022
Add the Garbage Collection time graph back to the Ruby VM dashboard
after it was added and removed in PR
#38.

I've updated the metric name to `gc_time` in Ruby gem PR because it
doesn't report the total time anymore:
appsignal/appsignal-ruby#874
appsignal/appsignal-ruby#867

This graph will not have any data by default. We need a way to direct
users to our docs on how to enable this. We cannot link to this from the
graph description that I could tell, the graph description does not
support any link format.

We need to write some docs for this, basically saying: Add
`GC::Profiler.enable` to your app, but not in production or not for long
in production because it may negatively impact the performance of your
app.

Also, to update existing dashboards, I refer to the dashboard update
issue we should pick up:
appsignal/appsignal-server#4770

Part of appsignal/appsignal-ruby#868
@tombruijn tombruijn deleted the gc-time-metric branch July 31, 2023 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants