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

docs: Clarify Unit Requirement for Duration Comparison in Label Values #13318

Merged
merged 2 commits into from
Jun 25, 2024

Conversation

ghost
Copy link

@ghost ghost commented Jun 25, 2024

What this PR does / why we need it:
This update clarifies the requirement for units within the original label value when making a Duration comparison. It ensures that users understand the necessity of including a unit suffix (e.g., 'ms', 'h') for accurate parsing and comparison.

Which issue(s) this PR fixes:
Fixes #

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

Sure, here's a suitable pull request description:

Description
This update clarifies the requirement for units within the original label value when making a Duration comparison. It ensures that users understand the necessity of including a unit suffix (e.g., 'ms', 'h') for accurate parsing and comparison.

Changes
Updated documentation to specify that the label value must include a unit suffix.
Added examples and notes about using label_format to modify the value and append the unit before comparison.
Motivation and Context
Clarifies the need for units within the original label value when making a Duration comparison, preventing potential parsing errors and improving the accuracy of comparisons.
@ghost ghost self-requested a review as a code owner June 25, 2024 16:55
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jun 25, 2024
@CLAassistant
Copy link

CLAassistant commented Jun 25, 2024

CLA assistant check
All committers have signed the CLA.

@ghost ghost changed the title Clarify Unit Requirement for Duration Comparison in Label Values docs: Clarify Unit Requirement for Duration Comparison in Label Values Jun 25, 2024
@grafanabot
Copy link
Collaborator

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

1 similar comment
@grafanabot
Copy link
Collaborator

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

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, thanks for taking the time to improve the docs!

@JStickler JStickler merged commit 5570855 into main Jun 25, 2024
61 checks passed
@JStickler JStickler deleted the nickgrafana-docs-duration-comparison branch June 25, 2024 18:31
grafanabot pushed a commit that referenced this pull request Jun 25, 2024
grafanabot pushed a commit that referenced this pull request Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-2.9.x backport release-3.0.x size/XS type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants