Ek açıklama güdümlü izleme — tek ek açıklama, çok sayıda bileşen
Bu örnek, tek bir bileşen başına features: bloğu yazmadan bir izleme Feature’ını iç içe bir topolojideki altı servise ekler. Üst sınırdaki tek bir operatör ek açıklaması, iki alt ağaç geçersiz kılmasıyla inceltilerek
Manifest’in features.annotations bağlaması aracılığıyla
kapsanan her bileşende bir core/prometheus-exporter eklemesine genişler ve her biri
kendi Prometheus ServiceMonitor’ünü oluşturur.
Bu, ek açıklama güdümlü Feature genişletme yüzeyidir: tekrarlanan bileşen başına Feature eklemelerini sınır ağacında aşağı doğru kademelenen tek bir ek açıklamaya sıkıştırma kalıbı.
Yapı
- Geliştirici niyeti (
aggregate.yaml) yalnızca altıexample/compute/servicebileşeni bildirir —gatewayveapi/worker/ledger/etl/reconcile. Hiçbir bileşen bir izlemefeatures:bloğu taşımaz. - Manifest (
manifest.yaml) ek açıklamayı Feature’a bağlar:features:type:core/prometheus-exporter: helm/prometheus-exporter:1.0.0 # the FeatureRecipe version bindingannotations:feature.aggrega.ai/monitoring:feature: core/prometheus-exportermaps:infra: [interval, port, path] # structured-value subkeys → the feature's infra - Release (
release.yaml) ek açıklamayıplatformsınırında bir kez ayarlar ve alt ağaç başına inceltir:platform:annotations:feature.aggrega.ai/monitoring: {interval: 30s, port: metrics, path: /metrics} # gateway inherits thisboundaries:payments:annotations:feature.aggrega.ai/monitoring: {interval: 15s} # api/worker/ledgerbatch:annotations:feature.aggrega.ai/monitoring: {interval: 120s} # etl/reconcile
core/prometheus-exporter ve onun bileşen kapsamlı ServiceMonitor FeatureRecipe’i standart katalogdan tüketilir (bu örnek yerel bir kopya bildirmez). Tarifin chart’ı, eklenen her bileşen için bir monitoring.coreos.com/v1 ServiceMonitor üretir ve interval/port/path değerlerini çözümlenmiş ek açıklamadan şablonlar — üçü de feature’ın infra bölümündeki operatör tarama ayarlarıdır. (Bu, FeatureRecipe Kaynak Üretimidir — helm sağlayıcısının işlediği source: + valuesMapping: — bir Wasm mutatörü ya da işlem hattı adımı değildir.)
Örneği oluşturun
Bu örneği aşağıdaki komutlarla derleyebilir ya da yapay zekâ asistanınıza sizin için derletebilirsiniz.
Örneği, adını taşıyan yeni bir klasöre yazın:
aggrega scaffold --example annotation-driven-monitoringArdından sırada çalıştırılacak komutları yazdırır. İlki yeni klasöre geçer:
cd annotation-driven-monitoringDerleme
Pull kilit dosyasını çözümler ve derleme onu okur:
aggrega pull --release release.yamlaggrega build --release release.yamlBir yapay zekâ asistanıyla
Aggrega araçlarıyla kurulmuş bir yapay zekâ asistanı da aynısını yapabilir: bu istemi ona yapıştırın.
Yalnızca Aggrega araçlarını kullanın ve kendiniz hiçbir klasör oluşturmayın. Çalışma alanı klasöründe henüz `annotation-driven-monitoring` klasörü yoksa `scaffold` aracını `example` değeri `annotation-driven-monitoring` olarak ayarlanmış ve `dir` olmadan bir kez çağırın: örneği yeni bir `annotation-driven-monitoring` klasörüne yazar. Ardından `build` aracını `workspace_root` değeri `annotation-driven-monitoring`, `release` değeri `release.yaml`, `auto_pull` değeri true ve `write` değeri true olarak ayarlanmış şekilde çağırın. Derlemenin hangi dosyaları yazdığını bana söyleyin; dosyalar `annotation-driven-monitoring/dist/` altındadır.Oluşturulan çıktının kanıtladıkları
Kilit dosyasını çözümleyin, derleyin ve dist/<boundary>/helm/<component>--feature-zdaggrega-zdai-zsmonitoring--<component>-servicemonitor-<component>-scrape.yaml dosyasını inceleyin:
aggrega pull --release release.yamlaggrega build --release release.yamlBu dosya adını çözümlemeye değer, çünkü burada kimse onu yazmadı. Bu hedef
yalnızca doğrudan bir dizinde bulunan dosyaları okur; bu nedenle bir eklemenin dosyaları
bileşenin kendi dosyalarının yanına düşer ve iki koordinatını dizin bölümleri yerine
dosya adında taşır: Feature’ın eklendiği bileşen, ardından
eklendiği ad. Burada ikinci koordinat kimsenin yazdığı bir ad değildir
— onu ek açıklama üretir ve bu, ek açıklama anahtarının kendisidir:
feature.aggrega.ai/monitoring. Nokta ve eğik çizgi bir dosya adına olduğu gibi
giremez; bu yüzden her biri -z ve bir harf olur: nokta için -zd,
eğik çizgi için -zs. payments sınırındaki api bileşeni için derleme şunu yazar
dist/payments/helm/api--feature-zdaggrega-zdai-zsmonitoring--api-servicemonitor-api-scrape.yamlBu kodlama, o anahtardaki eğik çizginin kendine ait bir dizin açmamasının nedenidir — asıl amaç da budur, çünkü bir alt düzeydeki dosya, sınır dizinini okuyan bir tarama yapılandırması tüketicisinin almayacağı bir dosyadır.
Bu örnek core/prometheus-exporter ve onun ServiceMonitor FeatureRecipe’ini (ve helm sağlayıcısını) standart kütüphaneden tüketir. example/compute/service tanıtım bileşeni ve tarifi, paylaşılan katalogda example/ yayıncısı altında, bu standart kütüphane varlıklarının yanında bulunur. Örneğin .aggrega-config.yaml dosyası hub.aggrega.ai adresini varsayılan kayıt defteri olarak bildirir; böylece varlıklar hub’dan çözümlenir — iki komutun da --catalog bayrağına ihtiyacı yoktur.
| Component | Sınır | interval | port | path |
|---|---|---|---|---|
gateway | platform | 30s (platform varsayılanı) | metrics | /metrics |
api / worker / ledger | payments | 15s (geçersiz kılma) | metrics | /metrics |
etl / reconcile | batch | 120s (geçersiz kılma) | metrics | /metrics |
Tablonun somutlaştırdığı üç olgu:
- Yazar tarafından bildirilmiş değil, ek açıklama güdümlü. Aggregate’in hiçbir yerinde izleme
features:yoktur, yine de altı ServiceMonitor oluşturulur. Bunlar yalnızca ek açıklamacore/prometheus-exporter’ı her bileşene genişlettiği için vardır (ekin derleme grafiğindekiorigindeğeriexplicitdeğil,annotation’dır). - Alt anahtar başına derin birleştirme.
paymentsvebatchyalnızcaintervalayarlar, yine de ServiceMonitor’leriport: metricsvepath: /metricstaşır — bunlar platform ek açıklamasının yapılandırılmış değerinden devralınır ve alt anahtar başına birleştirilir. Bir alt ağaç bir alanı geçersiz kılarken kardeş alanları devralır. - Yayılma. Altı bileşen tek platform ek açıklaması
ve iki tek satırlık geçersiz kılmayla izlenir — bileşen başına tekrarlanan
features:bloğu yoktur.
ServiceMonitor, Service’in adlandırılmış metrics portunu tarar (sentezlenen
Service metrics: 9090 sunar); böylece bağlamanın port: metrics değeri
gerçek bir uç noktaya çözümlenir.
Derleme zamanı ve çalışma zamanı
Bu bir Kubernetes/Helm örneğidir; kanıt, dist/ içindeki oluşturulmuş manifestlerdir.
ServiceMonitor port değeri Service’in adlandırılmış portuna başvurur; böylece
seçici ve uç nokta yapı gereği eşleşir — bağlantıları doğrulamak için bir kümeye
gerek yoktur. Canlı bir Prometheus Operator, oluşturulan ServiceMonitor’leri dağıtım
zamanında tüketir; derleyicinin işi (ek açıklama → kademeli olarak çözümlenmiş profille
bileşen başına ServiceMonitor) önceden tamamlanmış ve incelenebilir durumdadır.
Derleme deterministiktir — yeniden çalıştırdığınızda çıktı bayt bayt aynıdır.