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

Add description, units, and notes to metrics/labels in application metadata files. #1773

Merged
merged 45 commits into from
Aug 21, 2024
Merged

Add description, units, and notes to metrics/labels in application metadata files. #1773

merged 45 commits into from
Aug 21, 2024

Conversation

igorpeshansky
Copy link
Member

@igorpeshansky igorpeshansky commented Aug 4, 2024 •
edited
Loading

Description

This builds on #1772 to add description and notes fields to metrics and metric labels, as well as a unit field to metrics.

As an example of how to use this, descriptions, units, and notes are added to the dcgm/metadata.yaml file. Other files can be filled in as a follow-up.

In addition, it makes the following changes to the MySQL/MariaDB metadata (currently not used as the source of truth for the docs):

  • Add notes to logs and log fields to reflect the dependency on the MySQL/MariaDB logging options.
  • Remove mention of stale application_version configuration option.
  • Document correct defaults for endpoint and username.
  • Remove extraneous test-only log collection for MariaDB.

Related issue

b/354042783

How has this been tested?

The dcgm metrics can now render as follows:
image

Checklist:

  • Unit tests
    • Unit tests do not apply.
    • Unit tests have been added/modified and passed for this PR.
  • Integration tests
    • Integration tests do not apply.
    • Integration tests have been added/modified and passed for this PR.
  • Documentation
    • This PR introduces no user visible changes.
    • This PR introduces user visible changes and the corresponding documentation change has been made.
  • Minor version bump
    • This PR introduces no new features.
    • This PR introduces new features, and there is a separate PR to bump the minor version since the last release already.
    • This PR bumps the version.

@igorpeshansky
Update and format third-party app documentation.
3c97721 
Add missing logos.
@igorpeshansky
Rename LogFields to LogField.
acecd58
@igorpeshansky
Enable unique validation for log fields.
168a8ee
@igorpeshansky
Record the application name in all metadata validation tests.
210a8cf
@igorpeshansky
Reuse ExpectedMetricsContainer type.
bcf790c
@igorpeshansky
Record filename when parsing/validating metadata.
44e870e
@igorpeshansky
Enable duplicate key validation.
5bde3fe
@igorpeshansky
Use example username/password for testing rabbitmq. Fix postgresql ve…
33173ce 
…rsion.

Whitespace cleanup.
@igorpeshansky
Add JMX config for Jetty.
7ca9e0e
@igorpeshansky
Update MariaDB logo path.
e6f0602
@igorpeshansky
Add JMX config for ActiveMQ.
62891fc
@igorpeshansky
Add information on Couchbase logs.
a0c7f53
@igorpeshansky
Add syslog Jetty metrics. Make "JMX Service URL" a hyperlink.
1a36f30
@igorpeshansky
Add kafka log field descriptions.
d81636e
@igorpeshansky
Add RabbitMQ setup instructions, plus other minor tweaks.
6adfd8d
@igorpeshansky
Update Vault description.
77d8358
@igorpeshansky
Add MongoDB cardinality note.
aa4fbdf
@igorpeshansky
Fix ActiveMQ, CouchDB, Kafka, and MongoDB version strings.
bb70d5a
@igorpeshansky
Correct Elasticsearch minimum metrics version.
8fc3e53 
Those metrics were collected since 2.21.0, but not documented.
@igorpeshansky
Remove timestamp from Couchbase, Kafka, and Vault expected logs.
e0ac815 
All log entries have a timestamp, so it's a vacuous expectation.
@igorpeshansky
Update DCGM URL.
d4724ee
@igorpeshansky
IIS and MSSQL updates.
25dc66a
@igorpeshansky
Minor MySQL/MariaDB updates.
d3d98d4
@igorpeshansky
Remove "external" link tags.
c1b0dfe
@igorpeshansky
Extract metric spec information into its own struct.
9adfb25
@igorpeshansky
It's monitored_resources, plural.
d5f5615
@igorpeshansky
Extract metric label spec into its own struct.
acd37b8
@igorpeshansky
Add description and units to metrics and labels.
fb64de3
@igorpeshansky
Add the ability to annotate metrics and labels with notes.
1e7dbb9
@igorpeshansky igorpeshansky requested a review from mtabasko August 4, 2024 07:52
jefferbrecht
jefferbrecht approved these changes Aug 7, 2024
View reviewed changes
Copy link
Member

@jefferbrecht jefferbrecht left a comment

Choose a reason for hiding this comment

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

LGTM, just a minor non-blocking comment.

@igorpeshansky igorpeshansky force-pushed the igorpeshansky-metadata-extra-info branch from 5f48f07 to 6df099e Compare August 7, 2024 21:31
@igorpeshansky igorpeshansky force-pushed the igorpeshansky-metadata-extra-info branch from c7f69a2 to a027ed5 Compare August 7, 2024 22:33
@igorpeshansky igorpeshansky force-pushed the igorpeshansky-metadata-extra-info branch 2 times, most recently from 40719be to d30193b Compare August 19, 2024 21:59
mtabasko
mtabasko approved these changes Aug 21, 2024
View reviewed changes
Copy link
Collaborator

@mtabasko mtabasko left a comment

Choose a reason for hiding this comment

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

LGTM!

@igorpeshansky igorpeshansky merged commit 0f03a99 into master Aug 21, 2024
60 of 63 checks passed
@igorpeshansky igorpeshansky deleted the igorpeshansky-metadata-extra-info branch August 21, 2024 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jefferbrecht jefferbrecht jefferbrecht approved these changes

@mtabasko mtabasko mtabasko approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@igorpeshansky @mtabasko @jefferbrecht