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

EventRecorder comment contradicts with Event field comment #1375

Open
npinaeva opened this issue Sep 13, 2024 · 1 comment
Open

EventRecorder comment contradicts with Event field comment #1375

npinaeva opened this issue Sep 13, 2024 · 1 comment

Comments

@npinaeva
Copy link
Member

EventRecorder interface used for events/v1 says

// 'reason' is the reason this event is generated. 'reason' should be short and unique; it
// should be in UpperCamelCase format (starting with a capital letter). "reason" will be used
// to automate handling of events, so imagine people writing switch statements to handle them.
// You want to make that easy.

implying that the field should be machine-readable. At the same time Event.Reason comment says

	// reason is why the action was taken. It is human-readable.
	// This field cannot be empty for new Events and it can have at most 128 characters.

https://github.com/kubernetes/api/blob/9dc1a952bda9aeb400aa6409b7d89eff50d6ea77/events/v1/types.go#L61-L63
implying it should be human-readable. Also, Event.Action field says it should be machine-readable, so I would expect it to be used for switch statements.
I am confused, please help.

@sundaram2021
Copy link

The reason field serves both machine-readable and human-readable purposes.

  • Machine-readable: It follows UpperCamelCase formatting, making it suitable for automated processing (e.g., switch statements).
  • Human-readable: It is also intended to be short and understandable to users when viewed in logs or UIs.

These are not mutually exclusive; the key is to balance readability for both humans and machines. A concise, formatted reason like PodScheduled can serve both purposes effectively.

some thing like can be a solution .....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants