Skip to main content

Watch a component in 1 minute

You work with a component you don't own: an API you call, a library you depend on. Watch it, and Astrolabe tells you everything that happens to it: a pipeline that starts, fails or succeeds, a quality gate that turns red or green, a Compass score that drops.

How to​

1. Watch it from the catalog​

  1. In the sidebar, click Catalog.
  2. Find the component in the list (type its name in Search by name, above the list).
  3. On its row, click More actions (the three dots), then Watch.

A message confirms: You are watching payment-processor: you will be notified of everything that happens to it.

From the component's page

Next to the star beside the component's name, click the eye Watch. Pressed, it reads Stop watching.

2. Find what you watch​

  1. Top right, click your avatar, then My Account.
  2. Open the Notifications tab.

The Watched components card lists them. Click a name to open its page.

3. Receive the notifications​

What happens to a watched component reaches you in the bell, top right of Astrolabe. Click a notification: it opens the component's tab that shows the problem (its CI, SonarQube, Codacy or Compass tab), or the component's page.

4. Turn one event off​

You want the failures, not the successes? Keep watching, and switch that event off.

  1. In My Account › Notifications, go down to What do you want to receive?.
  2. In the Watched components section, what breaks comes first. Click Starts and successes to see the rest.
  3. Turn off the event, for example GitHub — When a workflow completes successfully, in the In Astrolabe column (the bell) or On this browser. It is saved right away.

5. Stop watching​

In My Account › Notifications › Watched components, click Stop watching payment-processor next to its name. Or, on its page, click the pressed eye Stop watching.

✅ That's it!

What you hear of, and when​

ToolEventsWhen
GitHub, GitLab, Azure DevOpsPipeline started, succeeded, failed, cancelledRight away with the tool's webhook, otherwise within a few minutes
JenkinsBuild started, succeeded, failed, abortedWithin a few minutes
SonarQubeQuality gate turned red, back to greenRight away with the webhook, otherwise within a few minutes
CodacyGrade dropped, grade roseWithin a few minutes
CompassScore dropped, score roseWithin a few minutes

A failure is Critical. A state that does not change says nothing: a quality gate that stays red is told once.

The component must name its project in its catalog-info.yaml, for each tool:

metadata:
annotations:
github.com/project-slug: acme/payment-processor
gitlab.com/project-slug: acme/payment-processor
dev.azure.com/project-repo: payments/payment-processor
jenkins.io/job-full-name: payment-processor
sonarqube.org/project-key: acme-payment-processor
codacy.com/project-slug: gh/acme/payment-processor

Compass needs no annotation.