aws / aws/aws-xray-sdk-java

LogContextMissingStrategy with customizable logging level

Aperta
#5 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Java
Stelle
100
Fork
100
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Currently LogErrorContextMissingStrategy uses commons-logging and always logs error:

https://github.com/aws/aws-xray-sdk-java/blob/01d52aee854baae36ad9224598ffa709290d7afa/aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/strategy/LogErrorContextMissingStrategy.java#L18

My suggestion:

  1. Use slf4j-api instead, which is de facto standard for modern Java apps and also more performant
  2. Add LogContextMissingStrategy which can be used to log to user-specified level. LogErrorContextMissingStrategy will just become a very thin subclass (for backwards compatbility) that uses Level.ERROR

What I use:

public static class LogContextMissingStrategy implements ContextMissingStrategy {
    private static final Logger logger = LoggerFactory.getLogger(LogContextMissingStrategy.class);
    private final Level level;
    private static final Map<Level, LoggingFunction> map;

    static {
        map = new HashMap<>();
        map.put(Level.TRACE, (logger, format, params) -> logger.trace(format, params));
        map.put(Level.DEBUG, (logger, format, params) -> logger.debug(format, params));
        map.put(Level.INFO, (logger, format, params) -> logger.info(format, params));
        map.put(Level.WARN, (logger, format, params) -> logger.warn(format, params));
        map.put(Level.ERROR, (logger, format, params) -> logger.error(format, params));
    }

    @FunctionalInterface
    private interface LoggingFunction {
        void log(Logger logger, String format, Object... params);
    }

    public LogContextMissingStrategy(Level level) {
        this.level = level;
    }

    /**
     * Logs {@code message} on the specified level.
     * @param message the message to log
     * @param exceptionClass the type of exception suppressed in favor of logging {@code message}
     */
    @Override
    public void contextMissing(String message, Class<? extends RuntimeException> exceptionClass) {
        map.get(level).log(logger, "Suppressing AWS X-Ray context missing exception ({}): {}",
                exceptionClass.getSimpleName(), message);
    }

}

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/strategy/LogErrorContextMissingStrategy.java e l’entry point ContextMissingStrategy. Confronta l’API LogContextMissingStrategy richiesta e il comportamento del livello di logging con l’implementazione esistente, quindi verifica che LogErrorContextMissingStrategy rimanga retrocompatibile e che la strategia configurabile registri al livello selezionato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
backend
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.