List all published artifacts in readme #4481

jack-berg · 2022-05-19T14:57:25Z

We publish a lot of artifacts, and to a newcomer it's not obvious:

What those artifacts are - the way to discover all the artifacts is to go inspect one of the boms we publish.
Where the source for a given artifact lives - it's not always intuitive how artifact ids map to source modules in the project.

I suggest we categorize and list all the artifacts in the readme, with each artifact containing a link to its source module, its maven artifact id, and its current version.

This was prompted by noticing that the artifacts listed in releases are not up to date.

codecov · 2022-05-19T15:00:37Z

Codecov Report

Merging #4481 (ba70985) into main (dbe9a8e) will increase coverage by 0.06%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #4481      +/-   ##
============================================
+ Coverage     90.12%   90.18%   +0.06%     
- Complexity     5003     5010       +7     
============================================
  Files           569      569              
  Lines         15435    15440       +5     
  Branches       1487     1488       +1     
============================================
+ Hits          13911    13925      +14     
+ Misses         1061     1056       -5     
+ Partials        463      459       -4

Impacted Files	Coverage Δ
...entelemetry/sdk/logs/export/BatchLogProcessor.java	`89.47% <0.00%> (+0.75%)`	⬆️
...metry/sdk/metrics/export/PeriodicMetricReader.java	`89.85% <0.00%> (+1.44%)`	⬆️
...sdk/autoconfigure/MetricExporterConfiguration.java	`88.52% <0.00%> (+2.58%)`	⬆️
...etry/exporter/prometheus/PrometheusHttpServer.java	`79.00% <0.00%> (+5.00%)`	⬆️
.../sdk/autoconfigure/MeterProviderConfiguration.java	`75.00% <0.00%> (+12.50%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dbe9a8e...ba70985. Read the comment docs.

mateuszrzeszutek

👍
This is super useful, I remember running into this problem (locating the sources for a module) at least once myself.

jkwatson

Fantastic. Even as a maintainer, I find myself digging out the bom from maven central when I want to find the names of all this stuff. 👍🏽

Oberon00 · 2022-05-20T08:24:14Z

Related to #3632, the linked BOMs already have that list. But I agree it's more user-friendly to list them directly in the README.

Oberon00 · 2022-05-20T08:25:00Z

README.md

+| [Metrics SDK](./sdk/metrics)           | `opentelemetry-sdk-metrics`      | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [Trace SDK](./sdk/trace)               | `opentelemetry-sdk-trace`        | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [Log SDK](./sdk/logs)                  | `opentelemetry-sdk-logs`         | <!--VERSION_UNSTABLE-->1.14.0-alpha<!--/VERSION_UNSTABLE--> |
+| [SDK Testing](./sdk/testing)           | `opentelemetry-sdk-testing`      | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |


Just from the name, I have no idea what "SDK Testing" is.

Initially was trying to keep a description of the artifacts out of scope, but I think its useful so I've added an additional description column

Oberon00 · 2022-05-20T08:25:44Z

README.md

+| [OTLP HTTP Trace Exporter](./exporters/otlp-http/trace)     | `opentelemetry-exporter-otlp-http-trace`   | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [OTLP HTTP Metrics Exporter](./exporters/otlp-http/metrics) | `opentelemetry-exporter-otlp-http-metrics` | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [OTLP HTTP Logs Exporter](./exporters/otlp-http/logs)       | `opentelemetry-exporter-otlp-http-logs`    | <!--VERSION_UNSTABLE-->1.14.0-alpha<!--/VERSION_UNSTABLE--> |
+| [OTLP Common](./exporters/otlp/common)                      | `opentelemetry-exporter-otlp-common`       | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |


I think this is only meant as an internal component, should we still list it here? If so, maybe with a more descriptive name?

Have added (internal) suffix to the description of purely internal components. With that said, otlp-common isn't purely internal - it has experimental APIs for enabling OTLP retry.

Oberon00 · 2022-05-20T08:26:03Z

README.md

+| [OTLP Common](./exporters/otlp/common)                      | `opentelemetry-exporter-otlp-common`       | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [Jaeger gRPC Exporter](./exporters/jaeger)                  | `opentelemetry-exporter-jaeger`            | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [Jaeger Thrift Exporter](./exporters/jaeger-thrift)         | `opentelemetry-exporter-jaeger-thift`      | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [Jaeger Proto](./exporters/jaeger-proto)                    | `opentelemetry-exporter-jaeger-proto`      | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |


Also probably an internal component?

Yes, and one I think can be deleted. Leaving it here for completeness until then.

Oberon00 · 2022-05-20T08:26:29Z

README.md

+| [Zipkin Exporter](./exporters/zipkin)                       | `opentelemetry-exporter-zipkin`            | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [Prometheus Exporter](./exporters/prometheus)               | `opentelemetry-exporter-prometheus`        | <!--VERSION_UNSTABLE-->1.14.0-alpha<!--/VERSION_UNSTABLE--> |
+
+### Shim


Maybe add a one-sentence description of what we mean by "shim".

I think with the added description column these have become self explanatory.

Oberon00 · 2022-05-20T08:27:21Z

README.md

+| [OpenCensus Shim](./opencensus-shim)   | `opentelemetry-opencensus-shim`  | <!--VERSION_UNSTABLE-->1.14.0-alpha<!--/VERSION_UNSTABLE--> |
+| [OpenTracing Shim](./opentracing-shim) | `opentelemetry-opentracing-shim` | <!--VERSION_UNSTABLE-->1.14.0-alpha<!--/VERSION_UNSTABLE--> |
+
+### Extension


Suggested change

### Extension

### Extensions

Or "Extra components"?

I've pluralized all the headers.

Oberon00 · 2022-05-20T08:28:44Z

README.md

+| [AWS Extension](./extensions/aws)                             | `opentelemetry-extension-aws`               | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [Kotlin Extension](./extensions/kotlin)                       | `opentelemetry-extension-kotlin`            | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [Trace Propagators Extension](./extensions/trace-propagators) | `opentelemetry-extension-trace-propagators` | <!--VERSION_STABLE-->1.14.0<!--/VERSION_STABLE-->           |
+| [Incubator Extension](./extensions/incubator)                 | `opentelemetry-extension-incubator`         | <!--VERSION_UNSTABLE-->1.14.0-alpha<!--/VERSION_UNSTABLE--> |


It's not really an extension to the incubator, it's incubating APIs that are currently provided as extensions. Maybe

Suggested change

| [Incubator Extension](./extensions/incubator) | `opentelemetry-extension-incubator` | 1.14.0-alpha |

| [Incubating/Experimental new core APIs](./extensions/incubator) | `opentelemetry-extension-incubator` | 1.14.0-alpha |

Changed this header from "Extensions" => "API Extensions" to reflect the difference between these extensions and the SDK extensions.

List all published artifacts in readme

d1c914b

jack-berg requested review from anuraaga, jkwatson and jsuereth as code owners May 19, 2022 14:57

jack-berg requested a review from a user May 19, 2022 14:57

jack-berg requested a review from Oberon00 as a code owner May 19, 2022 14:57

mateuszrzeszutek approved these changes May 19, 2022

View reviewed changes

jkwatson approved these changes May 19, 2022

View reviewed changes

anuraaga approved these changes May 20, 2022

View reviewed changes

Oberon00 reviewed May 20, 2022

View reviewed changes

Pluralize artifact section titles, add description

ba70985

jack-berg merged commit 540c2f5 into open-telemetry:main May 24, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

List all published artifacts in readme #4481

List all published artifacts in readme #4481

jack-berg commented May 19, 2022 •

edited

Loading

codecov bot commented May 19, 2022 •

edited

Loading

mateuszrzeszutek left a comment

jkwatson left a comment

Oberon00 commented May 20, 2022

Oberon00 May 20, 2022

jack-berg May 20, 2022

Oberon00 May 20, 2022

jack-berg May 20, 2022

Oberon00 May 20, 2022

jack-berg May 20, 2022

Oberon00 May 20, 2022

jack-berg May 20, 2022

Oberon00 May 20, 2022

jack-berg May 20, 2022

Oberon00 May 20, 2022

jack-berg May 20, 2022

	\| [Incubator Extension](./extensions/incubator) \| `opentelemetry-extension-incubator` \| <!--VERSION_UNSTABLE-->1.14.0-alpha<!--/VERSION_UNSTABLE--> \|
	\| [Incubating/Experimental new core APIs](./extensions/incubator) \| `opentelemetry-extension-incubator` \| <!--VERSION_UNSTABLE-->1.14.0-alpha<!--/VERSION_UNSTABLE--> \|

List all published artifacts in readme #4481

List all published artifacts in readme #4481

Conversation

jack-berg commented May 19, 2022 • edited Loading

codecov bot commented May 19, 2022 • edited Loading

Codecov Report

mateuszrzeszutek left a comment

Choose a reason for hiding this comment

jkwatson left a comment

Choose a reason for hiding this comment

Oberon00 commented May 20, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jack-berg commented May 19, 2022 •

edited

Loading

codecov bot commented May 19, 2022 •

edited

Loading