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.

Sign up for GitHub

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

Jump to bottom

[extension/googleclientauth] Add new component boilerplate scaffolding #31518

Merged
merged 25 commits into from
Mar 26, 2024
Merged

[extension/googleclientauth] Add new component boilerplate scaffolding #31518

merged 25 commits into from
Mar 26, 2024

Conversation

damemi
Copy link
Contributor

@damemi damemi commented Feb 29, 2024

Description:
This adds the basic component boilerplate following the recommendations for PR1 in https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#adding-new-components

Link to tracking Issue: #31412

Testing: Ran various make ... commands as listed in docs. Ignored generated files and failures from unrelated components.

Documentation: New readme and metadata (to be filled in, see tracking issue)

@damemi damemi requested a review from a team as a code owner February 29, 2024 21:49
@damemi damemi mentioned this pull request Feb 29, 2024
Closed
2 tasks
@dashpole dashpole added the Vendor-Specific Component New component that interfaces with a vendor API and will be maintained by the vendor. label Mar 4, 2024
@damemi damemi force-pushed the gcp-auth-ext branch 5 times, most recently from c6ff818 to 750bd58 Compare March 5, 2024 18:02
@damemi
Copy link
Contributor Author

damemi commented Mar 5, 2024

I tried skipping the lifecycle/shutdown tests for now in metadata.yaml and ran mdatagen and make generate but it looks like they're still running. Is there some other way I need to re-generate those tests?

@damemi damemi mentioned this pull request Mar 6, 2024
Merged
@damemi damemi force-pushed the gcp-auth-ext branch 2 times, most recently from 4f4e531 to 179e78f Compare March 8, 2024 20:16
@damemi
Copy link
Contributor Author

damemi commented Mar 8, 2024

I'm trying to run make update-otel to get the module on the right version but that's just giving me a lot of this message:

internal/components/components.go:20:2: go.opentelemetry.io/collector/featuregate@v0.96.1-0.20240308004201-241334609fc4: invalid pseudo-version: preceding tag (v0.96.0) not found

@dashpole
Copy link
Contributor

dashpole commented Mar 8, 2024

I would just manually update the file with the diff

crobert-1
crobert-1 reviewed Mar 8, 2024
View reviewed changes
Copy link
Member

@crobert-1 crobert-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll defer to others, but it may be worthwhile to add a changelog for this. It looks like it's pretty common for other components to add a new_component changelog entry for even just scaffolding 👍

extension/googleclientauthextension/README.md Show resolved Hide resolved
@damemi damemi force-pushed the gcp-auth-ext branch 6 times, most recently from 3e6f71e to dee2c99 Compare March 11, 2024 18:01
crobert-1
crobert-1 reviewed Mar 11, 2024
View reviewed changes
Copy link
Member

@crobert-1 crobert-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor formatting nits. 👍 Also, I realized it might be a good time to add goleak checks to your component now, to help ensure it doesn't leak goroutines. You can simply add a package_test.go file to your component's directory, contents could be copied from here.

