Jump to content
Search the Forums BEFORE making a new post.
Currently supported: All versions

[1.7.10][Style] Usage of logger

WorldsEnder

By WorldsEnder
in Modder Support

 Share

Recommended Posts

WorldsEnder Creeper Killer

WorldsEnder

Posted
Posted

The question seems simple: When and how should I use the different levels of the logger?

 

I have two stages of developement: dev and release. Now I figured out that I should avoid having to call log with Level.DEBUG in the release but what about the other levels? Where is the difference between trace and info for example?

 

We have the following levels: OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE.

 

OFF: should not be used at all?

FATAL: is it good style to log in case something went wrong and NOT throw an exception (do both?)

ERROR: I don't understand this Level, maybe when loading something not completly necessary, like a missing file?

WARN: okay, this is pretty clear, we do this if some (API-)user gave us wrongly formatted input but we can recover.

INFO: is this meant to info the final user? If so, how deep of an understanding should I assume?

DEBUG: should I include this in the final product, after all?

TRACE: how often should I use this feature? excessively?

Busti Dragon Slayer

Busti

Posted
Posted

It strongly depends on your own opinion. There are as far as I know no global standards on how to log especially not in Minecraft because nobody really cares about it.

But it is good to give it some structure. I wouldn't log an Error as an INFO because it is much easier to read for the user / programmer in case something went wrong. Most of the time you wont need to log something anyways because logs (especially Debugging messages) just spam the console. For instance a TileEntity logging its position. When an Error occurs you should log it as an Error as long as it doesn't crash the game or creates world damage (that would probably be a "Fatal") and log the Stacktrace with it so the user / programmer can see where the problem is and avoid / debug it. A common usage for the ERROR level is in try-catch blocks where an Error wont crash the game but still would create some trouble.

I commonly use these LEVELS...

  • FATAL: Errors that will crash the game.
  • ERROR: Errors that have to be debugged or occur randomly in try-catch blocks.
  • WARN: Things that are not really normal but wont throw an exception.
  • INFO: Information for the end User, for instance printing the mod version.
  • DEBUG: Messages from debugging... (I have a config Flag for a debug mode)

 

As I said it strongly depends on your opinion and can vary.

 

- Busti

PM's regarding modding questions should belong in the Modder Support sub-forum and won't be answered.

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Unfortunately, your content contains terms that we do not allow. Please edit your content to remove the highlighted words below.
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
 Share
Go to topic listing

Announcements



  • Recently Browsing

    • No registered users viewing this page.

  • Posts

    • TileEntity
      Unknown Crash, Exception Ticking World

      By TileEntity · Posted

      I have no idea
    • Pixel243
      Unknown Crash, Exception Ticking World

      By Pixel243 · Posted

      that happens every time I enter a new dimension.
    • TileEntity
      Unknown Crash, Exception Ticking World

      By TileEntity · Posted

      This is the last line before the crash: [ebwizardry]: Synchronising spell emitters for PixelTraveler But I have no idea what this means
    • Pixel243
      Unknown Crash, Exception Ticking World

      By Pixel243 · Posted

      What in particular? I barely used that mod this time around, and it's never been a problem in the past.
    • Azero
      Unable to build with shadow

      By Azero · Posted

      Im trying to build my mod using shade since i use the luaj library however i keep getting this error Reason: Task ':reobfJar' uses this output of task ':shadowJar' without declaring an explicit or implicit dependency. This can lead to incorrect results being produced, depending on what order the tasks are executed. So i try adding reobfJar.dependsOn shadowJar  Could not get unknown property 'reobfJar' for object of type org.gradle.api.internal.artifacts.dsl.dependencies.DefaultDependencyHandler. my gradle file plugins { id 'eclipse' id 'idea' id 'maven-publish' id 'net.minecraftforge.gradle' version '[6.0,6.2)' id 'com.github.johnrengelman.shadow' version '7.1.2' id 'org.spongepowered.mixin' version '0.7.+' } apply plugin: 'net.minecraftforge.gradle' apply plugin: 'org.spongepowered.mixin' apply plugin: 'com.github.johnrengelman.shadow' version = mod_version group = mod_group_id base { archivesName = mod_id } // Mojang ships Java 17 to end users in 1.18+, so your mod should target Java 17. java.toolchain.languageVersion = JavaLanguageVersion.of(17) //jarJar.enable() println "Java: ${System.getProperty 'java.version'}, JVM: ${System.getProperty 'java.vm.version'} (${System.getProperty 'java.vendor'}), Arch: ${System.getProperty 'os.arch'}" minecraft { mappings channel: mapping_channel, version: mapping_version copyIdeResources = true runs { configureEach { workingDirectory project.file('run') property 'forge.logging.markers', 'REGISTRIES' property 'forge.logging.console.level', 'debug' arg "-mixin.config=derp.mixin.json" mods { "${mod_id}" { source sourceSets.main } } } client { // Comma-separated list of namespaces to load gametests from. Empty = all namespaces. property 'forge.enabledGameTestNamespaces', mod_id } server { property 'forge.enabledGameTestNamespaces', mod_id args '--nogui' } gameTestServer { property 'forge.enabledGameTestNamespaces', mod_id } data { workingDirectory project.file('run-data') args '--mod', mod_id, '--all', '--output', file('src/generated/resources/'), '--existing', file('src/main/resources/') } } } sourceSets.main.resources { srcDir 'src/generated/resources' } repositories { flatDir { dirs './libs' } maven { url = "https://jitpack.io" } } configurations { shade implementation.extendsFrom shade } dependencies { minecraft "net.minecraftforge:forge:${minecraft_version}-${forge_version}" implementation 'org.luaj:luaj-jse-3.0.2' implementation fg.deobf("com.github.Virtuoel:Pehkui:${pehkui_version}") annotationProcessor 'org.spongepowered:mixin:0.8.5:processor' minecraftLibrary 'luaj:luaj-jse:3.0.2' shade 'luaj:luaj-jse:3.0.2' } // Example for how to get properties into the manifest for reading at runtime. tasks.named('jar', Jar).configure { manifest { attributes([ 'Specification-Title' : mod_id, 'Specification-Vendor' : mod_authors, 'Specification-Version' : '1', // We are version 1 of ourselves 'Implementation-Title' : project.name, 'Implementation-Version' : project.jar.archiveVersion, 'Implementation-Vendor' : mod_authors, 'Implementation-Timestamp': new Date().format("yyyy-MM-dd'T'HH:mm:ssZ"), "TweakClass" : "org.spongepowered.asm.launch.MixinTweaker", "TweakOrder" : 0, "MixinConfigs" : "derp.mixin.json" ]) } rename 'mixin.refmap.json', 'derp.mixin-refmap.json' } shadowJar { archiveClassifier = '' configurations = [project.configurations.shade] finalizedBy 'reobfShadowJar' } assemble.dependsOn shadowJar reobf { re shadowJar {} } publishing { publications { mavenJava(MavenPublication) { artifact jar } } repositories { maven { url "file://${project.projectDir}/mcmodsrepo" } } } my entire project:https://github.com/kevin051606/DERP-Mod/tree/Derp-1.0-1.20

  • Topics

×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.

  I accept