diff --git a/CHANGELOG.md b/CHANGELOG.md index 81a10cd3b1..891422a824 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,6 +24,8 @@ Main (unreleased) - Add htpasswd file based authentication for `otelcol.auth.basic` (@pkarakal) +- A new `otelcol.receiver.github` component which collects data from Github. (@matt-gp) + ### Enhancements - update promtail converter to use `file_match` block for `loki.source.file` instead of going through `local.file_match`. (@kalleep) diff --git a/docs/sources/reference/compatibility/_index.md b/docs/sources/reference/compatibility/_index.md index 55ae1649ab..3ba3c6f785 100644 --- a/docs/sources/reference/compatibility/_index.md +++ b/docs/sources/reference/compatibility/_index.md @@ -393,6 +393,7 @@ The following components, grouped by namespace, _consume_ OpenTelemetry `otelcol - [otelcol.receiver.file_stats](../components/otelcol/otelcol.receiver.file_stats) - [otelcol.receiver.filelog](../components/otelcol/otelcol.receiver.filelog) - [otelcol.receiver.fluentforward](../components/otelcol/otelcol.receiver.fluentforward) +- [otelcol.receiver.github](../components/otelcol/otelcol.receiver.github) - [otelcol.receiver.googlecloudpubsub](../components/otelcol/otelcol.receiver.googlecloudpubsub) - [otelcol.receiver.influxdb](../components/otelcol/otelcol.receiver.influxdb) - [otelcol.receiver.jaeger](../components/otelcol/otelcol.receiver.jaeger) diff --git a/docs/sources/reference/components/otelcol/otelcol.receiver.github.md b/docs/sources/reference/components/otelcol/otelcol.receiver.github.md new file mode 100644 index 0000000000..1f5dd6ecfa --- /dev/null +++ b/docs/sources/reference/components/otelcol/otelcol.receiver.github.md @@ -0,0 +1,311 @@ +--- +canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol/otelcol.receiver.github/ +description: Learn about otelcol.receiver.github +labels: + stage: experimental + products: + - oss +title: otelcol.receiver.github +--- + +# `otelcol.receiver.github` + +{{< docs/shared lookup="stability/experimental.md" source="alloy" version="" >}} + +`otelcol.receiver.github` collects metrics about repositories, pull requests, branches, and contributors. +You can also configure it to receive webhook events from GitHub Actions and convert these into traces. + +You can specify multiple `otelcol.receiver.github` components by giving them different labels. + +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 + +{{< admonition type="note" >}} +`otelcol.receiver.github` is a wrapper over the upstream OpenTelemetry Collector [`github`][] receiver. +Bug reports or feature requests will be redirected to the upstream repository, if necessary. + +[`github`]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/{{< param "OTEL_VERSION" >}}/receiver/githubreceiver +{{< /admonition >}} + +## Usage + +```alloy +otelcol.receiver.github "