Move opentelemetry_api code back into opentelemetry and remove the former #1226

shaun-cox · 2023-08-24T13:45:17Z

Changes

As part of #1199, @djc asked:

At this point, should we just move all of the opentelemetry_api code back into the opentelemetry directory?

This PR delivers that. To make reviewing hopefully easier, I've split it into several commits that can be squashed when merged and reviewed independently:

commit 1
- change Cargo.toml dependencies from opentelemetry_api to opentelemetry
- replace use opentelemetry_api:: with use opentelemetry::
commit 2
- moves opentelemetry-api src directory to opentelemetry and removes the former.
- opentelemetry/src/lib.rs manually combined
~~commit 3~~
- ~~updates CHANGELOG.md files to remove mentions of opentelemetry-api and just use opentelemetry~~
- ~~(maybe this isn't appropriate, in which case I'll revert.)~~
commit 4
- manually combined opentelemetry/CHANGELOG.md with the old opentelemetry-api/CHANGELOG.md and adjusted opentelemtry/README.md to mention the related opentelemetry_sdk crate.
commit 5
- removed opentelemetry-api directory

Merge requirement checklist

CONTRIBUTING guidelines followed
Appropriate CHANGELOG.md files updated for non-trivial, user-facing changes

codecov · 2023-08-24T14:25:22Z

Codecov Report

Patch coverage: 50.0% and no project coverage change.

Comparison is base (1688ec6) 49.3% compared to head (87d75d8) 49.3%.

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #1226   +/-   ##
=====================================
  Coverage   49.3%   49.3%           
=====================================
  Files        174     173    -1     
  Lines      21038   21008   -30     
=====================================
- Hits       10380   10371    -9     
+ Misses     10658   10637   -21

Files Changed	Coverage Δ
opentelemetry-otlp/src/exporter/grpcio/logs.rs	`0.0% <ø> (ø)`
opentelemetry-otlp/src/exporter/grpcio/metrics.rs	`0.0% <ø> (ø)`
opentelemetry-otlp/src/exporter/grpcio/mod.rs	`30.4% <0.0%> (ø)`
opentelemetry-otlp/src/exporter/grpcio/trace.rs	`0.0% <ø> (ø)`
opentelemetry-otlp/src/exporter/http/logs.rs	`0.0% <ø> (ø)`
opentelemetry-otlp/src/exporter/http/metrics.rs	`0.0% <ø> (ø)`
opentelemetry-otlp/src/exporter/http/mod.rs	`0.0% <0.0%> (ø)`
opentelemetry-otlp/src/exporter/http/trace.rs	`0.0% <ø> (ø)`
opentelemetry-otlp/src/exporter/tonic/logs.rs	`0.0% <ø> (ø)`
opentelemetry-otlp/src/exporter/tonic/metrics.rs	`0.0% <ø> (ø)`
... and 88 more

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

cijothomas · 2023-08-24T20:49:11Z

opentelemetry-api/README.md

@@ -1,28 +0,0 @@
-![OpenTelemetry — An observability framework for cloud-native software.][splash]


it may be a good idea to to keep this file, with a note saying "its no longer maintained and users should use opentelemetry crate instead". Or maybe that can be done in crates.io description manually.

+1 we will need to figure out a way to prompt users to opentelemetry crate when they end up on the opentelemetry_api crate

Could submit an informational RustSec security advisory setting the status for opentelemetry_api to unmaintained.

I've submitted rustsec/advisory-db#1994 and a PR

cijothomas · 2023-08-24T20:51:20Z

opentelemetry/README.md

+In addition to `opentelemetry`, which only carries the API, the
+[`open-telemetry/opentelemetry-rust`] repository contains several additional
+crates designed to be used with the `opentelemetry` ecosystem. This includes a
+collection of trace `SpanExporter` and metrics pull and push controller


nit: this is outdated. will send a follow up to address it after this PR.

cijothomas · 2023-08-24T20:58:54Z

