8000 types.db(5): Improve wording and document conventions. by octo · Pull Request #3458 · collectd/collectd · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

types.db(5): Improve wording and document conventions. #3458

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
Merged
merged 1 commit into from
May 12, 2020
Merged

types.db(5): Improve wording and document conventions. #3458

merged 1 commit into from
May 12, 2020

Conversation

octo
Copy link
Member
@octo octo commented May 11, 2020 •
edited
Loading

I just wanted to document that data source names must be unique within a data set (see prometheus/collectd_exporter#78) and ended up rewording most of the manpage.

ChangeLog: types.db(5): Documentation of metric definitions has been improved.

@octo octo requested a review from a team as a code owner May 11, 2020 07:39
@octo octo mentioned this pull request May 11, 2020
Open
igorpeshansky
igorpeshansky requested changes May 11, 2020
View reviewed changes
src/types.db.pod Outdated

I<min> and I<max> define the range of valid values this data source. Either or
both may be unbounded, which is specified by providing C<U> instead of a
number.
Copy link
Contributor

Choose a reason for hiding this comment

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

[Optional] Should we add "The type of the min and max values corresponds to the value type (double for GAUGE, int64 for DERIVE and COUNTER)"?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, for DERIVE and COUNTER, min and max refer to the rate, not the raw value. Added a note about this.

igorpeshansky
igorpeshansky requested changes May 11, 2020
View reviewed changes
Copy link
Contributor
@igorpeshansky igorpeshansky left a comment

Choose a reason for hiding this comment

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

Minor comments.

igorpeshansky
igorpeshansky approved these changes May 11, 2020
View reviewed changes
Copy link
Contributor
@igorpeshansky igorpeshansky left a comment

Choose a reason for hiding this comment

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

LGTM :shipit:

@octo
Copy link
Member Author
octo commented May 12, 2020

Thanks Igor!

@octo octo merged commit 9a89d60 into collectd:master May 12, 2020
@octo octo deleted the man-types-db branch May 12, 2020 07:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@igorpeshansky igorpeshansky igorpeshansky approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@octo @igorpeshansky
0