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

Add namedpipereceiver #29320

Merged
merged 1 commit into from
Dec 13, 2023
Merged

Conversation

sinkingpoint
Copy link
Contributor

Description:

This adds a new receiver that reads from a named pipe, using the previously created namedpipeinput stanza operator (#28841). Because that operator does the majority of the work, this is mostly boilerplate + a few tests to confirm that it works e2e.

Link to tracking Issue: #27234

Testing:

Added a few tests, loading the config, and actually creating a receiver to verify that it can read logs from the pipe.

Documentation:

None, yet.

/cc @djaglowski - where should I add docs for this if any?

@sinkingpoint sinkingpoint requested review from a team and codeboten November 17, 2023 04:36
@sinkingpoint sinkingpoint force-pushed the namedpipe_receiver branch 4 times, most recently from 389832d to 2631104 Compare November 17, 2023 05:07
@djaglowski
Copy link
Member

where should I add docs for this if any?

Certainly we need a readme for the component (i.e. receiver/namedpipereceiver/README.md).

Ideally we would also have a separate doc in pkg/stanza/docs but we can just capture this as an issue. It's not ideal that we have so much duplication between the two, but it's the pattern we currently. Once we have a readme for the receiver, it should be easy to tweak it for the operator.

Copy link
Member

@djaglowski djaglowski left a comment

Choose a reason for hiding this comment

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

Code looks good, just need to include a readme and all the boilerplate updates like .github versions.yaml, etc. (#28818 is a recent reference)

receiver/namedpipereceiver/metadata.yaml Outdated Show resolved Hide resolved
@sinkingpoint sinkingpoint force-pushed the namedpipe_receiver branch 5 times, most recently from 7cd3da6 to a8fee05 Compare November 21, 2023 10:17
@sinkingpoint
Copy link
Contributor Author

@djaglowski I've added those + a basic README. Tests seem to be passing as well

@djaglowski
Copy link
Member

With #29472, we no longer have a dependabot.yml file. @codeboten, is there an equivalent change we need to make for renovate?

status:
class: receiver
stability:
alpha: [logs]
Copy link
Contributor

Choose a reason for hiding this comment

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

is this really in alpha?

Copy link
Member

Choose a reason for hiding this comment

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

It will be once the PR is merged

class: receiver
stability:
alpha: [logs]
distributions: [contrib]
Copy link
Contributor

Choose a reason for hiding this comment

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

this is not in the contrib distribution yet.

Copy link
Member

Choose a reason for hiding this comment

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

I can be added once this PR is merged

@atoulme
Copy link
Contributor

atoulme commented Nov 30, 2023

This PR makes @djaglowski the only codeowner of the component - @djaglowski please approve the PR, this seems a bit out of pace with how we describe adding components in CONTRIBUTING.md. @sinkingpoint I see in the original issue you have yourself as codeowner, is that still valid?

@djaglowski
Copy link
Member

This PR makes @djaglowski the only codeowner of the component - @djaglowski please approve the PR,

I'm waiting to approve until the dependabot conflict is addressed.

This seems a bit out of pace with how we describe adding components in CONTRIBUTING.md.

I asked that we first add an operator to pkg/stanza, which was done in #28841. This contains the bulk of the complexity and could be done in isolation of any receiver code. Subsequently, there is very little to do other than add the boilerplate because pkg/stanza input operators can be incorporated into a receiver with just a few lines of code.

@sinkingpoint I see in the original issue you have yourself as codeowner, is that still valid?

Since this component was his first contribution, I suggested he add me initially, plan on applying for membership based on the contributing the component, then add himself as codeowner as well.

@sinkingpoint
Copy link
Contributor Author

Apologies - missed that there was something for me to do here. Will fix this up today

@sinkingpoint sinkingpoint force-pushed the namedpipe_receiver branch 2 times, most recently from 9bb574b to 7c2ae6b Compare December 13, 2023 03:02
This adds a new receiver that reads from a named pipe, using the previously
created namedpipeinput stanza operator. Because that operatos does the
majority of the work, this is mostly boilerplate + a few tests to confirm
that it works e2e.

Signed-off-by: sinkingpoint <colin@quirl.co.nz>

Prepare contrib-base for version v0.89.0
@djaglowski djaglowski merged commit 97a920d into open-telemetry:main Dec 13, 2023
85 checks passed
@github-actions github-actions bot added this to the next release milestone Dec 13, 2023
djaglowski added a commit that referenced this pull request Dec 13, 2023
cparkins pushed a commit to AmadeusITGroup/opentelemetry-collector-contrib that referenced this pull request Jan 10, 2024
**Description:**

This adds a new receiver that reads from a named pipe, using the
previously created namedpipeinput stanza operator (open-telemetry#28841). Because that
operator does the majority of the work, this is mostly boilerplate + a
few tests to confirm that it works e2e.

Link to tracking Issue: open-telemetry#27234

**Testing:**

Added a few tests, loading the config, and actually creating a receiver
to verify that it can read logs from the pipe.

**Documentation:**

None, yet.

/cc @djaglowski - where should I add docs for this if any?
@djaglowski
Copy link
Member

@sinkingpoint, I was just updating some things relating to code ownership and noticed that we still aren't able to assign you as an owner to this component because you're not a member of OpenTelemetry yet. Are you willing to apply? I'm happy to be one of your sponsors.

@atoulme
Copy link
Contributor

atoulme commented Feb 28, 2024

I can be second sponsor.

@sinkingpoint
Copy link
Contributor Author

Ah! You did mention. Sure - application PR here: open-telemetry/community#1975

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

Successfully merging this pull request may close these issues.

4 participants