extension/googleclientauthextension/README.md Outdated Show resolved Hide resolved
extension/googleclientauthextension/README.md Outdated Show resolved Hide resolved
extension/googleclientauthextension/README.md Outdated Show resolved Hide resolved
extension/googleclientauthextension/README.md Outdated Show resolved Hide resolved
crobert-1
crobert-1 approved these changes Mar 13, 2024
View reviewed changes
extension/googleclientauthextension/README.md
exporters: [otlp/withauth]
```

The following optional config fields are available:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: It might make sense to have the options defined before the example. Not a big deal either way though. 👍

@andrzej-stencel andrzej-stencel added the ready to merge Code review completed; ready to merge by maintainers label Mar 21, 2024
@github-actions github-actions bot mentioned this pull request Mar 26, 2024
Closed
@djaglowski djaglowski merged commit f821db7 into open-telemetry:main Mar 26, 2024
147 checks passed
@github-actions github-actions bot added this to the next release milestone Mar 26, 2024
@damemi damemi mentioned this pull request Mar 28, 2024
Merged
djaglowski pushed a commit that referenced this pull request Apr 15, 2024
@damemi
[extension/googleclientauth] Add GCP auth extension implementation (#…
7608ecb 
…32029)

**Description:**
Follow up to boilerplate PR
#31518
This adds the functions calls to actually implement the extension using
our downstream libraries.

It also enables the shutdown tests for this extension (lifecycle tests
do not seem possible for us currently)

**Link to tracking Issue:** n/a

**Testing:** downstream unit and integration tests, shutdown tests here

**Documentation:** Here and downstream READMEs
@damemi damemi mentioned this pull request Apr 16, 2024
Merged
djaglowski pushed a commit that referenced this pull request Apr 18, 2024
@damemi
[extension/googleclientauth] Mark GCP client auth extension alpha (#3…
295ca65 
…2442)

**Description:** <Describe what has changed.>
Follow up to
#32029
and
#31518
This marks the `googleclientauthextension` as `alpha` following the
[contributing
doc](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#adding-new-components)
and [alpha stability
guidelines](https://github.com/open-telemetry/opentelemetry-collector#alpha).
It also adds it to `otelcontribcol`

Note this also updates CONTRIBUTING.md to explain how to add the alpha
component to otelcontribcol.

**Link to tracking Issue:** N/A

**Testing:** Downstream unit and integration tests

**Documentation:** No changes except stability
rimitchell pushed a commit to rimitchell/opentelemetry-collector-contrib that referenced this pull request May 8, 2024
@damemi @crobert-1 @rimitchell
[extension/googleclientauth] Add new component boilerplate scaffolding (
90f9eb3 
open-telemetry#31518)

**Description:**
This adds the basic component boilerplate following the recommendations
for PR1 in
https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#adding-new-components

**Link to tracking Issue:**
open-telemetry#31412

**Testing:** Ran various `make ...` commands as listed in docs. Ignored
generated files and failures from unrelated components.

**Documentation:** New readme and metadata (to be filled in, see
tracking issue)

---------

Co-authored-by: Curtis Robert <crobert@splunk.com>
rimitchell pushed a commit to rimitchell/opentelemetry-collector-contrib that referenced this pull request May 8, 2024
@damemi @rimitchell
[extension/googleclientauth] Add GCP auth extension implementation (o…
4e72113 
…pen-telemetry#32029)

**Description:**
Follow up to boilerplate PR
open-telemetry#31518
This adds the functions calls to actually implement the extension using
our downstream libraries.

It also enables the shutdown tests for this extension (lifecycle tests
do not seem possible for us currently)

**Link to tracking Issue:** n/a

**Testing:** downstream unit and integration tests, shutdown tests here

**Documentation:** Here and downstream READMEs
rimitchell pushed a commit to rimitchell/opentelemetry-collector-contrib that referenced this pull request May 8, 2024
@damemi @rimitchell
[extension/googleclientauth] Mark GCP client auth extension alpha (op…
654c05f 
…en-telemetry#32442)

**Description:** <Describe what has changed.>
Follow up to
open-telemetry#32029
and
open-telemetry#31518
This marks the `googleclientauthextension` as `alpha` following the
[contributing
doc](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#adding-new-components)
and [alpha stability
guidelines](https://github.com/open-telemetry/opentelemetry-collector#alpha).
It also adds it to `otelcontribcol`

Note this also updates CONTRIBUTING.md to explain how to add the alpha
component to otelcontribcol.

**Link to tracking Issue:** N/A

**Testing:** Downstream unit and integration tests

**Documentation:** No changes except stability
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dashpole dashpole dashpole approved these changes

@andrzej-stencel andrzej-stencel andrzej-stencel approved these changes

@crobert-1 crobert-1 crobert-1 approved these changes

Assignees

@codeboten codeboten

Labels
ready to merge Code review completed; ready to merge by maintainers Vendor-Specific Component New component that interfaces with a vendor API and will be maintained by the vendor.
Projects
None yet
Milestone
v0.97.0
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@damemi @dashpole @andrzej-stencel @crobert-1 @codeboten @djaglowski