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

Include git metadata in docker logs and Google Cloud panic reports #2564

Closed
Tracked by #3096
teor2345 opened this issue Aug 3, 2021 · 4 comments
Closed
Tracked by #3096

Include git metadata in docker logs and Google Cloud panic reports #2564

teor2345 opened this issue Aug 3, 2021 · 4 comments
Labels
A-devops Area: Pipelines, CI/CD and Dockerfiles A-infrastructure Area: Infrastructure changes C-enhancement Category: This is an improvement I-usability Zebra is hard to understand or use

Comments

@teor2345
Copy link
Contributor

teor2345 commented Aug 3, 2021

Motivation

Currently,

  • Zebra's Docker logs don't show the git commit
  • Zebra's Google Cloud and Docker panic reports only show the git commit, passed through an environmental variable.

But we'd like to see the branch name and other detailed git information via vergen.

Tasks

The vergen git metadata is likely being disabled due to git security rules.

The fix is here:
https://github.com/rustyhorde/vergen#notes-about-the-optional-git2-015-dependency

If that doesn't work, we should also check:

  • there is a git binary installed in Docker,
  • there is a .git directory in Google cloud builds,
  • the path to that directory is where vergen or the zebrad build script expect it to be.

We could try changing to the zebra source directory before building.

API Reference

https://docs.rs/vergen/5.1.14/vergen/index.html

@teor2345 teor2345 added A-rust Area: Updates to Rust code A-infrastructure Area: Infrastructure changes C-enhancement Category: This is an improvement S-needs-triage Status: A bug report needs triage S-needs-investigation Status: Needs further investigation P-Low I-usability Zebra is hard to understand or use labels Aug 3, 2021
@teor2345 teor2345 changed the title Include git metadata in Google Cloud panic reports Include git metadata in docker logs and Google Cloud panic reports May 26, 2022
@teor2345 teor2345 added P-Medium ⚡ and removed P-Optional ✨ S-needs-investigation Status: Needs further investigation labels Aug 24, 2022
@teor2345
Copy link
Contributor Author

PR #4939 removes the git commit from some Google Cloud objects, so this ticket needs to be done soon.

@teor2345 teor2345 added A-devops Area: Pipelines, CI/CD and Dockerfiles and removed A-rust Area: Updates to Rust code labels Sep 11, 2022
@mpguerra mpguerra moved this to 🆕 New in Zebra Sep 22, 2022
@mpguerra mpguerra added this to Zebra Sep 22, 2022
@teor2345
Copy link
Contributor Author

This is useful, and we should do it eventually, but it hasn't actually been a problem yet.

@teor2345
Copy link
Contributor Author

We're doing fine diagnosing bugs without this

@teor2345 teor2345 closed this as not planned Won't fix, can't repro, duplicate, stale Oct 12, 2022
Repository owner moved this from 🆕 New to ✅ Done in Zebra Oct 12, 2022
@mpguerra mpguerra moved this from ✅ Done to 🛑 Won't Fix in Zebra Nov 9, 2022
@mpguerra mpguerra removed the S-needs-triage Status: A bug report needs triage label Dec 2, 2022
@teor2345
Copy link
Contributor Author

teor2345 commented Jan 5, 2023

Vergen just added documentation about how to fix this issue in Docker to its readme.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-devops Area: Pipelines, CI/CD and Dockerfiles A-infrastructure Area: Infrastructure changes C-enhancement Category: This is an improvement I-usability Zebra is hard to understand or use
Projects
Archived in project
Development

No branches or pull requests

2 participants