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.

Sign up for GitHub

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

Jump to bottom

docs: Update logcli command reference #12850

Merged
merged 3 commits into from
May 3, 2024
Merged

docs: Update logcli command reference #12850

merged 3 commits into from
May 3, 2024

Conversation

ystkfujii
Copy link
Contributor

What this PR does / why we need it:

Updated logcli command reference.

The version of loki is v3.

$ logcli --version
WARN[0000] The "OTELCOL_ARGS" variable is not set. Defaulting to a blank string. 
logcli, version release-3.0.x-b4f7181 (branch: release-3.0.x, revision: b4f7181)
  build user:       root@buildkitsandbox
  build date:       2024-04-08T18:33:09Z
  go version:       go1.21.9
  platform:         linux/amd64
  tags:             netgo

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

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
  • For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
  • 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

@ystkfujii ystkfujii requested a review from a team as a code owner May 2, 2024 05:45
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label May 2, 2024
chaudum
chaudum reviewed May 2, 2024
View reviewed changes
Copy link
Contributor

@chaudum chaudum left a comment

Choose a reason for hiding this comment

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

Thanks for updating this page! LGTM

I will let the docs team approve and merge the PR.

docs/sources/query/logcli.md Outdated
@@ -400,6 +413,76 @@ Args:
<query> eg '{foo="bar",baz=~".*blip"} |~ ".*error.*"'
```

### LogCLI instant-query command reference
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Could we mark the query type in all the headings as code and remove the redundant "LogCLI" prefix, as this would shorten the ToC on the right side of the page.

Suggested change
### LogCLI instant-query command reference
### `instant-query` command reference

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done !

JStickler
JStickler reviewed May 2, 2024
View reviewed changes
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] If we could just revert two of the heading changes, then this will be ready to merge.

docs/sources/query/logcli.md Outdated Show resolved Hide resolved
docs/sources/query/logcli.md Outdated Show resolved Hide resolved
docs/sources/query/logcli.md Outdated Show resolved Hide resolved
docs/sources/query/logcli.md Outdated Show resolved Hide resolved
docs/sources/query/logcli.md Outdated Show resolved Hide resolved
docs/sources/query/logcli.md Outdated Show resolved Hide resolved
@ystkfujii
Copy link
Contributor Author

[docs team] If we could just revert two of the heading changes, then this will be ready to merge.

Thank you for the suggestion! I have applied it.

@ystkfujii
docs: Remove the redundant prefix
900dec1 
Apply suggestions from code review

Co-authored-by: J Stickler <julie.stickler@grafana.com>

wip
@ystkfujii ystkfujii force-pushed the doc/update_logcli branch 2 times, most recently from 9b2f729 to 900dec1 Compare May 3, 2024 07:59
@ystkfujii
Copy link
Contributor Author

I squashed the commits

@grafanabot
Copy link
Collaborator

This PR must be merged before a backport PR will be created.

JStickler
JStickler approved these changes May 3, 2024
View reviewed changes
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[Docs team] LGTM

@JStickler JStickler merged commit e684ec8 into grafana:main May 3, 2024
61 checks passed
grafanabot pushed a commit that referenced this pull request May 3, 2024
@ystkfujii @grafana-delivery-bot
docs: Update logcli command reference (#12850)
6f2dc2a 
Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit e684ec8)
@grafanabot grafanabot mentioned this pull request May 3, 2024
Merged
7 tasks
shantanualsi pushed a commit that referenced this pull request May 6, 2024
@ystkfujii @JStickler @shantanualsi
docs: Update logcli command reference (#12850)
15eb8c5 
Co-authored-by: J Stickler <julie.stickler@grafana.com>
@RodrigoCMoraes RodrigoCMoraes mentioned this pull request Jul 12, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chaudum chaudum chaudum left review comments

@JStickler JStickler JStickler approved these changes

Assignees
No one assigned
Labels
backport release-3.0.x size/XL type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ystkfujii @grafanabot @chaudum @JStickler