Skip to main content

Connect an instance

A workspace watches the Woodpecker CI servers its members connect to it, and each of them is an instance of the workspace. peckaboo.com is an independent service and not a project of Woodpecker CI.

The two tiers

Tier What you enter What the dashboard of the instance shows
1 the address of the server whether it answers and since when, its uptime over 24 hours and over 7 days, its version, and its latest changes between answering and not
2 the address and the metrics token of the server everything of tier 1, and the queue, the runs and steps of each repository, the memory, CPU and restarts of the server, and the alerts that need its metrics

Tier 1 reads the health check and the version of the server, which Woodpecker CI answers without a token. Tier 2 also reads its metrics, which Woodpecker CI hands out only with the token of its metrics endpoint. Set the metrics token shows how to set one. An instance of tier 1 gets its token later with Replace the token in the instance settings.

There is no tier with an API token of your server. Such a token opens your repositories and their logs, and peckaboo.com needs neither for what it shows.

Only Woodpecker CI 3

peckaboo.com reads the health check, the version and the metrics the way Woodpecker CI 3 provides them. A server of another major version is refused with the version it reported, and so is an address at which no Woodpecker CI answers.

Connecting a server

  1. In the console of your workspace, open Instance settings.
  2. Under Connect an instance, enter a name, the address of the server, and for tier 2 its metrics token.
  3. Select Connect the instance.

The first poll follows within the minute, and from then on peckaboo.com asks the server once a minute. A server that takes longer than ten seconds over a poll is asked less often: the next poll follows after six times as long, counted from the beginning of the last. Owners, admins and members connect instances, and a viewer sees them and their dashboards; Roles in a workspace has the whole list. Once a data processing agreement is published, an owner concludes it for the workspace on the same screen, and instances are connected after that.

What is checked first

Before an instance is connected, peckaboo.com asks its address:

  • The address starts with https:// and carries no user name, password, query or fragment. Plain http:// is refused, because a token never goes over an unencrypted connection.
  • The server answers at the address itself. A redirect is not followed, so enter the address at which Woodpecker CI answers directly.
  • The address is reachable from the internet. An address in a private network is refused, see Servers in a private network.
  • The version the server reports starts with 3.
  • With a token, the metrics endpoint accepts it.

A workspace connects each server once, whatever the case of its host or an explicit port 443. Every check asks a server you chose, so one person connects instances or replaces tokens at most ten times a minute and sixty times an hour, across all their workspaces.

When a server stops answering

An instance that does not answer is asked every minute until ten polls in a row failed, then after 2, 4 and 8 minutes, and from then on every 15 minutes. After seven days without an answer it is paused, and the people who get its alerts are told by mail. Resume the instance in the instance settings asks it again at once, and so does a new token.

Removing an instance

Remove the instance asks for its name. From that moment the instance is gone for every screen and every poll, its address can be connected again at once, and its history is deleted in the background.