Skip to content

[DOCS] Add Docs for GitLab telemetry using the GitLab receiver #1353

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

Open
Calm-Rock opened this issue Apr 20, 2025 · 3 comments
Open

[DOCS] Add Docs for GitLab telemetry using the GitLab receiver #1353

Calm-Rock opened this issue Apr 20, 2025 · 3 comments
Labels
documentation Improvements or additions to documentation ECP

Comments

@Calm-Rock
Copy link
Member

Calm-Rock commented Apr 20, 2025

Scope of Task

We need documentation that explains how to use the GitLab Receiver to collect and send GitLab pipeline traces to SigNoz for both SigNoz Cloud and Self‑Hosted SigNoz.

The document should include:

  • Configuring the GitLab Receiver as a webhook endpoint for pipeline and job events
  • Setting up GitLab webhooks (project or group level)
  • Routing telemetry data to SigNoz via the OpenTelemetry Collector
  • Validating output on the SigNoz UI (traces view)

Note: This receiver currently supports traces only (in development phase) — see the GitLab Receiver README.


Tasks

  1. Traces Documentation
    • Describe how to configure the webhook block in the GitLab Receiver (endpoint, path, health_path, secret, etc.).
    • Include steps to create a GitLab “Pipeline Hook” and “Job Hook” webhook, with required headers and secret.
    • Provide an OpenTelemetry Collector YAML snippet that routes GitLab webhook events into the collector and exports them to SigNoz.
    • Show example pipeline and job spans in the SigNoz UI (screenshots of the traces view).

Where Should the Docs Go?

  • File Path: docs/cicd/gitlab.mdx
  • Metadata ID: gitlab
  • Title: GitLab Observability
  • Sidebar Name: GitLab under a new top‑level section CICD

Resources

@Calm-Rock Calm-Rock added documentation Improvements or additions to documentation ECP labels Apr 20, 2025
@soumyajyotiii
Copy link

ACK. You can assign this to me.

@soumyajyotiii
Copy link

Should I add screenshots? I mean they are something that makes life a bit easy.
In that case would you guys be able to provide the Gitlab access? For Signoz I can spin up a standalone container.

@soumyajyotiii
Copy link

Just wanted to update on where I’m at with the GitLab Receiver:

  • I’ve spun up a self-hosted SigNoz instance and built a custom OTEL Collector including the GitLab receiver.
  • The collector’s health endpoint (GET /health) responds correctly, and I’ve successfully exposed it via ngrok to receive GitLab webhooks.
  • However, any POST /events calls (including real pipeline and job payloads) still return HTTP 404, because the trace-generation handlers for /events aren’t implemented in the current GitLab receiver. Which is also mentioned in the README attaching the screenshot below
Image

This is a hard blocker and we’ll need to wait for the upstream merge of full pipeline-to-trace support in the receiver.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ECP
Projects
None yet
Development

No branches or pull requests

2 participants