Package org.hibernate.event.monitor.spi

Interface EventMonitor

All Known Subinterfaces:

EventManager

All Known Implementing Classes:

EmptyEventMonitor

@JavaServiceLoadable
@Incubating
public interface EventMonitor

Contract implemented by services which collect, report, or monitor diagnostic events involving interactions between the session and the database or second-level cache.

For example, this interface is implemented by Hibernate JFR to report events to Java Flight Recorder.

Note that event reporting is different to aggregate metrics, which Hibernate exposes via the Statistics interface.

Since:

7.0

API Note:

This an incubating API, subject to change.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EventMonitor.CacheActionDescription

Method Summary

Modifier and Type	Method	Description
DiagnosticEvent	beginCacheGetEvent()
DiagnosticEvent	beginCachePutEvent()
DiagnosticEvent	beginCollectionRecreateEvent()
DiagnosticEvent	beginCollectionRemoveEvent()
DiagnosticEvent	beginCollectionUpdateEvent()
DiagnosticEvent	beginDirtyCalculationEvent()
DiagnosticEvent	beginEntityDeleteEvent()
DiagnosticEvent	beginEntityInsertEvent()
DiagnosticEvent	beginEntityLockEvent()
DiagnosticEvent	beginEntityUpdateEvent()
DiagnosticEvent	beginEntityUpsertEvent()
DiagnosticEvent	beginFlushEvent()
DiagnosticEvent	beginJdbcBatchExecutionEvent()
DiagnosticEvent	beginJdbcConnectionAcquisitionEvent()
DiagnosticEvent	beginJdbcConnectionReleaseEvent()
DiagnosticEvent	beginJdbcPreparedStatementCreationEvent()
DiagnosticEvent	beginJdbcPreparedStatementExecutionEvent()
DiagnosticEvent	beginPartialFlushEvent()
DiagnosticEvent	beginPrePartialFlush()
DiagnosticEvent	beginSessionClosedEvent()
DiagnosticEvent	beginSessionOpenEvent()
void	completeCacheGetEvent(DiagnosticEvent cacheGetEvent, SharedSessionContractImplementor session, Region region, boolean hit)
void	completeCacheGetEvent(DiagnosticEvent cacheGetEvent, SharedSessionContractImplementor session, Region region, CollectionPersister persister, boolean hit)
void	completeCacheGetEvent(DiagnosticEvent cacheGetEvent, SharedSessionContractImplementor session, Region region, EntityPersister persister, boolean isNaturalKey, boolean hit)
void	completeCachePutEvent(DiagnosticEvent cachePutEvent, SharedSessionContractImplementor session, CachedDomainDataAccess cachedDomainDataAccess, CollectionPersister persister, boolean cacheContentChanged, EventMonitor.CacheActionDescription description)
void	completeCachePutEvent(DiagnosticEvent cachePutEvent, SharedSessionContractImplementor session, CachedDomainDataAccess cachedDomainDataAccess, EntityPersister persister, boolean cacheContentChanged, boolean isNatualId, EventMonitor.CacheActionDescription description)
void	completeCachePutEvent(DiagnosticEvent cachePutEvent, SharedSessionContractImplementor session, CachedDomainDataAccess cachedDomainDataAccess, EntityPersister persister, boolean cacheContentChanged, EventMonitor.CacheActionDescription description)
void	completeCachePutEvent(DiagnosticEvent cachePutEvent, SharedSessionContractImplementor session, Region region, boolean cacheContentChanged, EventMonitor.CacheActionDescription description)
void	completeCollectionRecreateEvent(DiagnosticEvent event, Object id, String role, boolean success, SharedSessionContractImplementor session)
void	completeCollectionRemoveEvent(DiagnosticEvent event, Object id, String role, boolean success, SharedSessionContractImplementor session)
void	completeCollectionUpdateEvent(DiagnosticEvent event, Object id, String role, boolean success, SharedSessionContractImplementor session)
void	completeDirtyCalculationEvent(DiagnosticEvent dirtyCalculationEvent, SharedSessionContractImplementor session, EntityPersister persister, EntityEntry entry, int[] dirtyProperties)
void	completeEntityDeleteEvent(DiagnosticEvent event, Object id, String entityName, boolean success, SharedSessionContractImplementor session)
void	completeEntityInsertEvent(DiagnosticEvent event, Object id, String entityName, boolean success, SharedSessionContractImplementor session)
void	completeEntityLockEvent(DiagnosticEvent event, Object id, String entityName, LockMode lockMode, boolean success, SharedSessionContractImplementor session)
void	completeEntityUpdateEvent(DiagnosticEvent event, Object id, String entityName, boolean success, SharedSessionContractImplementor session)
void	completeEntityUpsertEvent(DiagnosticEvent event, Object id, String entityName, boolean success, SharedSessionContractImplementor session)
void	completeFlushEvent(DiagnosticEvent flushEvent, FlushEvent event)
void	completeFlushEvent(DiagnosticEvent flushEvent, FlushEvent event, boolean autoFlush)
void	completeJdbcBatchExecutionEvent(DiagnosticEvent jdbcBatchExecutionEvent, String statementSql)
void	completeJdbcConnectionAcquisitionEvent(DiagnosticEvent jdbcConnectionAcquisitionEvent, SharedSessionContractImplementor session, Object tenantId)
void	completeJdbcConnectionReleaseEvent(DiagnosticEvent jdbcConnectionReleaseEvent, SharedSessionContractImplementor session, Object tenantId)
void	completeJdbcPreparedStatementCreationEvent(DiagnosticEvent jdbcPreparedStatementCreation, String preparedStatementSql)
void	completeJdbcPreparedStatementExecutionEvent(DiagnosticEvent jdbcPreparedStatementExecutionEvent, String preparedStatementSql)
void	completePartialFlushEvent(DiagnosticEvent flushEvent, AutoFlushEvent event)
void	completePrePartialFlush(DiagnosticEvent prePartialFlush, SharedSessionContractImplementor session)
void	completeSessionClosedEvent(DiagnosticEvent sessionClosedEvent, SharedSessionContractImplementor session)
void	completeSessionOpenEvent(DiagnosticEvent sessionOpenEvent, SharedSessionContractImplementor session)

