Add process.handles to process metrics spec
#142
Conversation
Adding a new metric to the `process-metric.md` spec for process handle count. Signed-off-by: braydonk <braydonk@google.com>
| | `process.disk.io` | Counter | By | Disk bytes transferred. | `direction` SHOULD be one of: `read`, `write` | | ||
| | `process.network.io` | Counter | By | Network bytes transferred. | `direction` SHOULD be one of: `receive`, `transmit` | | ||
| | Name | Instrument Type ([\*](README.md#instrument-types)) | Unit | Description | Labels | | ||
| | ------------------------------- | -------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
There was a problem hiding this comment.
My editor did this formatting I think, should I try to revert it? Not sure if this is expected.
| | `process.open_file_descriptors` | UpDownCounter | {count} | Number of file descriptors in use by the process. | | | ||
| | `process.context_switches` | Counter | {count} | Number of times the process has been context switched. | `type` SHOULD be one of: `involuntary`, `voluntary` | | ||
| | `process.open_file_descriptors` | UpDownCounter | {count} | Number of file descriptors in use by the process. | | | ||
| | `process.handles` | UpDownCounter | {count} | Number of [handles](https://learn.microsoft.com/en-us/windows/win32/sysinfo/handles-and-objects) held by the process. Windows Only. | | |
There was a problem hiding this comment.
For system metrics we have https://github.com/open-telemetry/semantic-conventions/blob/main/specification/metrics/semantic_conventions/system-metrics.md#systemos---os-specific-system-metrics for OS-specific metrics. If we were to apply the rule here this would be process.windows.handles. Should we follow the same guidance for process metrics?
There was a problem hiding this comment.
That's a good question that I don't know the answer to. Anecdotally, I'd be surprised if there were other system-exclusive process metrics, so it may look weird to follow that pattern just for one metric. But I can't conclusively say that this won't happen again, so it may be worth doing.
There was a problem hiding this comment.
If it will be desirable to differentiate this metric from everything else, and we decide that the platform exclusive pattern isn't worth following for process metrics, then I could get behind process.win32_handles.
There was a problem hiding this comment.
Our naming conventions would suggest either process.windows.handles or process.win32.handles.
So, this DOES look like an OS-specific metric, but also one tied to processes. I think I'd prefer to see OS-extensions directly here in the list of Process metrics, similar for OS-specific disk extensions being in the disk section.
There was a problem hiding this comment.
I wasn't sure if that was a naming convention across all of these specs or only in the system metrics, since that lived in the system metrics spec. If that is a rule we intend to apply more universally then we can apply it here.
I assume the answer to this is yes, but I'll ask anyway: is it worth doing even in the potential future where this is the only metric listed in the windows extension, and potentially the only OS extension in this document? If we are following something that's a proper rule we intend to apply across the board, then it probably is worth doing.
There was a problem hiding this comment.
Circling back on this, should I do this? If so, I should change this in the metric definition that was contributed to hostmetricsreceiver in the collector.
There was a problem hiding this comment.
Yes, we're in the process of making some breaking changes and shoring up consistency. I'd recommend we do this in as small a timeframe as possible. Additionally, like HTTP semconv, there should be a transitionary period where users can select (with config or env variable or other flag mechanism) which semconv they want (old or new)
|
We have now the tooling to generate the metrics from YAML files. I know it's not part of this change, but I think as much as we delay, as much painful it will be to change. I already started doing it for a few of them. If you want to tackle it, you can see this PR I have for System Metrics #89 |
|
@joaopgrassi Sure, I can do that for these metrics. Might open a separate PR then rebase this one on that. |
| | `process.open_file_descriptors` | UpDownCounter | {count} | Number of file descriptors in use by the process. | | | ||
| | `process.context_switches` | Counter | {count} | Number of times the process has been context switched. | `type` SHOULD be one of: `involuntary`, `voluntary` | | ||
| | `process.open_file_descriptors` | UpDownCounter | {count} | Number of file descriptors in use by the process. | | | ||
| | `process.handles` | UpDownCounter | {count} | Number of [handles](https://learn.microsoft.com/en-us/windows/win32/sysinfo/handles-and-objects) held by the process. Windows Only. | | |
There was a problem hiding this comment.
| | `process.handles` | UpDownCounter | {count} | Number of [handles](https://learn.microsoft.com/en-us/windows/win32/sysinfo/handles-and-objects) held by the process. Windows Only. | | | |
| | `process.handles` | UpDownCounter | {count} | Number of [handles](https://learn.microsoft.com/windows/win32/sysinfo/handles-and-objects) held by the process. Windows Only. | | |
There was a problem hiding this comment.
Good point thanks, will include this change when I rebase.
|
Hey @braydonk what's the status of this PR? Are you planning to update/make more progress here? |
|
We're still going to have it in the process semantic conventions, but I'm going to re-do this PR pursuant to #160 merging so that it's in YAML instead. So I'll close this one for now, since it won't ever get merged in this form. |
Adding a new metric to the
process-metric.mdspec for process handle count.Related Issues:
open-telemetry/opentelemetry-collector-contrib#22813
open-telemetry/opentelemetry-specification#3556
Note: This is the first metric in this part of the spec that is platform specific; this concept only exists on Windows, and thus the metric will inherently never be implemented on another platform. I'm not sure if anything more should be done than the little "Windows only" note in the description.