System metrics semantic conventions #937

aabmass · 2020-09-09T19:59:44Z

Fixes #818

Changes

Adds system metric conventions/instruments from open-telemetry/oteps#119 to the spec. This PR does not include process level metrics (just a placeholder and TODO), which I can do in a separate PR. In addition to what is in open-telemetry/oteps#119:

I added system.process.count (requested here).
Changed utilization instruments from UpDownSumObserver to ValueObserver (discussion in Writing system metrics conventions into the specification #818)

Related issues #818

Related oteps open-telemetry/oteps#119

Conventions from [OTEP 119](open-telemetry/oteps#119)

specification/metrics/semantic_conventions/system-metrics.md

specification/metrics/semantic_conventions/runtime-metrics.md

specification/metrics/semantic_conventions/system-metrics.md

specification/metrics/semantic_conventions/README.md

specification/metrics/semantic_conventions/runtime-metrics.md

specification/metrics/semantic_conventions/system-metrics.md

kenfinnigan · 2020-09-25T19:54:11Z

Is there a definition of "system" and "process" anywhere, and how it relates to the different Resources that could be present?

For instance, the system metrics being output will be very different depending on what that system might be: physical, virtual, Kube Pod, Kube Container, etc.

I couldn't see a way that the system metrics can be tied back into the "type" of a system it came from, but I may have missed it.

Coming from a JVM background, would anything related to JVM metrics fall under the "process" metrics section? Will the process metrics be coming in a later PR?

aabmass · 2020-09-28T17:35:14Z

I couldn't see a way that the system metrics can be tied back into the "type" of a system it came from, but I may have missed it.

The "type" info should be in the Resource attached to these metrics, which should follow these resource semantic conventions (e.g. attributes for k8s and containers).

Coming from a JVM background, would anything related to JVM metrics fall under the "process" metrics section? Will the process metrics be coming in a later PR?

I believe all of the JVM metrics would be under the runtime. prefix. Process metrics I'm planning for a separate PR

jmacd · 2020-10-05T17:02:54Z

@open-telemetry/specs-metrics-approvers Please review. This has survived many rounds of review and discussion. @aabmass I reviewed the open conversations and think all can be resolved, thanks.

tigrannajaryan

This is a very useful document, thank you.

specification/metrics/semantic_conventions/README.md

tigrannajaryan · 2020-10-05T18:56:14Z

specification/metrics/semantic_conventions/README.md

+  **time** instruments are a special case of **usage** metrics, where the
+  **limit** can usually be calculated as the sum of **time** over all label
+  values. **utilization** can also be calculated and useful, for example


I am not sure I understand what this tries to say.

As an example, the sum over all state labels of system.cpu.time (idle, user, etc.) gives system.cpu.limit Does that make sense? Happy to remove this too if it's not very useful.

specification/metrics/semantic_conventions/README.md

specification/metrics/semantic_conventions/process-metrics.md

specification/metrics/semantic_conventions/system-metrics.md

MrAlias

🚀

Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>

justinfoote

Thanks for this! I especially found the general semantic conventions addition to be userful.

andrewhsu

LGTM

TIL of UCUM

james-bebbington

LGTM just a few nits

specification/metrics/semantic_conventions/README.md

specification/metrics/semantic_conventions/system-metrics.md

Co-authored-by: James Bebbington <jbebbington@google.com>

specification/metrics/semantic_conventions/README.md

Co-authored-by: Joshua MacDonald <jmacd@users.noreply.github.com>

jmacd · 2020-10-15T19:07:02Z

🎉

aabmass force-pushed the system-metrics-818 branch 3 times, most recently from 99e7891 to 87bc60c Compare September 9, 2020 20:14

System metrics semantic conventions

1040fc2

Conventions from [OTEP 119](open-telemetry/oteps#119)

aabmass force-pushed the system-metrics-818 branch from 87bc60c to 1040fc2 Compare September 9, 2020 20:34

aabmass commented Sep 9, 2020

View reviewed changes

specification/metrics/semantic_conventions/system-metrics.md Outdated Show resolved Hide resolved

specification/metrics/semantic_conventions/system-metrics.md Outdated Show resolved Hide resolved

aabmass marked this pull request as ready for review September 9, 2020 20:36

aabmass requested a review from a team as a code owner September 9, 2020 20:36

aabmass requested a review from a team September 9, 2020 20:36

aabmass requested a review from a team as a code owner September 9, 2020 20:36

aabmass commented Sep 10, 2020

View reviewed changes

specification/metrics/semantic_conventions/system-metrics.md Outdated Show resolved Hide resolved

change process count to UpDownSumObserver

f7f2ef7

james-bebbington reviewed Sep 11, 2020

View reviewed changes

davidbtucker reviewed Sep 11, 2020

View reviewed changes

specification/metrics/semantic_conventions/system-metrics.md Outdated Show resolved Hide resolved

specification/metrics/semantic_conventions/system-metrics.md Outdated Show resolved Hide resolved

fix system.cpu.utilization, use better example

98d72a1

bogdandrutu assigned jmacd Sep 11, 2020

james-bebbington reviewed Sep 11, 2020

View reviewed changes

specification/metrics/semantic_conventions/system-metrics.md Outdated Show resolved Hide resolved

kjordy reviewed Sep 11, 2020

View reviewed changes

specification/metrics/semantic_conventions/system-metrics.md Outdated Show resolved Hide resolved

specification/metrics/semantic_conventions/system-metrics.md Outdated Show resolved Hide resolved

igorpeshansky reviewed Sep 17, 2020

View reviewed changes

jmacd added the spec:metrics Related to the specification/metrics directory label Sep 21, 2020

james-bebbington mentioned this pull request Sep 23, 2020

Report Windows pagefile usage in bytes open-telemetry/opentelemetry-collector#1837

Merged

aabmass added 4 commits September 24, 2020 21:31

first several comments

9d20079

add description columns, update units to UCUM

fd6375e

Merge branch 'master' into system-metrics-818

9d871af

markdown-toc

a0e3e2d

asuresh4 reviewed Sep 25, 2020

View reviewed changes

specification/metrics/semantic_conventions/system-metrics.md Outdated Show resolved Hide resolved

aabmass added 2 commits September 28, 2020 17:51

Merge branch 'master' into system-metrics-818

7d02a69

clarify OS process level metrics

4f7d3e1

tigrannajaryan reviewed Oct 5, 2020

View reviewed changes

MrAlias approved these changes Oct 6, 2020

View reviewed changes

aabmass and others added 8 commits October 6, 2020 16:42

Update specification/metrics/semantic_conventions/README.md

cde2393

Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>

Update specification/metrics/semantic_conventions/README.md

b758d24

Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>

Apply suggestions from code review

c9a37fb

Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>

fix tigran comments

6c1c579

add disk io_time and operation_time

5ffcb58

add descriptions/footnotes for dropped packets and net errors

1b90514

Merge branch 'master' into system-metrics-818

5ffd8d0

lint, more info for net dropped packets/errors

7b14a93

justinfoote approved these changes Oct 8, 2020

View reviewed changes

"dropped_packets" -> "dropped"

a903783

andrewhsu approved these changes Oct 9, 2020

View reviewed changes

james-bebbington approved these changes Oct 9, 2020

View reviewed changes

justinfoote mentioned this pull request Oct 9, 2020

Update Metrics Semantic Conventions README #1084

Open

aabmass and others added 3 commits October 12, 2020 12:34

Apply suggestions from James' code review

c218cac

Co-authored-by: James Bebbington <jbebbington@google.com>

comments from James' code review

09a31b7

Merge branch 'master' into system-metrics-818

fdea5e4

lzchen approved these changes Oct 12, 2020

View reviewed changes

clarify windows perf counter

8fec8f9

jmacd approved these changes Oct 15, 2020

View reviewed changes

specification/metrics/semantic_conventions/README.md Outdated Show resolved Hide resolved

aabmass and others added 3 commits October 15, 2020 14:07

Update specification/metrics/semantic_conventions/README.md

aa5e16e

Co-authored-by: Joshua MacDonald <jmacd@users.noreply.github.com>

reflow text

aa28566

Merge branch 'master' into system-metrics-818

7f808ab

jmacd merged commit 60250bf into open-telemetry:master Oct 15, 2020

aabmass deleted the system-metrics-818 branch October 15, 2020 20:22

justinfoote mentioned this pull request Oct 16, 2020

More prescriptive guidance on metric naming #600

Closed

matej-g mentioned this pull request Oct 28, 2020

Host instrumentation for available memory on Linux systems is less accurate than is tested for open-telemetry/opentelemetry-go-contrib#425

Open

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

System metrics semantic conventions #937

System metrics semantic conventions #937

aabmass commented Sep 9, 2020 •

edited

Loading

kenfinnigan commented Sep 25, 2020

aabmass commented Sep 28, 2020

jmacd commented Oct 5, 2020

tigrannajaryan left a comment

tigrannajaryan Oct 5, 2020

aabmass Oct 6, 2020

MrAlias left a comment

justinfoote left a comment

andrewhsu left a comment

james-bebbington left a comment

jmacd commented Oct 15, 2020

System metrics semantic conventions #937

System metrics semantic conventions #937

Conversation

aabmass commented Sep 9, 2020 • edited Loading

Changes

kenfinnigan commented Sep 25, 2020

aabmass commented Sep 28, 2020

jmacd commented Oct 5, 2020

tigrannajaryan left a comment

Choose a reason for hiding this comment

tigrannajaryan Oct 5, 2020

Choose a reason for hiding this comment

aabmass Oct 6, 2020

Choose a reason for hiding this comment

MrAlias left a comment

Choose a reason for hiding this comment

justinfoote left a comment

Choose a reason for hiding this comment

andrewhsu left a comment

Choose a reason for hiding this comment

james-bebbington left a comment

Choose a reason for hiding this comment

jmacd commented Oct 15, 2020

aabmass commented Sep 9, 2020 •

edited

Loading