Method Details

beginSessionOpenEvent

DiagnosticEvent beginSessionOpenEvent()

completeSessionOpenEvent

void completeSessionOpenEvent(DiagnosticEvent sessionOpenEvent,
 SharedSessionContractImplementor session)

beginSessionClosedEvent

DiagnosticEvent beginSessionClosedEvent()

completeSessionClosedEvent

void completeSessionClosedEvent(DiagnosticEvent sessionClosedEvent,
 SharedSessionContractImplementor session)

beginJdbcConnectionAcquisitionEvent

DiagnosticEvent beginJdbcConnectionAcquisitionEvent()

completeJdbcConnectionAcquisitionEvent

void completeJdbcConnectionAcquisitionEvent(DiagnosticEvent jdbcConnectionAcquisitionEvent,
 SharedSessionContractImplementor session,
 Object tenantId)

beginJdbcConnectionReleaseEvent

DiagnosticEvent beginJdbcConnectionReleaseEvent()

completeJdbcConnectionReleaseEvent

void completeJdbcConnectionReleaseEvent(DiagnosticEvent jdbcConnectionReleaseEvent,
 SharedSessionContractImplementor session,
 Object tenantId)

beginJdbcPreparedStatementCreationEvent

DiagnosticEvent beginJdbcPreparedStatementCreationEvent()

completeJdbcPreparedStatementCreationEvent

void completeJdbcPreparedStatementCreationEvent(DiagnosticEvent jdbcPreparedStatementCreation,
 String preparedStatementSql)

beginJdbcPreparedStatementExecutionEvent

DiagnosticEvent beginJdbcPreparedStatementExecutionEvent()

completeJdbcPreparedStatementExecutionEvent

void completeJdbcPreparedStatementExecutionEvent(DiagnosticEvent jdbcPreparedStatementExecutionEvent,
 String preparedStatementSql)

beginJdbcBatchExecutionEvent

DiagnosticEvent beginJdbcBatchExecutionEvent()

completeJdbcBatchExecutionEvent

void completeJdbcBatchExecutionEvent(DiagnosticEvent jdbcBatchExecutionEvent,
 String statementSql)

beginCachePutEvent

DiagnosticEvent beginCachePutEvent()

completeCachePutEvent

void completeCachePutEvent(DiagnosticEvent cachePutEvent,
 SharedSessionContractImplementor session,
 Region region,
 boolean cacheContentChanged,
 EventMonitor.CacheActionDescription description)

completeCachePutEvent

void completeCachePutEvent(DiagnosticEvent cachePutEvent,
 SharedSessionContractImplementor session,
 CachedDomainDataAccess cachedDomainDataAccess,
 EntityPersister persister,
 boolean cacheContentChanged,
 EventMonitor.CacheActionDescription description)

completeCachePutEvent

