Skip to content

Document the operator's logging flags - #1074

Open
Manishram-ai wants to merge 1 commit into
spotify:masterfrom
Manishram-ai:docs/operator-logging-flags
Open

Manishram-ai wants to merge 1 commit into
spotify:masterfrom
Manishram-ai:docs/operator-logging-flags

Conversation

@Manishram-ai

Copy link
Copy Markdown

Closes #173

You can change how the operator logs with controller-runtime's zap flags, but they aren't documented anywhere right now. The only way to find them is --help or reading main.go. This adds a short section about them to the user guide, right after the one about Flink cluster logs.

It covers what each flag does and how to change them on a running operator. It also explains why make run gives you console logs at debug level, while the release YAML and the Helm chart give you JSON at info level. The Helm chart doesn't have a value for extra args yet, so for now the docs tell people to edit the Deployment. If that sounds useful, I can send a small follow-up that adds one to the chart.

I ran the operator locally with these flags to make sure the docs are right. The only surprise was the timestamp format. The --help text says it defaults to epoch, but the logs actually use RFC3339, so that's what I wrote in the docs.

This branch has not been deployed

No deployments
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

Successfully merging this pull request may close these issues.

Document logging flags

1 participant