Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 0 additions & 87 deletions .github/workflows/update-lifecycle-plugins.yml

This file was deleted.

7 changes: 0 additions & 7 deletions apache-maven/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,6 @@ under the License.
<version>${slf4jVersion}</version>
<scope>runtime</scope>
</dependency>
<!-- bridge from java.util.logging (JUL) to SLF4J -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jul-to-slf4j</artifactId>
<version>${slf4jVersion}</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.apache.maven.resolver</groupId>
<artifactId>maven-resolver-connector-basic</artifactId>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.api.build.report;

import java.time.Instant;

import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Immutable;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.annotations.Nullable;

/**
* A structured log event captured during the build.
* <p>
* Each event carries the log level, timestamp, message, and optionally
* the logger name and a stack trace. This replaces raw log line strings
* in the build report, enabling programmatic filtering by level and
* correlation by timestamp.
* <p>
* Events originating from the Maven Log API or from JUL
* ({@code java.util.logging}) carry additional source metadata: the
* source class name, source method name, and thread identifier.
* For Log API events the source class name is the mojo implementation
* FQCN; for JUL events it comes from {@code LogRecord}. Events from
* direct SLF4J logging have these fields set to {@code null}.
*
* @since 4.1.0
*/
@Experimental
@Immutable
public interface LogEvent {

/**
* When this log event was produced (wall-clock time).
*
* @return the event instant, never {@code null}
*/
@Nonnull
Instant timestamp();

/**
* The severity level of this log event.
*
* @return the log level, never {@code null}
*/
@Nonnull
LogLevel level();

/**
* The log message, without level prefix or timestamp formatting.
*
* @return the formatted message, never {@code null}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Javadoc copy-paste: @return says "the formatted message" but this is message(), not formattedMessage(). Should read "the log message, never null".

Suggested change
* @return the formatted message, never {@code null}
* @return the log message, never {@code null}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[low] Javadoc copy-paste: @return says "the formatted message" but this is message(), not formattedMessage().

The field comment says "The log message, without level prefix or timestamp formatting" — the @return tag should match:

Suggested change
* @return the formatted message, never {@code null}
* @return the log message, never {@code null}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[low] Javadoc copy-paste: @return says "the formatted message" but this is message(), not formattedMessage().

The field comment says "The log message, without level prefix or timestamp formatting" — the @return tag should match:

Suggested change
* @return the formatted message, never {@code null}
* @return the log message, never {@code null}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[low] @return tag copy-pasted from formattedMessage() — misleading

The body says "without level prefix or timestamp formatting" but @return says "the formatted message". That's the description of formattedMessage(). message() is the clean message — the contradiction will confuse callers choosing between the two methods.

Suggested change
* @return the formatted message, never {@code null}
* @return the log message without level prefix or timestamp, never {@code null}

*/
@Nonnull
String message();

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[low] @return says "the formatted message" — copy-paste from formattedMessage()

The body Javadoc on the preceding lines correctly says "The log message, without level prefix or timestamp formatting." But the @return tag contradicts it by saying "the formatted message" — the exact wording used by formattedMessage() two methods below. A reader will reasonably conclude that message() returns the same full formatted line as formattedMessage(), which is wrong.

Suggested change
String message();
* @return the clean log message (without level prefix or ANSI), never {@code null}


/**
* The name of the logger that produced this event
* (e.g. {@code "org.apache.maven.plugins.compiler.CompilerMojo"}).
*
* @return the logger name, or {@code null} if unavailable
*/
@Nullable
String loggerName();

/**
* The stack trace associated with this event, if an exception was logged.
* <p>
* The trace is formatted as a multi-line string and may be truncated
* for very deep stack traces.
*
* @return the stack trace string, or {@code null} if no exception was logged
*/
@Nullable
String stackTrace();

/**
* The fully formatted log line as rendered for console output, including
* the level prefix, timestamp, and any ANSI styling applied by the logger.
* <p>
* This is the string that would be printed to the terminal in verbose mode.
* Console renderers that just need pass-through output can use this directly,
* while renderers that apply custom formatting (e.g. rich mode) can use the
* structured fields ({@link #level()}, {@link #message()}) instead.
* <p>
* May be {@code null} if the event was created outside the SLF4J pipeline
* (e.g. in tests or by programmatic construction).
*
* @return the formatted log line, or {@code null}
*/
@Nullable
String formattedMessage();

// ---- Source metadata (populated for Log API and JUL events) ----

/**
* The fully qualified class name of the source that issued the log call.
* <p>
* For Maven Log API events this is the mojo implementation class name.
* For JUL events it is the value from {@code LogRecord.getSourceClassName()}.
* For direct SLF4J logging it is {@code null}.
*
* @return the source class name, or {@code null}
*/
@Nullable
default String sourceClassName() {
return null;
}

/**
* The method name of the source that issued the log call.
* <p>
* For Maven Log API events this is resolved via {@link StackWalker}.
* For JUL events it is the value from {@code LogRecord.getSourceMethodName()}.
* For direct SLF4J logging it is {@code null}.
*
* @return the source method name, or {@code null}
*/
@Nullable
default String sourceMethodName() {
return null;
}

/**
* The thread identifier from which this log event originated.
* <p>
* Populated for both Log API and JUL events. Returns {@code -1}
* if the thread ID is not available (i.e. for direct SLF4J events).
*
* @return the thread ID, or {@code -1} if unavailable
*/
default long threadId() {
return -1;
}

/**
* A monotonically increasing sequence number for total ordering of
* log events, useful when multiple events share the same timestamp.
* <p>
* Assigned by the logging pipeline when the event is captured,
* providing a global ordering across all event sources (Log API,
* JUL, and direct SLF4J).
*
* @return the sequence number, or {@code -1} if unavailable
*/
default long sequenceNumber() {
Comment thread
gnodet marked this conversation as resolved.
return -1;
}

/**
* The project this log event belongs to
* (e.g. {@code "org.apache.maven:maven-core:4.1.0-SNAPSHOT"}), or {@code null}
* if the event was not produced in the context of a specific project.
*
* @return the project identifier, or {@code null}
*/
@Nullable
default String projectId() {
return null;
}

/**
* The mojo execution that produced this event
* (e.g. {@code "compiler:compile@default-compile"}), or {@code null}
* if the event was logged outside a mojo execution.
*
* @return the mojo execution identifier, or {@code null}
*/
@Nullable
default String mojoId() {
return null;
}
}
Comment thread
gnodet marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,23 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.cling.logging.impl;
package org.apache.maven.api.build.report;

import org.apache.maven.cling.logging.BaseSlf4jConfiguration;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Immutable;

/**
* Configuration for slf4j-log4j2.
* Log severity levels, mirroring the standard SLF4J levels.
*
* @since 3.1.0
* @since 4.1.0
* @see LogEvent#level()
*/
public class Log4j2Configuration extends BaseSlf4jConfiguration {
@Override
public void setRootLoggerLevel(Level level) {
String value =
switch (level) {
case DEBUG -> "debug";
case INFO -> "info";
default -> "error";
};
System.setProperty("maven.logging.root.level", value);
}

@Override
public void activate() {
// no op
}
@Experimental
@Immutable
public enum LogLevel {
TRACE,
DEBUG,
INFO,
WARN,
ERROR
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
* Structured build report data model.
* <p>
* This package provides structured representations of build execution
* data, including log events and (in future) full build reports.
* {@link org.apache.maven.api.build.report.LogEvent} is the foundational
* type representing a single structured log entry captured during the build.
*
* @since 4.1.0
*/
@Experimental
package org.apache.maven.api.build.report;

import org.apache.maven.api.annotations.Experimental;
Loading
Loading