-
Notifications
You must be signed in to change notification settings - Fork 478
feat(otelcol.receiver): GitHub #4914
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
base: main
Are you sure you want to change the base?
Conversation
This PR adds the opentelemetry github receiver.
clayton-cornell
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll do a second pass over the docs after the current round of suggestions are implemented.
If possible, we should try to document the blocks in the same order they are presented in the Blocks table. This isn't a blocker.. just a nice-to-have for consistency. If there isn't time or you decide it's not worth the extra shuffling, we can skip it for this PR and do it at some future time.
docs/sources/reference/components/otelcol/otelcol.receiver.github.md
Outdated
Show resolved
Hide resolved
docs/sources/reference/components/otelcol/otelcol.receiver.github.md
Outdated
Show resolved
Hide resolved
docs/sources/reference/components/otelcol/otelcol.receiver.github.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### `webhook` | ||
|
|
||
| The `webhook` block configures webhook reception for GitHub Actions events. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be a good idea to expand the descriptions a little? For example, here we could put something like this.... (needs to be validated that my suggestion is accurate)
When enabled, this block allows the receiver to convert GitHub Actions workflow and job events into traces.
{{< admonition type="note" >}}
Ensure your webhook endpoint is secured with a secret and protected by appropriate network security measures.
{{< /admonition >}}
docs/sources/reference/components/otelcol/otelcol.receiver.github.md
Outdated
Show resolved
Hide resolved
|
|
||
| `otelcol.receiver.github` scrapes version control system (VCS) metrics from GitHub repositories and organizations using the GitHub GraphQL and REST APIs. | ||
|
|
||
| You can specify multiple `otelcol.receiver.github` components by giving them different labels. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it worth mentioning here that there are some additional requirements? For example something along these lines:
Ensure you have the following:
- A GitHub Personal Access Token or GitHub App with appropriate permissions
- For metrics: Read access to target repositories and organizations
- For webhooks: A publicly accessible endpoint to receive GitHub webhook events
- Network connectivity to GitHub API endpoints, for example, `api.github.com` or your GitHub Enterprise instance
|
|
||
| {{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}} | ||
|
|
||
| `otelcol.receiver.github` scrapes version control system (VCS) metrics from GitHub repositories and organizations using the GitHub GraphQL and REST APIs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we could expand the description slightly? Something like this? (or similar)
This component can collect metrics about repositories, pull requests, branches, and contributors.
It can also receive GitHub Actions workflow events through webhooks to create traces.
|
|
||
| The `webhook` block configures webhook reception for GitHub Actions events. | ||
|
|
||
| The following arguments are supported: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The upstream configuration for the GitHub receiver has ServiceName and IncludeSpanEvents fields in the WebHook struct. Do we need to note that these are not included in this component?
…hub.md Co-authored-by: Clayton Cornell <[email protected]>
…hub.md Co-authored-by: Clayton Cornell <[email protected]>
…hub.md Co-authored-by: Clayton Cornell <[email protected]>
…hub.md Co-authored-by: Clayton Cornell <[email protected]>
…hub.md Co-authored-by: Clayton Cornell <[email protected]>
…hub.md Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
PR Description
This PR adds the opentelemetry github receiver https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/githubreceiver
Which issue(s) this PR fixes
Fixes #1702
Notes to the Reviewer
PR Checklist