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

feat(otelcol/exporter/splunkhec) Add Splunk HTTP Event Collector (HEC) Exporter #1885

Open
wants to merge 42 commits into
base: main
Choose a base branch
from

Conversation

adlotsof
Copy link

PR Description

Adds functionality described in #1645 and the proposal at #1646

Pinging @PatMis16

Which issue(s) this PR fixes

Fixes #1646

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@adlotsof adlotsof requested review from clayton-cornell and a team as code owners October 14, 2024 15:12
@CLAassistant
Copy link

CLAassistant commented Oct 14, 2024

CLA assistant check
All committers have signed the CLA.

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Oct 15, 2024
adlotsof and others added 23 commits October 16, 2024 07:11
…unkhec.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
…unkhec.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
…unkhec.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
…unkhec.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
…unkhec.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
…unkhec.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
…unkhec.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
…unkhec.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
…unkhec.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
…unkhec.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
@clayton-cornell clayton-cornell requested a review from a team October 16, 2024 16:17
@adlotsof
Copy link
Author

I assume the failed ci is due to me forgetting to re-run go generate ./internal/tools/docs_generator/ after updating the docs?

Copy link
Contributor

@wildum wildum left a comment

Choose a reason for hiding this comment

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

Thanks for your contributions, it looks great already :)
The config converter is missing (this is used to convert an otel config to an alloy config automatically). Here is the converter folder: https://github.com/grafana/alloy/tree/main/internal/converter/internal/otelcolconvert and here is a PR that adds a new converter: https://github.com/grafana/alloy/pull/739/files
Else, are you ok to become a maintainer of this component? This would only involve keeping the component up to date with upstream and eventually we might ping you on github if there are issues related to the component. We update all otel dependencies every 6-7 weeks. It's ok to miss some updates but if at some point the component falls too far behind and there are breaking changes then we would need to disable it. You can step out from being a maintainer at any time

go.mod Outdated Show resolved Hide resolved
@@ -0,0 +1,85 @@
// package splunkhec provides an otel.exporter splunkhec component

Copy link
Contributor

Choose a reason for hiding this comment

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

if you volunteer to maintain the component, you should put your @ here like in the datadog community component:
// Maintainers for the Grafana Alloy wrapper:
// - @adlotsof

Copy link
Author

Choose a reason for hiding this comment

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

Realistically, i will have to discuss at work (with @PatMis16) - I would love to have the time in my free time, but its just not the case at the moment. I will come back to you on the volunteering to be maintainer - question.

}

// SplunkHecHeartbeat defines the configuration for the Splunk HEC exporter heartbeat.
type SplunkHecHeartbeat struct {
Copy link
Contributor

Choose a reason for hiding this comment

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

did you test the heartbeat functionality? is it working as expected?

Co-authored-by: William Dumont <william.dumont@grafana.com>
@adlotsof
Copy link
Author

Thanks for your contributions, it looks great already :)

Puh i pretty much just copied (or tried to copy) what was done in the datadog PR . I will address your comments as soon as i manage to also work on them. Thanks a lot for the kind words!

The config converter is missing (this is used to convert an otel config to an alloy config automatically). Here is the converter folder: https://github.com/grafana/alloy/tree/main/internal/converter/internal/otelcolconvert and here is a PR that adds a new converter: https://github.com/grafana/alloy/pull/739/files

I dont know how i missed this - but i will add the converter when addressing the remaining, open comments.

Else, are you ok to become a maintainer of this component?

I will come back to you on this

@adlotsof
Copy link
Author

@wildum i believe i have addressed all your comments

@adlotsof adlotsof requested a review from wildum October 21, 2024 14:00
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

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

Some additional doc suggestions

Copy link
Contributor

@wildum wildum left a comment

Choose a reason for hiding this comment

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

Awesome work! I resolved the comments that were addressed, there are only a few left but we are very close to get it merged.
We still need to find a maintainer though

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Splunk HEC Exporter Integration for Grafana Alloy
4 participants