Skip to content

feat(logcli): Include common labels - #15611

Merged
chaudum merged 3 commits into
grafana:mainfrom
jml:5702-include-common-labels
Jan 8, 2025
Merged

feat(logcli): Include common labels#15611
chaudum merged 3 commits into
grafana:mainfrom
jml:5702-include-common-labels

Conversation

@jml

@jml jml commented Jan 6, 2025

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:
Adds a new --include-common-labels flag to logcli query, which causes the output to include all common labels.

This is mostly useful with --quiet and --output=jsonl as it allows users to get structured information from Loki that has all the information that Loki can provide.

Which issue(s) this PR fixes:
Fixes #5702

Special notes for your reviewer:

  • The suggestion on the PR was --all-labels. Given there are other label selection options, I thought it was easiest to add something to directly control the behaviour to remove common labels.
  • I have not written tests, but I have verified that it works locally

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR
Adds a new `--include-common-labels` flag to `logcli query`,
which causes the output to include all common labels.

This is mostly useful with `--quiet` and `--output=jsonl`
as it allows users to get structured information from Loki
that has *all* the information that Loki can provide.

Fixes grafana#5702
@jml
jml requested a review from a team as a code owner January 6, 2025 17:07
@CLAassistant

CLAassistant commented Jan 6, 2025

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@chaudum chaudum left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor suggestion regarding flag help text, but otherwise LGMT. Thanks!

Comment thread cmd/logcli/main.go Outdated
Co-authored-by: Christian Haudum <christian.haudum@gmail.com>
Signed-off-by: Jonathan Lange <jml@mumak.net>
@jml
jml requested a review from chaudum January 8, 2025 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3 participants