Dump selected sysinfo to tracklog.

[perolavsvendsen]

Solve #387

This PR includes some selected system information to the tracklog created entry when exporting data with fmu-dataio. The selected information include the current version of fmu-dataio used and the Komodo release when running in a Komodo environment.

The purpose of this is to ease debugging and user support, i.e. "as a developer I would like to know which version of fmu-dataio was used, so that I can understand the users context, detect and solve problems quicker."

Put into metadata the answer to the most common first debugging question: "Which version of fmu-dataio is the user running?"

Updated tracklog entry in produced metadata:

tracklog:
  - datetime: 2020-10-28T14:28:02
    user:
      id: peesv
    event: created
    sysinfo:   # New ⚡
      fmu-dataio:
        version: 1.2.3
      komodo: # only added when running in Komodo environment
        release: 2023.12.05-py38
  - datetime: 2020-10-28T14:46:14
    user: 
      id: peesv
    event: updated

[perolavsvendsen]

• May be annoying with changes while ongoing work on schema etc @janbjorge
• Is this useful?
• Is the reading of environment variables robust? Is it best (good enough) practice? On thin ice.

[roywilly]

Excellent idea, looking good to me. How can I test it end-to-end? Install this branch of fmu_dataio in a komodo environment, but how do I test the schema version? @perolavsvendsen

[perolavsvendsen]

Excellent idea, looking good to me. How can I test it end-to-end? Install this branch of fmu_dataio in a komodo environment, but how do I test the schema version? @perolavsvendsen

End-to-end testing would be perfect 👍

Not entirely sure if we can test the schema as part of that. But we do test the current examples in unit tests. So if the produced metadata "in the wild" is 1:1 with the example, that should confirm that all is good.

It is also possible to validate produced metadata directly on the local (new) schema, using e.g. python validator. An old draft which includes a validator here which may be useful to look at. (But I think just confirming manually against the examples should be sufficient.)

[jcrivenaes]

Do we need a separate routine for this? (unless we want to make more checks etc, then the oneliner os.environ.get() will do)

[perolavsvendsen]

Possibly not, but it made some sense to me to have a dedicated unit test on it. But I made that decision before I knew it would become just 1 line...

[jcrivenaes]

LGTM. Possibly also add operating system info and host ID?

[perolavsvendsen]

LGTM. Possibly also add operating system info and host ID?

Added to the issue, sounds like a good second wave if the first works