Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

mention Hibernate JFR in the Short Guide

This commit is contained in:
Gavin King 2024-12-16 01:52:06 +01:00
parent 597f74f23e
commit af679e1d96
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
documentation/src/main/asciidoc/introduction/Configuration.adoc
View File

@ -121,6 +121,7 @@ and `com.github.ben-manes.caffeine:jcache`
or `org.eclipse:yasson` or `org.eclipse:yasson`
| <<spatial,Hibernate Spatial>> | `org.hibernate.orm:hibernate-spatial` | <<spatial,Hibernate Spatial>> | `org.hibernate.orm:hibernate-spatial`
| <<envers,Envers>>, for auditing historical data | `org.hibernate.orm:hibernate-envers` | <<envers,Envers>>, for auditing historical data | `org.hibernate.orm:hibernate-envers`
| <<jfr,Hibernate JFR>>, for monitoring via Java Flight Recorder | `org.hibernate.orm:hibernate-jfr`
|=== |===
You might also add the Hibernate {enhancer}[bytecode enhancer] to your You might also add the Hibernate {enhancer}[bytecode enhancer] to your

11
documentation/src/main/asciidoc/introduction/Tuning.adoc
View File

@ -992,6 +992,17 @@ long publisherCacheMissCount =
Hibernate's statistics enable observability. Hibernate's statistics enable observability.
Both {micrometer}[Micrometer] and {smallrye-metrics}[SmallRye Metrics] are capable of exposing these metrics. Both {micrometer}[Micrometer] and {smallrye-metrics}[SmallRye Metrics] are capable of exposing these metrics.
[[jfr]]
=== Using Java Flight Recorder
Hibernate JFR is a separate module which reports events to link:https://developers.redhat.com/blog/2020/08/25/get-started-with-jdk-flight-recorder-in-openjdk-8u[Java Flight Recorder].
This is different to reporting aggregated <<statistics,metrics>> via a tool like Micrometer, since JFR records information about the timing and duration of each discrete event, along with a stack trace.
If anything, the information reported by JFR is a little _too_ detailed to make it really useful for performance tuning--it's perhaps more useful for _troubleshooting_.
No special configuration is required to use Hibernate JFR.
Just include `org.hibernate.orm:hibernate-jfr` as a runtime dependency.
In particular, you _don't_ need to enable `hibernate.generate_statistics`.
[[slow-queries]] [[slow-queries]]
=== Tracking down slow queries === Tracking down slow queries