opentelemetry-python icon indicating copy to clipboard operation
opentelemetry-python copied to clipboard

[Python] Add Project Status table for each Signal in README top section

Open trivikr opened this issue 1 year ago • 4 comments

Is your feature request related to a problem? Please describe.

The Project Status of Traces/Metrics/Logs Signals in OpenTelemetry is difficult to find in OpenTelemetry for Python.

Describe the solution you'd like Add Project Status Table at the top of README, similar to how it's done in other implementations:

  • .NET https://github.com/open-telemetry/opentelemetry-dotnet
  • Go https://github.com/open-telemetry/opentelemetry-go
  • CPP https://github.com/open-telemetry/opentelemetry-cpp

The Status Table would list Signal and the current status

| Signal  | Status                            | Project                           |
| ------- | --------------------------------- | --------------------------------- |
| Traces  | Experimental/Alpha/Beta/RC/Stable | [version](link-to-github-project) |
| Metrics | Experimental/Alpha/Beta/RC/Stable | [version](link-to-github-project) |
| Logs    | Experimental/Alpha/Beta/RC/Stable | [version](link-to-github-project) |

Describe alternatives you've considered Going through project boards, milestones or contents of the repository

Additional context Summary table for OpenTelemetry Status https://github.com/open-telemetry/opentelemetry.io/issues/1548

trivikr avatar Jul 14 '22 14:07 trivikr

On a quick look at version numbers and GitHub projects, this is what I think the table is:

Signal Status Project
Traces Stable N/A
Metrics RC N/A
Logs Experimental N/A

If it's incorrect, please provide the correct table in this GitHub issue, so that it can be updated on README.

Updated based on opentelemetry.io/docs/instrumentation/python/#status-and-releases

trivikr avatar Jul 14 '22 14:07 trivikr

https://opentelemetry.io/docs/instrumentation/python/#status-and-releases

srikanthccv avatar Jul 14 '22 15:07 srikanthccv

The consensus is being achieved towards treating website as authoritative, and provide a link to website instead.

https://github.com/open-telemetry/opentelemetry-java/pull/4612#issuecomment-1185118267

We'll request the status page to link to language instrumentation links instead of GitHub READMEs in https://github.com/open-telemetry/opentelemetry.io/issues/1548

trivikr avatar Jul 15 '22 13:07 trivikr

@trivikr Sure, feel free to create a PR for this.

lzchen avatar Jul 18 '22 16:07 lzchen