Op Professional en Business beheert de Uptimecheck-provider voor Terraform, uptimecheck-com/uptimecheck in de Terraform Registry, monitors, projecten, meldingskanalen en statuspagina’s als code. Hij werkt via de REST API met een API-sleutel.
Maak een API-sleutel aan
- Open Instellingen in de zijbalk en kies het tabblad API.
- Kies Nieuwe API-sleutel, geef hem een naam naar waar hij gebruikt wordt, zoals ‘Terraform’, en kies Lezen en schrijven. De provider maakt en wijzigt dingen, dus een sleutel met alleen leesrechten is niet genoeg.
- Kies Sleutel maken en kopieer hem. Dit is de enige keer dat de sleutel getoond wordt.
Voeg de provider toe
Voeg de provider toe aan je configuratie:
terraform {
required_providers {
uptimecheck = {
source = "uptimecheck-com/uptimecheck"
}
}
}
provider "uptimecheck" {}
Voer terraform init uit; dat downloadt de provider uit de Terraform Registry. Zet de sleutel daarna in de omgevingsvariabele UPTIMECHECK_API_KEY, bijvoorbeeld met export UPTIMECHECK_API_KEY=uc_your_api_key, of als secret in je CI-systeem. De provider accepteert ook een argument api_key, maar met de omgevingsvariabele blijft de sleutel buiten je bestanden.
Voeg een monitor toe
resource "uptimecheck_monitor" "checkout" {
type = "http"
name = "Checkout"
target = "https://shop.example.com/checkout"
interval_seconds = 60
config = jsonencode({
expectedStatus = "200-299"
keyword = { value = "Add to cart", mode = "contains" }
slowMs = 1500
})
}
typeishttp,tcp,ping,dns,domain,heartbeat,server,vendor,crawlofflow. Als je het wijzigt, wordt de monitor vervangen.configbevat de instellingen van het type als JSON, met dezelfde sleutels als in de API-referentie. Alleen de sleutels die je zelf schrijft worden beheerd, dus de standaardwaarden van de app voor de rest verschijnen niet als wijzigingen.interval_secondsbepaalt hoe vaak er gecheckt wordt, van 60 tot 3600 seconden (30 op een abonnement dat dat toestaat), en 300 als je het weglaat.channel_idskiest de meldingskanalen,project_idhet project, enpaused = truepauzeert de monitor.
Voer terraform plan uit om te zien wat er verandert, en daarna terraform apply. De monitor verschijnt meteen in de app.
Een cronjob en zijn ping-URL
resource "uptimecheck_monitor" "backup" {
type = "heartbeat"
name = "Nightly backup"
config = jsonencode({
schedule = { cron = "0 3 * * *", timeZone = "Europe/Stockholm" }
graceSeconds = 900
maxRunSeconds = 3600
})
}
output "backup_ping_url" {
value = uptimecheck_monitor.backup.heartbeat_url
sensitive = true
}
De ping-URL staat in heartbeat_url, gemarkeerd als gevoelig. Lees hem uit met terraform output -raw backup_ping_url en voeg hem toe aan de job.
Projecten, meldingskanalen en statuspagina’s
uptimecheck_project: een project, bijvoorbeeld een klant, met eennameen eencolor. Verwijder je het, dan blijven de monitors en statuspagina’s zonder project achter; de klantrapporten en klanttoegang worden mee verwijderd.uptimecheck_alert_channel: e-mail, Slack via een incoming webhook, Microsoft Teams, Discord, Google Chat, Mattermost, PagerDuty, ntfy, Pushover en webhooks. Het adres of de sleutel gaat inconfig, die de API nooit teruggeeft, dus een wijziging in de app geldt niet als drift. Metdelay_minutes(5, 10, 15, 30 of 60) wordt het kanaal een escalatiestap. Het ondertekeningsgeheim van een webhook staat inwebhook_secreten wordt alleen teruggegeven als het kanaal wordt aangemaakt.uptimecheck_status_page: een statuspagina met titel, uiterlijk encomponents, de monitors die bezoekers zien, op volgorde en eventueel gegroepeerd. Wachtwoord, e-mailtoegangslijst en eigen CSS stel je in de app in, en die blijven ongemoeid. Verwijder je de pagina, dan verdwijnen ook de abonnees, geschreven updates en bezoekersstatistieken.- De data sources
uptimecheck_alert_channels,uptimecheck_projectsenuptimecheck_status_pagestonen wat er al is. Gebruik de eerste voor kanalen voor sms, Telegram, push en Add to Slack, die je in de app instelt.
Haal binnen wat je al hebt
Monitors, projecten, meldingskanalen en statuspagina’s die je in de app hebt gemaakt, importeer je met hun ID:
terraform import uptimecheck_monitor.checkout mon_...
terraform import uptimecheck_project.acme prj_...
terraform import uptimecheck_alert_channel.slack ch_...
terraform import uptimecheck_status_page.public sp_...
Het adres van een geïmporteerd meldingskanaal en het ondertekeningsgeheim van een webhook worden niet teruggelezen. Elke resource en elk attribuut staat beschreven in de Terraform Registry. Meer over de Terraform-integratie, API-sleutels en de REST API.