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

Improve the logging report 

(cherry picked from commit 11b051ba95)
This commit is contained in:
Steve Ebersole 2023-04-26 22:57:15 -05:00
parent 2e303c4b0d
commit 47751867d3
2 changed files with 188 additions and 326 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

197
local-build-plugins/src/main/java/org/hibernate/orm/post/LoggingReportTask.java
View File

@ -11,25 +11,39 @@ import java.io.FileNotFoundException;
import java.io.FileOutputStream; import java.io.FileOutputStream;
import java.io.IOException; import java.io.IOException;
import java.io.OutputStreamWriter; import java.io.OutputStreamWriter;
import java.lang.annotation.RetentionPolicy;
import java.util.Comparator;
import java.util.List; import java.util.List;
import java.util.TreeMap; import java.util.TreeMap;
import java.util.TreeSet;
import javax.inject.Inject; import javax.inject.Inject;
import org.gradle.api.Project; import org.gradle.api.Project;
import org.gradle.api.tasks.TaskAction; import org.gradle.api.tasks.TaskAction;
import org.jboss.jandex.AnnotationInstance; import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName; import org.jboss.jandex.DotName;
import org.jboss.jandex.Index; import org.jboss.jandex.Index;
import static org.jboss.jandex.DotName.createSimple; import static org.jboss.jandex.DotName.createSimple;
/** /**
* This one would be nice to support, but Jandex is unable to read the annotations
* from JBoss Logging because it defines those annotations with {@link RetentionPolicy#CLASS};
* Jandex can only read annotations marked with {@link RetentionPolicy#RUNTIME}
*
* @see LoggingReportTask
*
* @author Steve Ebersole * @author Steve Ebersole
*/ */
public abstract class LoggingReportTask extends AbstractJandexAwareTask { public abstract class LoggingReportTask extends AbstractJandexAwareTask {
public static final DotName SUB_SYS_ANN_NAME = createSimple( "org.hibernate.internal.log.SubSystemLogging" ); public static final DotName SUB_SYS_ANN_NAME = createSimple( "org.hibernate.internal.log.SubSystemLogging" );
public static final DotName MSG_LOGGER_ANN_NAME = createSimple( "org.jboss.logging.annotations.MessageLogger" );
public static final DotName ID_RANGE_ANN_NAME = createSimple( "org.jboss.logging.annotations.ValidIdRange" );
public static final DotName MSG_ANN_NAME = createSimple( "org.jboss.logging.annotations.Message" );
@Inject @Inject
public LoggingReportTask(IndexManager indexManager, Project project) { public LoggingReportTask(IndexManager indexManager, Project project) {
super( super(
@ -41,9 +55,11 @@ public abstract class LoggingReportTask extends AbstractJandexAwareTask {
@TaskAction @TaskAction
public void generateLoggingReport() { public void generateLoggingReport() {
final TreeMap<String, SubSystem> subSystemByName = new TreeMap<>(); final TreeMap<String, SubSystem> subSystemByName = new TreeMap<>();
final TreeSet<IdRange> idRanges = new TreeSet<>( Comparator.comparing( IdRange::getMinValue ) );
final Index index = getIndexManager().getIndex(); final Index index = getIndexManager().getIndex();
final List<AnnotationInstance> subSysAnnUsages = index.getAnnotations( SUB_SYS_ANN_NAME ); final List<AnnotationInstance> subSysAnnUsages = index.getAnnotations( SUB_SYS_ANN_NAME );
final List<AnnotationInstance> msgLoggerAnnUsages = index.getAnnotations( MSG_LOGGER_ANN_NAME );
subSysAnnUsages.forEach( (ann) -> { subSysAnnUsages.forEach( (ann) -> {
final SubSystem subSystem = new SubSystem( final SubSystem subSystem = new SubSystem(
@ -54,16 +70,80 @@ public abstract class LoggingReportTask extends AbstractJandexAwareTask {
subSystemByName.put( subSystem.name, subSystem ); subSystemByName.put( subSystem.name, subSystem );
} ); } );
generateReport( subSystemByName );
msgLoggerAnnUsages.forEach( (msgLoggerAnnUsage) -> {
// find its id-range annotation, if one
final ClassInfo loggerClassInfo = msgLoggerAnnUsage.target().asClass();
final AnnotationInstance subSystemAnnUsage = loggerClassInfo.declaredAnnotation( SUB_SYS_ANN_NAME );
final SubSystem subSystem;
if ( subSystemAnnUsage != null ) {
subSystem = subSystemByName.get( subSystemAnnUsage.value( "name" ).asString() );
}
else {
subSystem = null;
}
final IdRange idRange;
final AnnotationInstance idRangeAnnUsage = loggerClassInfo.declaredAnnotation( ID_RANGE_ANN_NAME );
if ( idRangeAnnUsage == null ) {
idRange = calculateIdRange( msgLoggerAnnUsage, subSystem );
}
else {
idRange = new IdRange(
idRangeAnnUsage.value( "min" ).asInt(),
idRangeAnnUsage.value( "max" ).asInt(),
true,
loggerClassInfo.simpleName(),
subSystem
);
if ( subSystem != null ) {
subSystem.idRange = idRange;
}
}
if ( idRange != null ) {
idRanges.add( idRange );
}
} );
generateReport( subSystemByName, idRanges );
} }
private void generateReport(TreeMap<String, SubSystem> subSystemByName) { private IdRange calculateIdRange(AnnotationInstance msgLoggerAnnUsage, SubSystem subSystem) {
final ClassInfo loggerClassInfo = msgLoggerAnnUsage.target().asClass();
getProject().getLogger().lifecycle( "MessageLogger (`%s`) missing id-range", loggerClassInfo.simpleName() );
final List<AnnotationInstance> messageAnnUsages = loggerClassInfo.annotations( MSG_ANN_NAME );
if ( messageAnnUsages.isEmpty() ) {
return null;
}
int minId = Integer.MAX_VALUE;
int maxId = Integer.MIN_VALUE;
for ( int i = 0; i < messageAnnUsages.size(); i++ ) {
final AnnotationInstance msgAnnUsage = messageAnnUsages.get( i );
final int msgId = msgAnnUsage.value( "id" ).asInt();
if ( msgId < minId ) {
minId = msgId;
}
else if ( msgId > maxId ) {
maxId = msgId;
}
}
return new IdRange( minId, maxId, false, loggerClassInfo.simpleName(), subSystem );
}
private void generateReport(TreeMap<String, SubSystem> subSystemByName, TreeSet<IdRange> idRanges) {
final File reportFile = prepareReportFile(); final File reportFile = prepareReportFile();
assert reportFile.exists(); assert reportFile.exists();
try ( final OutputStreamWriter fileWriter = new OutputStreamWriter( new FileOutputStream( reportFile ) ) ) { try ( final OutputStreamWriter fileWriter = new OutputStreamWriter( new FileOutputStream( reportFile ) ) ) {
writeReport( subSystemByName, fileWriter ); writeReport( subSystemByName, idRanges, fileWriter );
} }
catch (FileNotFoundException e) { catch (FileNotFoundException e) {
throw new RuntimeException( "Should never happen" ); throw new RuntimeException( "Should never happen" );
@ -74,15 +154,11 @@ public abstract class LoggingReportTask extends AbstractJandexAwareTask {
} }
private void writeReport(TreeMap<String, SubSystem> subSystemByName, OutputStreamWriter fileWriter) { private void writeReport(TreeMap<String, SubSystem> subSystemByName, TreeSet<IdRange> idRanges, OutputStreamWriter fileWriter) {
// for the moment, just dump these to a file in simple text format.
//
// ultimately come back and create an asciidoctor-formatted file
// and run through the asciidoctor task
try { try {
fileWriter.write( "= Hibernate logging\n\n" ); fileWriter.write( "= Hibernate logging\n\n" );
fileWriter.write( "[[subsystems]]\n" );
fileWriter.write( "== Sub-system logging\n\n" ); fileWriter.write( "== Sub-system logging\n\n" );
subSystemByName.forEach( (name, subSystem) -> { subSystemByName.forEach( (name, subSystem) -> {
try { try {
@ -90,11 +166,46 @@ public abstract class LoggingReportTask extends AbstractJandexAwareTask {
fileWriter.write( "`" + subSystem.getName() + "`::\n" ); fileWriter.write( "`" + subSystem.getName() + "`::\n" );
fileWriter.write( " * Logging class-name = `" + subSystem.getLoggingClassName() + "`\n" ); fileWriter.write( " * Logging class-name = `" + subSystem.getLoggingClassName() + "`\n" );
fileWriter.write( " * Description = " + subSystem.getDescription() + "\n" ); fileWriter.write( " * Description = " + subSystem.getDescription() + "\n" );
if ( subSystem.getIdRange() != null ) {
fileWriter.write( String.format(
" * ValidIdRange = <<%s,%s>>\n",
subSystem.getIdRange().getAnchorName(),
subSystem.getIdRange().getLabel()
) );
}
} }
catch (IOException e) { catch (IOException e) {
throw new RuntimeException( "Error writing sub-system entry (" + subSystem.getAnchorName() + ") to report file", e ); throw new RuntimeException( "Error writing sub-system entry (" + subSystem.getAnchorName() + ") to report file", e );
} }
} ); } );
fileWriter.write( "\n\n" );
fileWriter.write( "[[id-ranges]]\n" );
fileWriter.write( "== Message Id Ranges\n\n" );
idRanges.forEach( (idRange) -> {
try {
fileWriter.write( "[[" + idRange.getAnchorName() + "]]\n" );
fileWriter.write( "`" + idRange.getLabel() + "`::\n" );
fileWriter.write( String.format(
" * ValidIdRange = %s - %s (%s)\n",
idRange.minValueText,
idRange.maxValueText,
idRange.explicit ? "explicit" : "implicit"
) );
fileWriter.write( " * MessageLogger = `" + idRange.getLoggerClassName() + "`\n" );
final SubSystem subSystem = idRange.getSubSystem();
if ( subSystem != null ) {
fileWriter.write( String.format(
" * SubSystem = <<%s,%s>>\n",
subSystem.getAnchorName(),
subSystem.getName()
) );
}
}
catch (IOException e) {
throw new RuntimeException( "Error writing msg-id entry (" + idRange.getAnchorName() + ") to report file", e );
}
} );
} }
catch (IOException e) { catch (IOException e) {
throw new RuntimeException( "Error writing to report file", e ); throw new RuntimeException( "Error writing to report file", e );
@ -109,6 +220,8 @@ public abstract class LoggingReportTask extends AbstractJandexAwareTask {
private final String anchorName; private final String anchorName;
private IdRange idRange;
public SubSystem(String name, String description, String loggingClassName) { public SubSystem(String name, String description, String loggingClassName) {
this.name = name; this.name = name;
this.description = description; this.description = description;
@ -133,6 +246,10 @@ public abstract class LoggingReportTask extends AbstractJandexAwareTask {
return anchorName; return anchorName;
} }
public IdRange getIdRange() {
return idRange;
}
private static String determineAnchorName(final String name) { private static String determineAnchorName(final String name) {
final String baseName; final String baseName;
if ( name.startsWith( "org.hibernate.orm." ) ) { if ( name.startsWith( "org.hibernate.orm." ) ) {
@ -149,4 +266,66 @@ public abstract class LoggingReportTask extends AbstractJandexAwareTask {
} }
} }
private static class IdRange {
private final int minValue;
private final int maxValue;
private final boolean explicit;
private final String loggerClassName;
private final SubSystem subSystem;
private final String minValueText;
private final String maxValueText;
public IdRange(
int minValue,
int maxValue,
boolean explicit,
String loggerClassName,
SubSystem subSystem) {
this.minValue = minValue;
this.maxValue = maxValue;
this.explicit = explicit;
this.loggerClassName = loggerClassName;
this.subSystem = subSystem;
this.minValueText = String.format( "HHH%06d", minValue );
this.maxValueText = String.format( "HHH%06d", maxValue );
}
public int getMinValue() {
return minValue;
}
public String getMinValueText() {
return minValueText;
}
public int getMaxValue() {
return maxValue;
}
public String getMaxValueText() {
return maxValueText;
}
public String getLoggerClassName() {
return loggerClassName;
}
public boolean isExplicit() {
return explicit;
}
public SubSystem getSubSystem() {
return subSystem;
}
public String getAnchorName() {
return minValueText;
}
public String getLabel() {
return minValueText + " - " + maxValueText;
}
}
} }

317
local-build-plugins/src/main/java/org/hibernate/orm/post/LoggingReportTask2.java
View File

@ -1,317 +0,0 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
package org.hibernate.orm.post;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.lang.annotation.RetentionPolicy;
import java.util.Comparator;
import java.util.List;
import java.util.TreeMap;
import java.util.TreeSet;
import javax.inject.Inject;
import org.gradle.api.Project;
import org.gradle.api.tasks.TaskAction;
import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName;
import org.jboss.jandex.Index;
import static org.jboss.jandex.DotName.createSimple;
/**
* This one would be nice to support, but Jandex is unable to read the annotations
* from JBoss Logging because it defines those annotations with {@link RetentionPolicy#CLASS};
* Jandex can only read annotations marked with {@link RetentionPolicy#RUNTIME}
*
* @see LoggingReportTask
*
* @author Steve Ebersole
*/
public abstract class LoggingReportTask2 extends AbstractJandexAwareTask {
public static final DotName SUB_SYS_ANN_NAME = createSimple( "org.hibernate.internal.log.SubSystemLogging" );
public static final DotName MSG_LOGGER_ANN_NAME = createSimple( "org.jboss.logging.annotations.MessageLogger" );
public static final DotName ID_RANGE_ANN_NAME = createSimple( "org.jboss.logging.annotations.ValidIdRange" );
public static final DotName MSG_ANN_NAME = createSimple( "org.jboss.logging.annotations.Message" );
@Inject
public LoggingReportTask2(IndexManager indexManager, Project project) {
super(
indexManager,
project.getLayout().getBuildDirectory().file( "orm/reports/logging.adoc" )
);
}
@TaskAction
public void generateLoggingReport() {
final TreeMap<String, SubSystem> subSystemByName = new TreeMap<>();
final TreeSet<IdRange> idRanges = new TreeSet<>( Comparator.comparing( IdRange::getMinValue ) );
final Index index = getIndexManager().getIndex();
final List<AnnotationInstance> subSysAnnUsages = index.getAnnotations( SUB_SYS_ANN_NAME );
final List<AnnotationInstance> msgLoggerAnnUsages = index.getAnnotations( MSG_LOGGER_ANN_NAME );
subSysAnnUsages.forEach( (ann) -> {
final SubSystem subSystem = new SubSystem(
ann.value( "name" ).asString(),
ann.value( "description" ).asString(),
ann.target().asClass().simpleName()
);
subSystemByName.put( subSystem.name, subSystem );
} );
msgLoggerAnnUsages.forEach( (msgLoggerAnnUsage) -> {
// find its id-range annotation, if one
final ClassInfo loggerClassInfo = msgLoggerAnnUsage.target().asClass();
final AnnotationInstance subSystemAnnUsage = loggerClassInfo.classAnnotation( SUB_SYS_ANN_NAME );
final SubSystem subSystem;
if ( subSystemAnnUsage != null ) {
subSystem = subSystemByName.get( subSystemAnnUsage.value( "name" ).asString() );
}
else {
subSystem = null;
}
final IdRange idRange;
final AnnotationInstance idRangeAnnUsage = loggerClassInfo.classAnnotation( ID_RANGE_ANN_NAME );
if ( idRangeAnnUsage == null ) {
idRange = calculateIdRange( msgLoggerAnnUsage, subSystem );
}
else {
idRange = new IdRange(
idRangeAnnUsage.value( "min" ).asInt(),
idRangeAnnUsage.value( "maz" ).asInt(),
loggerClassInfo.simpleName(),
true,
subSystem
);
if ( subSystem != null ) {
subSystem.idRange = idRange;
}
}
if ( idRange != null ) {
idRanges.add( idRange );
}
} );
generateReport( subSystemByName, idRanges );
}
private IdRange calculateIdRange(AnnotationInstance msgLoggerAnnUsage, SubSystem subSystem) {
final ClassInfo loggerClassInfo = msgLoggerAnnUsage.target().asClass();
getProject().getLogger().lifecycle( "MessageLogger (`%s`) missing id-range", loggerClassInfo.simpleName() );
final List<AnnotationInstance> messageAnnUsages = loggerClassInfo.annotations( MSG_ANN_NAME );
if ( messageAnnUsages.isEmpty() ) {
return null;
}
int minId = Integer.MAX_VALUE;
int maxId = Integer.MIN_VALUE;
for ( int i = 0; i < messageAnnUsages.size(); i++ ) {
final AnnotationInstance msgAnnUsage = messageAnnUsages.get( i );
final int msgId = msgAnnUsage.value( "id" ).asInt();
if ( msgId < minId ) {
minId = msgId;
}
else if ( msgId > maxId ) {
maxId = msgId;
}
}
return new IdRange( minId, maxId, loggerClassInfo.simpleName(), false, subSystem );
}
private void generateReport(TreeMap<String, SubSystem> subSystemByName, TreeSet<IdRange> idRanges) {
final File reportFile = prepareReportFile();
assert reportFile.exists();
try ( final OutputStreamWriter fileWriter = new OutputStreamWriter( new FileOutputStream( reportFile ) ) ) {
writeReport( subSystemByName, idRanges, fileWriter );
}
catch (FileNotFoundException e) {
throw new RuntimeException( "Should never happen" );
}
catch (IOException e) {
throw new RuntimeException( "Error writing to report file", e );
}
}
private void writeReport(TreeMap<String, SubSystem> subSystemByName, TreeSet<IdRange> idRanges, OutputStreamWriter fileWriter) {
// for the moment, just dump these to a file in simple text format.
//
// ultimately come back and create an asciidoctor-formatted file
// and run through the asciidoctor task
try {
fileWriter.write( "= Hibernate logging\n\n" );
fileWriter.write( "== Sub-system logging\n\n" );
subSystemByName.forEach( (name, subSystem) -> {
try {
fileWriter.write( "[[" + subSystem.getAnchorName() + "]]\n" );
fileWriter.write( "`" + subSystem.getName() + "`::\n" );
fileWriter.write( " * Logging class-name = `" + subSystem.getLoggingClassName() + "`\n" );
fileWriter.write( " * Description = " + subSystem.getDescription() + "\n" );
if ( subSystem.getIdRange() == null ) {
fileWriter.write( " * id-range = no\n" );
}
else {
fileWriter.write( " * id-range = <<" + subSystem.getIdRange().anchorName + ",yes>>\n" );
}
}
catch (IOException e) {
throw new RuntimeException( "Error writing sub-system entry (" + subSystem.getAnchorName() + ") to report file", e );
}
} );
fileWriter.write( "\n\n" );
fileWriter.write( "== Keyed message logging\n\n" );
idRanges.forEach( (idRange) -> {
try {
fileWriter.write( "[[" + idRange.getAnchorName() + "]]\n" );
fileWriter.write( "`" + idRange.getLabel() + "`::\n" );
fileWriter.write( " * MessageLogger class = `" + idRange.getLoggerClassName() + "`\n" );
fileWriter.write( " * Explicit? = " + idRange.isExplicit() + "\n" );
final SubSystem subSystem = idRange.getSubSystem();
if ( subSystem == null ) {
fileWriter.write( " * sub-system? = no\n" );
}
else {
fileWriter.write( " * sub-system? = <<" + subSystem.getAnchorName() + ",yes>>\n" );
}
}
catch (IOException e) {
throw new RuntimeException( "Error writing msg-id entry (" + idRange.getAnchorName() + ") to report file", e );
}
} );
}
catch (IOException e) {
throw new RuntimeException( "Error writing to report file", e );
}
}
private static class SubSystem {
private final String name;
private final String description;
private final String loggingClassName;
private final String anchorName;
private IdRange idRange;
public SubSystem(String name, String description, String loggingClassName) {
this.name = name;
this.description = description;
this.loggingClassName = loggingClassName;
this.anchorName = determineAnchorName( name );
}
public String getName() {
return name;
}
public String getDescription() {
return description;
}
public String getLoggingClassName() {
return loggingClassName;
}
public String getAnchorName() {
return anchorName;
}
public IdRange getIdRange() {
return idRange;
}
private static String determineAnchorName(final String name) {
final String baseName;
if ( name.startsWith( "org.hibernate.orm." ) ) {
baseName = name.substring( "org.hibernate.orm.".length() );
}
else if ( name.startsWith( "org.hibernate." ) ) {
baseName = name.substring( "org.hibernate.".length() );
}
else {
baseName = name;
}
return baseName.replace( '.', '_' );
}
}
private static class IdRange {
private final int minValue;
private final int maxValue;
private final String loggerClassName;
private final boolean explicit;
private final SubSystem subSystem;
private final String anchorName;
public IdRange(
int minValue,
int maxValue,
String loggerClassName,
boolean explicit,
SubSystem subSystem) {
this.minValue = minValue;
this.maxValue = maxValue;
this.loggerClassName = loggerClassName;
this.explicit = explicit;
this.subSystem = subSystem;
this.anchorName = "HHH" + minValue;
}
public int getMinValue() {
return minValue;
}
public int getMaxValue() {
return maxValue;
}
public String getLoggerClassName() {
return loggerClassName;
}
public boolean isExplicit() {
return explicit;
}
public SubSystem getSubSystem() {
return subSystem;
}
public String getAnchorName() {
return anchorName;
}
public String getLabel() {
return String.format( "HHH%06d - HHH%06d", minValue, maxValue );
}
}
}