From a1249704debe196edefeae1647076623ebfe9cff Mon Sep 17 00:00:00 2001
From: Andrea Boriero <andrea@hibernate.org>
Date: Wed, 15 Nov 2023 13:21:00 +0100
Subject: [PATCH] HHH-17347 Add Monitoring with Java Flight Recorder appendix
 to the documentation

---
 .../userguide/Hibernate_User_Guide.adoc       |  1 +
 .../userguide/appendices/Monitoring.adoc      | 27 +++++++++++++++++++
 2 files changed, 28 insertions(+)
 create mode 100644 documentation/src/main/asciidoc/userguide/appendices/Monitoring.adoc

diff --git a/documentation/src/main/asciidoc/userguide/Hibernate_User_Guide.adoc b/documentation/src/main/asciidoc/userguide/Hibernate_User_Guide.adoc
index d814f19e06..01e738fc3f 100644
--- a/documentation/src/main/asciidoc/userguide/Hibernate_User_Guide.adoc
+++ b/documentation/src/main/asciidoc/userguide/Hibernate_User_Guide.adoc
@@ -49,6 +49,7 @@ include::Credits.adoc[]
 include::appendices/SettingsReference.adoc[]
 include::appendices/LegacyBasicTypeResolution.adoc[]
 include::appendices/Legacy_Native_Queries.adoc[]
+include::appendices/Monitoring.adoc[]
 
 include::Bibliography.adoc[]
 
diff --git a/documentation/src/main/asciidoc/userguide/appendices/Monitoring.adoc b/documentation/src/main/asciidoc/userguide/appendices/Monitoring.adoc
new file mode 100644
index 0000000000..ac003b5b6f
--- /dev/null
+++ b/documentation/src/main/asciidoc/userguide/appendices/Monitoring.adoc
@@ -0,0 +1,27 @@
+[appendix]
+[[appendix-monitoring-with-JFR]]
+== Monitoring with Java Flight Recorder
+:sourcedir: extras
+
+Hibernate can provide an integration with Java Flight Recorder in order to monitor low level events like:
+
+* opening and closing of a Hibernate Session
+* acquisition and release of a JDBC connection
+* ``PreparedStatement``s creation and execution
+* batching execution
+* second level cache PUT and GET operation
+* flush and partial flush execution
+* dirty check calculation
+
+[IMPORTANT]
+====
+To use the Java Flight Recorder integration, the application must include the `hibernate-jfr` jar on the classpath
+====
+
+[NOTE]
+====
+The `hibernate-jfr` integration requires JDK 17 (it should work also with JDK 11, but we haven't tested it) that also supports Java Flight Recorder Events.
+====
+
+
+