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

Warn or fail CLI commands against incompatible server versions #141

Open
Suchiman opened this issue Jul 31, 2020 · 1 comment
Open

Warn or fail CLI commands against incompatible server versions #141

Suchiman opened this issue Jul 31, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@Suchiman
Copy link

We haven't yet upgraded to the 2020 Release (planning on doing that in roughly a month) and i'm currently working on automating our infrastructure deployment. As part of that i need to create ApiKeys in the release pipeline.
Initially i was looking for a "Seq Powershell Management Module" and only found the C# API so i was about to write my own tool before i remembered seqcli.

I went and downloaded, without a thought, the newest version from the release page and got to work and it seemed to work, except that it didn't create any Properties. After checking and playing with fiddler i found that it sent the Properties but not in the way Seq expects them, due to #135. At that point I've noticed that the versioning scheme of seqcli appears to match the Seq versioning scheme and that probably means that there's no backcompat and the seqcli version must match the Seq server version, but there's no mention in the readme / release page nor a warning in the cli that the versions must match or you might run into incompatibilities.

A version check in the seqcli could avoid some headache for future users 😉

@nblumhardt
Copy link
Member

Thanks for the suggestion! The Seq API provides the server version via the /api root endpoint; it should be quite straightforward for us to identify version mismatches and fail if the seqcli version is ahead of the servers' minor version.

The other way around is generally given more attention - i.e. old API clients should more often work correctly against newer server versions - but it might pay for us to investigate conservatively failing in that case, too.

@nblumhardt nblumhardt added the enhancement New feature or request label Jul 31, 2020
@nblumhardt nblumhardt changed the title Backcompat question Warn or fail CLI commands against incompatible server versions Jul 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants