Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add output files and schema version to info.json #168

Merged
merged 2 commits into from
Sep 4, 2024

Conversation

asmacdo
Copy link
Member

@asmacdo asmacdo commented Aug 28, 2024

Fixes: #165
Replaces: #123

info.json

{
  "command": "ls",
  "system": {
    "uid": "austin",
    "memory_total": 33336778752,
    "cpu_total": 20,
    "hostname": "fancy"
  },
  "env": {},
  "gpu": null,
  "duct_version": "0.2.0",
  "execution_summary": {
    "exit_code": 0,
    "command": "ls",
    "logs_prefix": "Z_",
    "wall_clock_time": 0.0021119117736816406,
    "peak_rss": null,
    "average_rss": null,
    "peak_vsz": null,
    "average_vsz": null,
    "peak_pmem": null,
    "average_pmem": null,
    "peak_pcpu": null,
    "average_pcpu": null,
    "num_samples": 0,
    "num_reports": 0
  },
  "output_paths": {
    "stdout": "Z_stdout",
    "stderr": "Z_stderr",
    "usage": {
      "schema_version": "0.1.0",
      "path": "Z_usage.json"
    },
    "info": "Z_info.json"
  }
}

@asmacdo asmacdo added semver-minor Increment the minor version when merged release Create a release when this pr is merged and removed release Create a release when this pr is merged labels Aug 28, 2024
Copy link

codecov bot commented Aug 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.43%. Comparing base (c2f1187) to head (d7521a4).
Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #168      +/-   ##
==========================================
+ Coverage   94.55%   95.43%   +0.88%     
==========================================
  Files           2        2              
  Lines         459      460       +1     
  Branches       70       70              
==========================================
+ Hits          434      439       +5     
+ Misses         14       10       -4     
  Partials       11       11              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@yarikoptic
Copy link
Member

as I do not see usage schema version to differ from the others, i.e. we better retain one versioning for all json file schemas, why not to place schema_version at the top level of info.json?

@asmacdo
Copy link
Member Author

asmacdo commented Aug 28, 2024

I was thinking that schema version was specifically referring to the usage file, but I see your point.

cat Z_info.json|jq

{
  "command": "ls",
  "system": {
    "uid": "austin",
    "memory_total": 33336778752,
    "cpu_total": 20,
    "hostname": "fancy"
  },
  "env": {},
  "gpu": null,
  "duct_version": "0.2.0",
  "schema_version": "0.1.0",
  "execution_summary": {
    "exit_code": 0,
    "command": "ls",
    "logs_prefix": "Z_",
    "wall_clock_time": 0.001772165298461914,
    "peak_rss": null,
    "average_rss": null,
    "peak_vsz": null,
    "average_vsz": null,
    "peak_pmem": null,
    "average_pmem": null,
    "peak_pcpu": null,
    "average_pcpu": null,
    "num_samples": 0,
    "num_reports": 0
  },
  "output_paths": {
    "stdout": "Z_stdout",
    "stderr": "Z_stderr",
    "usage": "Z_usage.json",
    "info": "Z_info.json",
    "prefix": "Z_"
  }
}

@yarikoptic
Copy link
Member

It is kinda pointless to include info file path into info file, but ok for uniformity

@yarikoptic yarikoptic merged commit 8b07484 into con:main Sep 4, 2024
15 checks passed
@asmacdo asmacdo deleted the log-paths-info branch October 4, 2024 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver-minor Increment the minor version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add all output file paths to the info.json
2 participants