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

Registry: first-party field should be derived from the author info #6428

Open
chalin opened this issue Feb 26, 2025 · 8 comments
Open

Registry: first-party field should be derived from the author info #6428

chalin opened this issue Feb 26, 2025 · 8 comments

Comments

@chalin
Copy link
Contributor

chalin commented Feb 26, 2025

@svrnm @cartermp @open-telemetry/docs-approvers - first-party in the context of the OTel org means owned and maintained by OTel, but that's not what I'm seeing in the registry entries. We shouldn't have a isFirstParty field, this property should be derived from the author information.

Related:

@chalin
Copy link
Contributor Author

chalin commented Feb 26, 2025

Once we figure things out we should update the definitions in

"isNative": {
"type": "boolean",
"description": "A flag to indicate if the entry is native"
},
"isFirstParty": {
"type": "boolean",
"description": "A flag to indicate if the entry is first party"
},

@svrnm
Copy link
Member

svrnm commented Feb 26, 2025

First party means that it is provided by the same organization (project or company) as the targeted "software", eg

  • an instrumentation library for "foolib" is first party if it is by the "foolib" authors
  • an collector exporter is for ACME's commercial backend is first party if it is provided by ACME

I don't think this can be captured purely from the email address of the author or from the GitHub handle.

@svrnm
Copy link
Member

svrnm commented Feb 26, 2025

From my point of view things by us (otel community) are rarely/never first party

@pellared
Copy link
Member

Also see

isFirstParty: false # set this to true if "isNative" is set to false, but the plugin / instrumentation library is from the same vendor/project as the instrumented software

@svrnm
Copy link
Member

svrnm commented Feb 26, 2025

maybe we should turn this into some kind of ENUM? not sure how to name it then

@cartermp
Copy link
Contributor

I have always seen first party as being similar to "inherent", meaning that it's not a library you have to install so that you can instrument another library.

@svrnm
Copy link
Member

svrnm commented Feb 26, 2025

I have always seen first party as being similar to "inherent", meaning that it's not a library you have to install so that you can instrument another library.

that's "isNative: true"

Just to fill in some of my thought process, since I introduced that field and replaced "thirdParty": we had a similar issue with "thirdParty" that it was not obvious who the first and third party is, a problem still not solved. What I wanted to have expressed in the registry are 2 properties (and then highlighted via badges):

The purpose of that is that "native" is the goal, but "first party" is an intermediate step (think an author wants to do otel but not yet the full way, so they create a plugin and later figure out that by taking direct dependency on the otel API they make things even better), so we want to promote both as a good thing (vs our community maintaining yet another component).

Both names are far from perfect, so if we have any good ideas how to name them properly, please suggest:)

@pellared
Copy link
Member

pellared commented Feb 26, 2025

For me the description and naming was clear 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants