Generate process metrics with `semconv` yaml #330

braydonk · 2023-09-18T19:01:25Z

Supplants #160

Changes

This PR adds a yaml version of the process metrics and changes the process metrics documentation to be generated from the yaml instead of hand-written.

Merge requirement checklist

CONTRIBUTING.md guidelines followed.
CHANGELOG.md updated for non-trivial changes.
schema-next.yaml updated with changes to existing conventions.

braydonk · 2023-09-18T19:36:45Z

I am unable to assign reviewers, these are the folks who commented on the previous PR. @joaopgrassi @mx-psi @jsuereth

mx-psi · 2023-09-19T11:46:21Z

Needs minor edits for CI to pass but content LGTM

docs/system/process-metrics.md

braydonk · 2023-09-19T13:33:14Z

Needs minor edits for CI to pass

Thanks @mx-psi those are fixed now, also added something to .yamllint to not scan node_modulues when running yamllint locally (didn't think it was worth a whole separate PR for something that small).

braydonk · 2023-09-19T13:40:12Z

Looks like these workflows require approval now if someone can press the button for me. 😄

ChrsMark

Content-wise lgtm!

@braydonk please file an issue for #330 (comment) so as to examine #260 as well :).

braydonk · 2023-09-20T12:21:31Z

Thanks, I'll file an issue today and I'll put my thoughts on #260 in there!

joaopgrassi · 2023-09-26T07:54:48Z

I will try to take a look at it today or tomorrow!

joaopgrassi

Here's a first pass

CHANGELOG.md

model/metrics/process-metrics.yaml

schema-next.yaml

docs/system/process-metrics.md

braydonk · 2023-10-10T15:59:18Z

Sorry for the force-push, I should have merged instead of rebasing to update the branch. Force of habit

model/metrics/process-metrics.yaml

braydonk · 2023-10-11T15:56:52Z

It's possible I'm missing some kind of context from discussions around #51, but it seems like what I have here should be fine. With the paging fault type attribute for example: it is in the process.paging.faults namespace. I added that namespace, as the attribute was previously type (just type). process.paging is not any more of a proper namespace than process.paging.faults as far as I can tell.

If I'm indeed missing some extra guidance that's not present in #51, and this attribute should go to process.paging, then I can also rename it to fault_type. But I would like to understand why this and the other pointed out attributes are not following the decision from #51 already.

joaopgrassi · 2023-10-12T07:46:37Z

With the paging fault type attribute for example: it is in the process.paging.faults namespace

The thing I'm not sure is that process.paging.faults is the metric, not a namespace. From reading #51 and the linked issues, my interpretation is that attributes should go on the namespace , meaning process.paging.* in this case. Maybe we need clarification if attributes can also be nested under the "implicit metric namespace".

CC @open-telemetry/specs-semconv-approvers @open-telemetry/specs-semconv-maintainers

Edit: There's also this old issue which I think is related and was never closed with a decision #50

braydonk · 2023-11-07T17:44:07Z

I have updated the PR to match the semantic convention guidance as well as I'm able.

I renamed the metrics that are updowncounters to use the .count pluralization method. I also changed the metric attributes such that they do not use the metric names as namespaces.

joaopgrassi

I think this looks good now. Just a few markdown structural nits

docs/system/process-metrics.md

Fixes linting errors, also adds the `ignore-from-file` configuration the the `.yamllint` to avoid scanning `node_modules` locally.

in progress 2 in progress 3

Rename metrics that are updowncounters to use the `.count` naming convention. Also rename attributes to not use metric names as namespaces.

disk.io.direction and network.io.direction were added to the global registry, so this commit uses references to those attributes.

braydonk · 2024-01-10T16:07:14Z

I added proposed_changelog.md and proposed_schema_next.yaml, which upon PR approval I will add properly to the CHANGELOG.md and schema-next.yaml files. This is to avoid constantly needing to rebase these giant files if the PR lasts over a long period of time.

Do not merge until I've added these back to the main files.

joaopgrassi

LGTM after fixing the CI issues

ChrsMark

LGTM. Let's make sure that we file an issue for moving the attributes to the registry: #330 (comment)

braydonk · 2024-01-18T21:38:26Z

LGTM. Let's make sure that we file an issue for moving the attributes to the registry: #330 (comment)

Opened #650 to track this.

braydonk · 2024-01-18T21:38:36Z

This should be ready for merge.

joaopgrassi · 2024-01-22T12:06:31Z

I will bring this up in the semconv SIG meeting today, to raise awareness. I guess we can merge it then later today/tomorrow if no objections.

braydonk requested review from a team September 18, 2023 19:01

github-actions bot assigned jsuereth Sep 18, 2023

braydonk mentioned this pull request Sep 18, 2023

Generate process metrics with semconv yaml #160

Closed

mx-psi approved these changes Sep 19, 2023

View reviewed changes

mx-psi requested review from jsuereth and joaopgrassi September 19, 2023 11:46

ChrsMark reviewed Sep 19, 2023

View reviewed changes

docs/system/process-metrics.md Outdated Show resolved Hide resolved

ChrsMark approved these changes Sep 20, 2023

View reviewed changes

braydonk mentioned this pull request Sep 20, 2023

Revisit process metrics #334

Open

mx-psi requested a review from AlexanderWert September 20, 2023 15:35

joaopgrassi reviewed Oct 2, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

model/metrics/process-metrics.yaml Outdated Show resolved Hide resolved

schema-next.yaml Outdated Show resolved Hide resolved

docs/system/process-metrics.md Show resolved Hide resolved

braydonk force-pushed the process_metrics branch from cc24409 to 5ad3a95 Compare October 10, 2023 15:57

joaopgrassi reviewed Oct 11, 2023

View reviewed changes

model/metrics/process-metrics.yaml Outdated Show resolved Hide resolved

model/metrics/process-metrics.yaml Outdated Show resolved Hide resolved

model/metrics/process-metrics.yaml Outdated Show resolved Hide resolved

braydonk mentioned this pull request Oct 12, 2023

Should metric namespaces be restricted from also being metric names? #50

Open

mx-psi mentioned this pull request Oct 16, 2023

Revisit system network metrics attributes #308

Open

braydonk force-pushed the process_metrics branch 3 times, most recently from e10cc9a to c6db7c5 Compare November 7, 2023 17:40

joaopgrassi reviewed Jan 9, 2024

View reviewed changes

docs/system/process-metrics.md Show resolved Hide resolved

docs/system/process-metrics.md Show resolved Hide resolved

braydonk force-pushed the process_metrics branch from 0ecb60a to e88fe68 Compare January 10, 2024 16:00

braydonk added 8 commits January 10, 2024 16:04

metrics: add process-metrics.yaml

5b18d00

Fix lint errors, add ignore to .yamllint

fdf90ea

Fixes linting errors, also adds the `ignore-from-file` configuration the the `.yamllint` to avoid scanning `node_modules` locally.

address comments, fix conflicts

aee0ef6

in progress 2 in progress 3

adding conflict fix I forgot to save

c6909b3

generate toc, fix markdownlint

9e3acf3

rename metrics and attributes for spec compliance

fe0f2d7

Rename metrics that are updowncounters to use the `.count` naming convention. Also rename attributes to not use metric names as namespaces.

in progress

7333624

Use global refs to io direction attributes

d971697

disk.io.direction and network.io.direction were added to the global registry, so this commit uses references to those attributes.

braydonk force-pushed the process_metrics branch from e88fe68 to d971697 Compare January 10, 2024 16:04

braydonk added 2 commits January 15, 2024 14:52

Add recommended metric notices

914e018

Forgot to define the MetricRecommended link

0ecab73

joaopgrassi approved these changes Jan 17, 2024

View reviewed changes

braydonk and others added 3 commits January 18, 2024 16:14

Add changelog and schema entries

f942cdb

generate table of contents

d5f31ba

Merge branch 'main' into process_metrics

ff78758

ChrsMark approved these changes Jan 18, 2024

View reviewed changes

fix bad schema entry that was left in by accident

05f6cd3

braydonk mentioned this pull request Jan 18, 2024

Process metrics attributes moved to registry #650

Open

dmitryax approved these changes Jan 20, 2024

View reviewed changes

Merge branch 'main' into process_metrics

6bfce76

AlexanderWert approved these changes Jan 22, 2024

View reviewed changes

jsuereth approved these changes Jan 22, 2024

View reviewed changes

joaopgrassi merged commit d21135e into open-telemetry:main Jan 23, 2024
9 checks passed

braydonk mentioned this pull request Feb 8, 2024

Move process metric attributes to the registry #681

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate process metrics with `semconv` yaml #330

Generate process metrics with `semconv` yaml #330

braydonk commented Sep 18, 2023 •

edited

Loading

braydonk commented Sep 18, 2023

mx-psi commented Sep 19, 2023

braydonk commented Sep 19, 2023

braydonk commented Sep 19, 2023

ChrsMark left a comment

braydonk commented Sep 20, 2023

joaopgrassi commented Sep 26, 2023

joaopgrassi left a comment

braydonk commented Oct 10, 2023

braydonk commented Oct 11, 2023 •

edited

Loading

joaopgrassi commented Oct 12, 2023 •

edited

Loading

braydonk commented Nov 7, 2023

joaopgrassi left a comment

braydonk commented Jan 10, 2024 •

edited

Loading

joaopgrassi left a comment

ChrsMark left a comment

braydonk commented Jan 18, 2024

braydonk commented Jan 18, 2024

joaopgrassi commented Jan 22, 2024

Generate process metrics with semconv yaml #330

Generate process metrics with semconv yaml #330

Conversation

braydonk commented Sep 18, 2023 • edited Loading

Changes

Merge requirement checklist

braydonk commented Sep 18, 2023

mx-psi commented Sep 19, 2023

braydonk commented Sep 19, 2023

braydonk commented Sep 19, 2023

ChrsMark left a comment

Choose a reason for hiding this comment

braydonk commented Sep 20, 2023

joaopgrassi commented Sep 26, 2023

joaopgrassi left a comment

Choose a reason for hiding this comment

braydonk commented Oct 10, 2023

braydonk commented Oct 11, 2023 • edited Loading

joaopgrassi commented Oct 12, 2023 • edited Loading

braydonk commented Nov 7, 2023

joaopgrassi left a comment

Choose a reason for hiding this comment

braydonk commented Jan 10, 2024 • edited Loading

joaopgrassi left a comment

Choose a reason for hiding this comment

ChrsMark left a comment

Choose a reason for hiding this comment

braydonk commented Jan 18, 2024

braydonk commented Jan 18, 2024

joaopgrassi commented Jan 22, 2024

Generate process metrics with `semconv` yaml #330

Generate process metrics with `semconv` yaml #330

braydonk commented Sep 18, 2023 •

edited

Loading

braydonk commented Oct 11, 2023 •

edited

Loading

joaopgrassi commented Oct 12, 2023 •

edited

Loading

braydonk commented Jan 10, 2024 •

edited

Loading