• driving_crooner@lemmy.eco.br
    link
    fedilink
    arrow-up
    0
    ·
    1 year ago

    Any guide on how to write effective logs? I’m starting to write scripts to automate some processes at my job and want to start logging the process to debugging or troubleshooting in the future.

    • nolefan33@sh.itjust.works
      link
      fedilink
      arrow-up
      1
      ·
      1 year ago

      The most useful thing you can do for simple scripts is never use the same log string in two locations in your code. If you reuse strings it can become very confusing where a specific log line printed from. In addition, write logs that let you trace the execution of the program, down to some kind of identifier that allows you to determine (for example) the exact iteration of a loop that caused an error.

      • apd@programming.dev
        link
        fedilink
        arrow-up
        1
        ·
        1 year ago

        I’d use logger that prints the file and line number when logging, to avoid the question of: “where is the log coming from”