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

Audit logs for receiver/github #35015

Open
justinianvoss22 opened this issue Sep 4, 2024 · 6 comments
Open

Audit logs for receiver/github #35015

justinianvoss22 opened this issue Sep 4, 2024 · 6 comments
Labels
enhancement New feature or request receiver/github

Comments

@justinianvoss22
Copy link

justinianvoss22 commented Sep 4, 2024

Component(s)

receiver/github

Is your feature request related to a problem? Please describe.

It looks like the GitHub receiver is being used for metrics only right now. I have been doing research on GitHub's audit logs that are used to keep track of events in an enterprise, organization, or user events. In order to access these logs, one must have a GitHub Enterprise Cloud account.
https://docs.github.com/en/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise

Describe the solution you'd like

I have been working on an implementation that incorporates polling for logs. I see that there is a PR for a web hooks implementation so I wonder if a mode config option could be used to select polling or web hook events to be used. For now, I am polling using the REST API endpoints that include /audit-log to get logs for organizations and enterprises. For user events, I am using events/public for user logs. Let me know if there are other event logs that are useful.

Describe alternatives you've considered

I have considered using only webhooks instead of polling, but I am waiting for the contribution of the web hook config files to be merged through to see what that would look like.

Additional context

No response

@justinianvoss22 justinianvoss22 added enhancement New feature or request needs triage New item requiring triage labels Sep 4, 2024
Copy link
Contributor

github-actions bot commented Sep 4, 2024

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@andrzej-stencel
Copy link
Member

This sounds like a valuable addition. I'm in favor of incorporating logs support to the GitHub receiver.

@adrielp
Copy link
Contributor

adrielp commented Sep 11, 2024

Agreed @andrzej-stencel - Thanks @justinianvoss22 for opening this. There was I think a similar proposal with #32505 which was asked to be incorporated in #27460 which is now all being incorporated into the GitHub Receiver as previously determined in the SIG call and mentioned in this comment. Super happy to take contributions to accelerate the delivery of this functionality.

@andrzej-stencel / @crobert-1 - and anyone else, what's the best way to close out those components proposals & link back to the decision for this to enable clarity to end-users on the direction of the GitHub receiver, enabling faster iteration?

@crobert-1
Copy link
Member

what's the best way to close out those components proposals & link back to the decision for this to enable clarity to end-users on the direction of the GitHub receiver, enabling faster iteration?

I've added the receiver/github label to the issues you've referenced. It's a pretty common issue we run into where we have lots of overlapping issues and discussions. I think your comment is a great way to handle this kind of issue though, just linking and connecting related issues as much as possible for context references. I'm open to more suggestions though.

@crobert-1 crobert-1 removed the needs triage New item requiring triage label Sep 11, 2024
@justinianvoss22
Copy link
Author

I'll work on creating a PR from my fork with my changes and you can take a look at it and give feedback.

@adrielp
Copy link
Contributor

adrielp commented Sep 12, 2024

Thanks @justinianvoss22! If you haven't already, please take a look at the Contributing Guidance for OTEL

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request receiver/github
Projects
None yet
Development

No branches or pull requests

4 participants