void completeCachePutEvent(DiagnosticEvent cachePutEvent,
 SharedSessionContractImplementor session,
 CachedDomainDataAccess cachedDomainDataAccess,
 EntityPersister persister,
 boolean cacheContentChanged,
 boolean isNatualId,
 EventMonitor.CacheActionDescription description)

completeCachePutEvent

void completeCachePutEvent(DiagnosticEvent cachePutEvent,
 SharedSessionContractImplementor session,
 CachedDomainDataAccess cachedDomainDataAccess,
 CollectionPersister persister,
 boolean cacheContentChanged,
 EventMonitor.CacheActionDescription description)

beginCacheGetEvent

DiagnosticEvent beginCacheGetEvent()

completeCacheGetEvent

void completeCacheGetEvent(DiagnosticEvent cacheGetEvent,
 SharedSessionContractImplementor session,
 Region region,
 boolean hit)

completeCacheGetEvent

void completeCacheGetEvent(DiagnosticEvent cacheGetEvent,
 SharedSessionContractImplementor session,
 Region region,
 EntityPersister persister,
 boolean isNaturalKey,
 boolean hit)

completeCacheGetEvent

void completeCacheGetEvent(DiagnosticEvent cacheGetEvent,
 SharedSessionContractImplementor session,
 Region region,
 CollectionPersister persister,
 boolean hit)

beginFlushEvent

DiagnosticEvent beginFlushEvent()

completeFlushEvent

void completeFlushEvent(DiagnosticEvent flushEvent,
 FlushEvent event)

completeFlushEvent

void completeFlushEvent(DiagnosticEvent flushEvent,
 FlushEvent event,
 boolean autoFlush)

beginPartialFlushEvent

DiagnosticEvent beginPartialFlushEvent()

completePartialFlushEvent

void completePartialFlushEvent(DiagnosticEvent flushEvent,
 AutoFlushEvent event)

beginDirtyCalculationEvent

DiagnosticEvent beginDirtyCalculationEvent()

completeDirtyCalculationEvent

void completeDirtyCalculationEvent(DiagnosticEvent dirtyCalculationEvent,
 SharedSessionContractImplementor session,
 EntityPersister persister,
 EntityEntry entry,
 int[] dirtyProperties)

beginPrePartialFlush

DiagnosticEvent beginPrePartialFlush()

completePrePartialFlush

void completePrePartialFlush(DiagnosticEvent prePartialFlush,
 SharedSessionContractImplementor session)

beginEntityInsertEvent

DiagnosticEvent beginEntityInsertEvent()

completeEntityInsertEvent

void completeEntityInsertEvent(DiagnosticEvent event,
 Object id,
 String entityName,
 boolean success,
 SharedSessionContractImplementor session)

beginEntityUpdateEvent

DiagnosticEvent beginEntityUpdateEvent()

completeEntityUpdateEvent

void completeEntityUpdateEvent(DiagnosticEvent event,
 Object id,
 String entityName,
 boolean success,
 SharedSessionContractImplementor session)

beginEntityUpsertEvent

DiagnosticEvent beginEntityUpsertEvent()

completeEntityUpsertEvent

void completeEntityUpsertEvent(DiagnosticEvent event,
 Object id,
 String entityName,
 boolean success,
 SharedSessionContractImplementor session)

beginEntityDeleteEvent

DiagnosticEvent beginEntityDeleteEvent()

completeEntityDeleteEvent

void completeEntityDeleteEvent(DiagnosticEvent event,
 Object id,
 String entityName,
 boolean success,
 SharedSessionContractImplementor session)

beginEntityLockEvent

DiagnosticEvent beginEntityLockEvent()

completeEntityLockEvent

void completeEntityLockEvent(DiagnosticEvent event,
 Object id,
 String entityName,
 LockMode lockMode,
 boolean success,
 SharedSessionContractImplementor session)

beginCollectionRecreateEvent

DiagnosticEvent beginCollectionRecreateEvent()

completeCollectionRecreateEvent

void completeCollectionRecreateEvent(DiagnosticEvent event,
 Object id,
 String role,
 boolean success,
 SharedSessionContractImplementor session)

beginCollectionUpdateEvent

DiagnosticEvent beginCollectionUpdateEvent()

completeCollectionUpdateEvent

void completeCollectionUpdateEvent(DiagnosticEvent event,
 Object id,
 String role,
 boolean success,
 SharedSessionContractImplementor session)

beginCollectionRemoveEvent

DiagnosticEvent beginCollectionRemoveEvent()

completeCollectionRemoveEvent

void completeCollectionRemoveEvent(DiagnosticEvent event,
 Object id,
 String role,
 boolean success,
 SharedSessionContractImplementor session)