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

Change server_puppetserver_profiler and server_puppetserver_metrics defaults to true #825

Merged
merged 2 commits into from
Apr 5, 2022

Conversation

alexjfisher
Copy link
Contributor

@alexjfisher alexjfisher commented Feb 21, 2022

Puppet Inc. enabled the profiler by default in Puppetserver 5.0.0
https://tickets.puppetlabs.com/browse/SERVER-1761

This module has been disabling by default though causing users to be
missing metrics they might reasonably expect to be present after reading
through the Puppetserver documentation.

EDIT
Also changed server_puppetserver_metrics (which enables http-client metrics) to true

@ekohl
Copy link
Member

ekohl commented Feb 21, 2022

In 12154ce it was split into two different parameters.

If metrics depend on the profiler, should we make it catalog compilation fail on it?

@alexjfisher
Copy link
Contributor Author

Only some metrics depend on this setting. eg. the compiler and function metrics. With the profiler off, you still get the jvm and jruby metrics etc.

@alexjfisher alexjfisher marked this pull request as draft February 21, 2022 11:37
@alexjfisher alexjfisher changed the title Change server_puppetserver_profiler default to true Change server_puppetserver_profiler and server_puppetserver_profiler defaults to true Feb 28, 2022
@alexjfisher alexjfisher marked this pull request as ready for review February 28, 2022 14:36
@alexjfisher alexjfisher changed the title Change server_puppetserver_profiler and server_puppetserver_profiler defaults to true Change server_puppetserver_profiler and server_puppetserver_metrics defaults to true Mar 8, 2022
@alexjfisher alexjfisher requested a review from ekohl March 31, 2022 13:35
Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

Overall 👍 but some bikeshedding about the description.

@@ -439,10 +439,11 @@
# Defaults to 30000, using the Jetty default of 30s
#
# $server_puppetserver_metrics:: Enable puppetserver http-client metrics
# Defaults to false because that's the Puppet Inc. default behaviour.
# Defaults to true because that's the Puppet Inc. default behaviour (since Puppetserver 5.0.0).
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if we even need to mention the default at all, but perhaps shorten it?

Suggested change
# Defaults to true because that's the Puppet Inc. default behaviour (since Puppetserver 5.0.0).
# Defaults to true, matching defaults in Puppetserver 5+.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated and rebased.

#
# $server_puppetserver_profiler:: Enable JRuby profiling.
# Defaults to false because that's the Puppet Inc. default behaviour.
# Defaults to true because that's the Puppet Inc. default behaviour (since Puppetserver 5.0.0).
Copy link
Member

Choose a reason for hiding this comment

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

Same comment here about the defaults.

@ekohl
Copy link
Member

ekohl commented Apr 4, 2022

Also, could you rebase? I'd expect the tests to pass then.

Puppet Inc. enabled the profiler by default in Puppetserver 5.0.0
https://tickets.puppetlabs.com/browse/SERVER-1761

This module has been disabling by default though causing users to be
missing metrics they might reasonably expect to be present after reading
through the
[Puppetserver documentation](https://puppet.com/docs/puppet/6/server/puppet_server_metrics.html#compiler-metrics).
The default in Puppetserver is actually `true`, not `false`.

(IMO, `server_puppetserver_metrics` isn't a great parameter name as its
actual purpose is to configure whether http client metrics are
collected, and has no impact on the much greater number of other metrics
still collected when this is set to `false`.)
Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

Thanks!

@ekohl ekohl merged commit b6dd984 into theforeman:master Apr 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants