W planach Professional i Business provider Uptimecheck dla Terraform, uptimecheck-com/uptimecheck w Terraform Registry, zarządza monitorami, projektami, kanałami powiadomień i stronami statusu jako kodem. Działa przez REST API z kluczem API.
Utwórz klucz API
- Otwórz Ustawienia na pasku bocznym i wybierz kartę API.
- Wybierz Nowy klucz API, nazwij go według miejsca użycia, np. „Terraform”, i wybierz Odczyt i zapis. Provider tworzy i zmienia zasoby, więc klucz tylko do odczytu nie wystarczy.
- Wybierz Utwórz klucz i skopiuj go. Klucz jest pokazywany tylko ten jeden raz.
Dodaj providera
Dodaj providera do swojej konfiguracji:
terraform {
required_providers {
uptimecheck = {
source = "uptimecheck-com/uptimecheck"
}
}
}
provider "uptimecheck" {}
Uruchom terraform init, które pobierze providera z Terraform Registry. Następnie umieść klucz w zmiennej środowiskowej UPTIMECHECK_API_KEY, np. poleceniem export UPTIMECHECK_API_KEY=uc_your_api_key, albo jako sekret w swoim systemie CI. Provider przyjmuje też argument api_key, ale zmienna środowiskowa trzyma klucz z dala od Twoich plików.
Dodaj monitor
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
})
}
typeto jedno z:http,tcp,ping,dns,domain,heartbeat,server,vendor,crawliflow. Zmiana typu zastępuje monitor nowym.configzawiera ustawienia danego typu jako JSON, z tymi samymi kluczami co w dokumentacji API. Zarządzane są tylko klucze, które wpiszesz, więc domyślne wartości aplikacji dla reszty nie pojawiają się jako zmiany.interval_secondsto częstotliwość sprawdzania, od 60 do 3600 sekund (30 w planie, który na to pozwala); bez tego atrybutu 300.channel_idswybiera kanały powiadomień,project_idprojekt, apaused = truewstrzymuje monitor.
Uruchom terraform plan, aby zobaczyć, co się zmieni, a potem terraform apply. Monitor od razu pojawi się w aplikacji.
Zadanie cron i jego adres URL pingu
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
}
Adres URL pingu znajduje się w heartbeat_url, oznaczonym jako wrażliwy. Odczytaj go poleceniem terraform output -raw backup_ping_url i dodaj do zadania.
Projekty, kanały powiadomień i strony statusu
uptimecheck_project: projekt, np. klient, z atrybutaminameicolor. Po jego usunięciu monitory i strony statusu zostają bez projektu, a raporty dla klienta i dostęp klienta są usuwane razem z nim.uptimecheck_alert_channel: e-mail, Slack przez incoming webhook, Microsoft Teams, Discord, Google Chat, Mattermost, PagerDuty, ntfy, Pushover i webhooki. Adres lub klucz trafia doconfig, którego API nigdy nie zwraca, więc zmiana wprowadzona w aplikacji nie jest traktowana jako drift.delay_minutes(5, 10, 15, 30 lub 60) robi z kanału krok eskalacji. Sekret do podpisywania webhooka jest wwebhook_secreti zwracany tylko przy tworzeniu kanału.uptimecheck_status_page: strona statusu z tytułem, wyglądem icomponents, czyli monitorami, które widzą odwiedzający, w kolejności i opcjonalnie w grupach. Hasło, lista dostępu przez e-mail i własny CSS ustawiasz w aplikacji i pozostają nietknięte. Usunięcie strony usuwa jej subskrybentów, opublikowane aktualizacje i statystyki odwiedzin.- Źródła danych
uptimecheck_alert_channels,uptimecheck_projectsiuptimecheck_status_pagespokazują to, co już istnieje. Pierwszego użyj dla kanałów SMS, Telegram, push i Add to Slack, które konfiguruje się w aplikacji.
Przenieś to, co już masz
Monitory, projekty, kanały powiadomień i strony statusu utworzone w aplikacji możesz zaimportować po ich 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_...
Adres zaimportowanego kanału powiadomień i sekret do podpisywania webhooka nie są odczytywane. Każdy zasób i atrybut jest opisany w Terraform Registry. Więcej o integracji z Terraform, kluczach API i REST API.