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.

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

Specify process.runtime for Python. #1160

Merged
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 34 additions & 9 deletions specification/resource/semantic_conventions/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,16 +88,41 @@ TODO(<https://github.com/open-telemetry/opentelemetry-dotnet/issues/1281>): Conf

***Python Runtimes:***

TODO(<https://github.com/open-telemetry/opentelemetry-python/issues/1127>): Confirm the contents here
Python instrumentation should fill in the values as follows:

| Value | Description |
| --- | --- |
| `cpython` | CPython |
| `graalvm` | GraalVM |
| `ironpython` | IronPython |
| `jython` | Jython |
| `pypy` | PyPy|
| `pythonnet` | PythonNet |
- `process.runtime.name` -
Fill in the value of [`sys.implementation.name`][py_impl]
- `process.runtime.version` -
Fill in the [`sys.implementation.version`][py_impl] values separated by dots.
Leave out the release level and serial if the release level
equals `final` and the serial equals zero
(leave out either both or none).

This can be implemented with the following Python snippet:

```python
vinfo = sys.implementation.version
result = '.'.join(map(str, vinfo[:3])) + (
'' if vinfo.releaselevel == "final" and not vinfo.serial
else vinfo.releaselevel + str(vinfo.serial))
Oberon00 marked this conversation as resolved.
Show resolved Hide resolved
```

- `process.runtime.description` - Fill in the value of [`sys.version`](https://docs.python.org/3/library/sys.html#sys.version) as-is.

[py_impl]: https://docs.python.org/3/library/sys.html#sys.implementation

Examples for some Python runtimes:

| Name | `process.runtime.name` | `process.runtime.version` | `process.runtime.description` |
| --- | --- | --- | --- |
| CPython 3.7.3 on Windows | cpython | 3.7.3 | 3.7.3 (v3.7.3:ef4ec6ed12, Mar 25 2019, 22:22:05) [MSC v.1916 64 bit (AMD64)] |
| CPython 3.8.6 on Linux | cpython | 3.8.6 | 3.8.6 (default, Sep 30 2020, 04:00:38) <br>[GCC 10.2.0] |
| PyPy 3 7.3.2 on Linux | pypy | 3.7.4 | 3.7.4 (?, Sep 27 2020, 15:12:26)<br>[PyPy 7.3.2-alpha0 with GCC 10.2.0] |

Note that on Linux, there is an actual newline in the `sys.version` string,
and the CPython string had a trailing space in the first line.

Pypy provided a CPython-compatible version in `sys.implementation.version` instead of the actual implementation version which is available in `sys.version`.
Copy link
Member Author

Choose a reason for hiding this comment

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

This is a bit sad. We could another special case for PyPy to the runtime.version determination to use

>>>> sys.pypy_version_info
(major=7, minor=3, micro=2, releaselevel='alpha', serial=0)

Copy link
Member

Choose a reason for hiding this comment

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

Sounds reasonable since PyPy is not conforming to the docs here

Copy link
Member Author

Choose a reason for hiding this comment

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

I guess it is too late to change this in this PR now, unless there is a strong opinion. @open-telemetry/python-approvers feel free to suggest a follow-up spec PR if this comes up again when implementing.


***Ruby Runtimes:***

Expand Down