commit 3
updates CHANGELOG.md files to remove mentions of opentelemetry-api and just use opentelemetry
(maybe this isn't appropriate, in which case I'll revert.)

mm.. I don't think we need to update past changelogs.

opentelemetry-otlp/Cargo.toml

cijothomas

LGTM. I left a couple of nits, and also do not think we need commit3 to update old changelog entries.

Thanks a lot for this, and really appreciate the way step-by-step commits is done to make reviewing much easier!

lalitb · 2023-08-24T22:45:53Z

commit 3
updates CHANGELOG.md files to remove mentions of opentelemetry-api and just use opentelemetry
(maybe this isn't appropriate, in which case I'll revert.)

mm.. I don't think we need to update past changelogs.

Same thought. Do we need to update old changelogs entries ?

lalitb · 2023-08-24T22:55:48Z

opentelemetry/README.md

-`opentelemetry` ecosystem. This includes a collection of trace `SpanExporter`
-and metrics pull and push controller implementations, as well as utility and
-adapter crates to assist in propagating state and instrumenting applications.
+In addition to `opentelemetry`, which only carries the API, the


Should opentelemetry/README.md now only contain the information specific to API. Most of the content is similar to the root level README.md, and can be removed. Probably something to be addressed once this PR is merged.

lalitb

Nicely done. Thanks.

hdost

Glad people are finally on board with this.

opentelemetry-otlp/CHANGELOG.md

djc

LGTM, thank you for working through this -- must have been pretty tedious.

opentelemetry/Cargo.toml

jtescher

Awesome thanks @shaun-cox

