datalust / datalust/seqcli

Warn or fail CLI commands against incompatible server versions

Open
#141 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C#
Stars
167
Forks
30
Avg merge
1d 6h
Merged PRs (30d)
9

Description

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 😉

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the seqcli command-line behavior and the README/release page for how client and server versions are currently presented. Determine how incompatible server versions should be detected and whether the CLI should warn or fail, then verify that incompatible combinations produce the documented behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.