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

Highlight first party ownership in the ecosystem registry #4795

Open
codefromthecrypt opened this issue Jul 5, 2024 · 4 comments
Open

Highlight first party ownership in the ecosystem registry #4795

codefromthecrypt opened this issue Jul 5, 2024 · 4 comments
Labels
help wanted Extra attention is needed registry

Comments

@codefromthecrypt
Copy link

codefromthecrypt commented Jul 5, 2024

Desired feature or idea:

Similar to how there is highlighting of code maintained by us, I'd like to see highlighting of first party ownership of instrumentation, exporters, etc in the ecosystem registry.

For example, this project is maintained by us
image

These two are maintained by the upstream project (first party), something you can tell by name comparison, but it isn't annotated otherwise
image

I'd love to see a stylesheet or otherwise change based on a flag in the registry data of "isUpstream" negate of "isThirdParty" or similar, so that end users can know something in the registry is authoritatively owned.

Additional context:

While it is easy to tell which instrumentation are done by us, it is not easy to tell which are done by the upstream owners. We make a call that is in my opinion correct, that the very first priority is that the instrumentation is upstream. By highlighting we encourage the same behaviors in our registry as our policy, and make it easier for end users to know if something is neither maintained by us, nor by the project owner. For example, they can prefer something that isn't a vendor-specific codebase which is neither subject to review of the target owners, nor ours.

@svrnm
Copy link
Member

svrnm commented Jul 5, 2024

We have functionality it's just not enabled for all those upstream instrumentations, we can distinguish in the registry between "first party integrations" and "native":

first party example: https://opentelemetry.io/ecosystem/registry/?s=kafkaflow
native example: https://opentelemetry.io/ecosystem/registry/?s=next.js

We also have the integrations page to feature those:

https://opentelemetry.io/ecosystem/integrations/

A piece missing is that this list of integrations shares the data from the registry, right now those are 2 independent data sets. We also leverage that second list to promote native (and only native) integrations on their language pages around libraries, e.g. https://opentelemetry.io/docs/languages/js/libraries/#use-natively-instrumented-libraries

All of this also has a dependency with this terminology discussion (and everytime I tried to improve the situation I struggeld with finding the right words): open-telemetry/opentelemetry-specification#4089

So what can you do to help with that:

  • Tag registry entries which are missing the native/first party flag
  • Help to merge the data sources for integrations & the same data set in the registry
  • Help to find better terminology by participating in the discussion mentioned above

@svrnm svrnm added registry help wanted Extra attention is needed labels Jul 5, 2024
@haidong
Copy link
Contributor

haidong commented Jul 13, 2024

Tag registry entries which are missing the native/first party flag

I'm working on this.

As of this writing, there are 761 files that miss the flag:

 data/registry   main ±  find . -type f | xargs grep -L -e "isNative" -e "isFirstParty" | wc -l                                                                                     
     761

Changing 761 files in one PR will be too much. I'll breakdown the 761 files into separate batches using alphabetical order, one PR per batch.

haidong added a commit to haidong/opentelemetry.io that referenced this issue Jul 14, 2024
To address open-telemetry#4795, this is a series of PRs that add native or first party
flags to registries that lack them. This batch touches collector-builder
and all collector-exporter-* registries.

Signed-off-by: Alex Ji <alji@cisco.com>
@codefromthecrypt
Copy link
Author

@haidong thanks so much for pitching in on this!

@svrnm
Copy link
Member

svrnm commented Jul 15, 2024

Hey @haidong

commented on your PR but adding the same here: what I was hoping for is a review of instrumentations (native and library) and apps and to verify if their instrumentation is first party means that it was created by the same org that provides the app or lib. Collector components are not part of that. Also components provided by the Otel community are not first party.

Apologies once again and thank you for your eagerness to help.

haidong added a commit to haidong/opentelemetry.io that referenced this issue Jul 15, 2024
To address open-telemetry#4795, this is a series of PRs that add native or first party
flags to registries that lack them. This batch touches and all
collector-exporter-* registries.

Signed-off-by: Alex Ji <alji@cisco.com>
haidong added a commit to haidong/opentelemetry.io that referenced this issue Jul 21, 2024
To address open-telemetry#4795, this is a series of PRs that add native or first party
flags to registries that lack them. This batch touches cpp and dotnet
instrumentation registries.

Entries whose repo url returns 404 are deleted.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Jul 22, 2024
To address open-telemetry#4795, this is a series of PRs that add native or first party
flags to registries that lack them. This batch touches cpp and dotnet
instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Jul 22, 2024
To address open-telemetry#4795, this is a series of PRs that add native or first party
flags to registries that lack them. This batch touches cpp and dotnet
instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Jul 23, 2024
To address open-telemetry#4795, this is a series of PRs that add native or first party
flags to registries that lack them. This batch touches cpp and dotnet
instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Jul 30, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches Elixir, Erlang, and Go instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Sep 6, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches Elixir, Erlang, and Go instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Sep 13, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches Elixir, Erlang, and Go instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Sep 17, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches Java instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Sep 17, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches Java instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Sep 23, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches JavaScript instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Sep 23, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches JavaScript instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Sep 23, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches PHP instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Sep 23, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches Python instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Sep 23, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches Ruby instrumentation registries.
haidong added a commit to haidong/opentelemetry.io that referenced this issue Sep 23, 2024
To address open-telemetry#4795, this is part of a series of PRs that add isFirstParty
or isNative flags to instrumentation registries that lack them.

This batch touches Lua/Perl/Rust/Swift instrumentation registries.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed registry
Projects
None yet
Development

No branches or pull requests

3 participants