…rmer (open-telemetry#1226)

* feat: addInMemoryLogExporter * linting * Update CHANGELOG.md * changed finished to emitted logs, moved example * replace clone_log with cloned() * remove proj example in favor of single file * corrected dependency, removed repeated code * changed finished to emitted logs, moved example * remove proj example in favor of single file * corrected dependency, removed repeated code * corrected dependency, removed repeated code * fix: endpoint urls for otlp http exporter. (#1210) * Move opentelemetry_api code back into opentelemetry and remove the former (#1226) * [user_events log exporter] Upgrade eventheader-dynamic dependency (#1230) * feat: addInMemoryLogExporter * linting * Update CHANGELOG.md * remove the example from examples * fixes after rebase * missing doc, added no_run in examples * fix ci test(stable) and docs * more examples ci fixes * added dev-dependencies to resolve ci issue * corrected required features * remove comments about returning error * Update example description Co-authored-by: Cijo Thomas <[email protected]> --------- Co-authored-by: Zhongyang Wu <[email protected]> Co-authored-by: Shaun Cox <[email protected]> Co-authored-by: Lalit Kumar Bhasin <[email protected]> Co-authored-by: Cijo Thomas <[email protected]>

open-telemetry/opentelemetry-rust#1226

shaun-cox force-pushed the api_crate branch from 675ee84 to 43f394b Compare August 24, 2023 14:07

shaun-cox force-pushed the api_crate branch 2 times, most recently from 0a85091 to e494400 Compare August 24, 2023 16:15

shaun-cox added 2 commits August 24, 2023 12:44

use opentelemetry instead of opentelemetry_api

e4959b6

remove opentelemetry-api and migrate it to opentelemetry

634de51

shaun-cox force-pushed the api_crate branch from e494400 to 4db0ca8 Compare August 24, 2023 17:48

shaun-cox marked this pull request as ready for review August 24, 2023 18:25

shaun-cox requested a review from a team August 24, 2023 18:25

shaun-cox changed the title ~~use opentelemetry instead of opentelemetry_api~~ Move opentelemetry_api code back into opentelemetry and remove the former Aug 24, 2023

cijothomas reviewed Aug 24, 2023

View reviewed changes

opentelemetry-otlp/Cargo.toml Show resolved Hide resolved

cijothomas approved these changes Aug 24, 2023

View reviewed changes

lalitb reviewed Aug 24, 2023

View reviewed changes

lalitb approved these changes Aug 24, 2023

View reviewed changes

shaun-cox added 3 commits August 24, 2023 18:13

merge CHANGELOG and README

e4c5dc2

remove opentelemetry-api directory

3562515

PR feedback

08de931

shaun-cox force-pushed the api_crate branch from cb41d15 to 08de931 Compare August 24, 2023 23:18

hdost approved these changes Aug 25, 2023

View reviewed changes

hdost reviewed Aug 25, 2023

View reviewed changes

opentelemetry-otlp/CHANGELOG.md Show resolved Hide resolved

djc approved these changes Aug 25, 2023

View reviewed changes

opentelemetry/Cargo.toml Outdated Show resolved Hide resolved

PR feedback

87d75d8

jtescher approved these changes Aug 28, 2023

View reviewed changes

jtescher merged commit 42e58fc into open-telemetry:main Aug 28, 2023
12 checks passed

shaun-cox deleted the api_crate branch August 28, 2023 18:16

KaczDev pushed a commit to KaczDev/opentelemetry-rust that referenced this pull request Aug 28, 2023

Move opentelemetry_api code back into opentelemetry and remove the fo…

817fb01

…rmer (open-telemetry#1226)

philipcristiano added a commit to philipcristiano/nostress that referenced this pull request Nov 21, 2023

deps: Adjust for otel renaming

40c5939

open-telemetry/opentelemetry-rust#1226

philipcristiano added a commit to philipcristiano/hello_idc that referenced this pull request Nov 21, 2023

deps: Adjust for otel renaming

95e3cf6

open-telemetry/opentelemetry-rust#1226

philipcristiano added a commit to philipcristiano/docker-prefetch-image that referenced this pull request Nov 21, 2023

deps: Adjust for otel renaming

7ed8053

open-telemetry/opentelemetry-rust#1226

jayvdb mentioned this pull request Jul 3, 2024

opentelemetry_api is removed from the github project rustsec/advisory-db#1994

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move opentelemetry_api code back into opentelemetry and remove the former #1226

Move opentelemetry_api code back into opentelemetry and remove the former #1226

shaun-cox commented Aug 24, 2023 •

edited

Loading

codecov bot commented Aug 24, 2023 •

edited

Loading

cijothomas Aug 24, 2023

TommyCpp Aug 24, 2023

djc Aug 25, 2023

jayvdb Jul 3, 2024

cijothomas Aug 24, 2023

cijothomas commented Aug 24, 2023

cijothomas left a comment

lalitb commented Aug 24, 2023

lalitb Aug 24, 2023 •

edited

Loading

lalitb left a comment

hdost left a comment

djc left a comment

jtescher left a comment

		@@ -1,28 +0,0 @@
		![OpenTelemetry — An observability framework for cloud-native software.][splash]

Move opentelemetry_api code back into opentelemetry and remove the former #1226

Move opentelemetry_api code back into opentelemetry and remove the former #1226

Conversation

shaun-cox commented Aug 24, 2023 • edited Loading

Changes

Merge requirement checklist

codecov bot commented Aug 24, 2023 • edited Loading

Codecov Report

cijothomas Aug 24, 2023

Choose a reason for hiding this comment

TommyCpp Aug 24, 2023

Choose a reason for hiding this comment

djc Aug 25, 2023

Choose a reason for hiding this comment

jayvdb Jul 3, 2024

Choose a reason for hiding this comment

cijothomas Aug 24, 2023

Choose a reason for hiding this comment

cijothomas commented Aug 24, 2023

cijothomas left a comment

Choose a reason for hiding this comment

lalitb commented Aug 24, 2023

lalitb Aug 24, 2023 • edited Loading

Choose a reason for hiding this comment

lalitb left a comment

Choose a reason for hiding this comment

hdost left a comment

Choose a reason for hiding this comment

djc left a comment

Choose a reason for hiding this comment

jtescher left a comment

Choose a reason for hiding this comment

shaun-cox commented Aug 24, 2023 •

edited

Loading

codecov bot commented Aug 24, 2023 •

edited

Loading

lalitb Aug 24, 2023 •

edited

Loading