Diese Seite wurde maschinell übersetzt. Englisches Original lesen.

Component

core/observability/prometheus

A Prometheus metrics server, storing what it scrapes in a local time-series database. Its targets are wired through its `scrape_target` uses-socket, which admits servers, stateful servers and workers, and each connection becomes one scrape job, its label and cadence set on that connection. The target says where it serves metrics: it publishes `metrics_endpoint`, the address Prometheus scrapes, or, on Kubernetes, `metrics_service` or `metrics_pod_selector`, which Prometheus discovers from the cluster. A target publishing none of them halts the build, naming it. A connection's optional `credential` is presented to its target as a bearer token, read from a file the Recipe delivers by reference; a target publishing `metrics_credential_required` true halts the build while its connection carries none. Prometheus publishes its own metrics address as `metrics_endpoint` too. With `values.otlp_receiver` true it also receives metrics pushed over OTLP HTTP, at the address it then publishes as `otlp_http_endpoint`, and that endpoint authenticates no caller. It carries `observability.aggrega.ai/metrics: otlp-http`, which an OpenTelemetry Collector's `metrics` socket selects. On Kubernetes the Manifest chooses between two realizations. `prometheus` synthesizes the server as a workload and fetches nothing, for a build that must complete with no chart repository reachable. `prometheus-chart` renders the prometheus-community Helm chart, whose cluster-wide read grant also lets the server scrape whatever the cluster advertises through scrape annotations.

Herkunft

OffiziellSigniert von einer Signaturidentität, die dieser Katalog als offiziellen Herausgeber anerkennt.
Inhalts-Digest
sha256:38e18a4b893d4aa8832ed40fc3c53cff0a0ded5f43d2917022d01a439bc1adf4
Veröffentlicht
2026-11-10T10:13:14Z
Signaturidentität
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signatur

  • Offiziellapplication/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:7083446ed180c9d97ee682a5699d388f7b3102198778e2b9d1b801321757d9f8

Referenz zu dieser Version

oci://hub.aggrega.ai/component/core/observability/prometheus:1.0.0

Entwicklerparameter

Werte, die der Entwickler im Aggregate festlegt.

NameTypStandardwertErforderlichBeschreibung
otlp_receiverbooleanfalseneinTurns on Prometheus's OTLP receiver, which accepts metrics pushed over OTLP HTTP at /api/v1/otlp/v1/metrics, and publishes its base address as `otlp_http_endpoint`; while false that key is empty and an OpenTelemetry Collector wired to this server halts the build. The receiver authenticates no caller, so anything that reaches the server's port can write metrics into it. The address is published only inside the Release; the compose realization also publishes the port on the host's loopback address, and on every host interface while `infra.publish_on_all_interfaces` is true.

Dimensionierung durch den Operator

Infrastrukturdimensionierung, die der Operator pro Umgebung anpasst.

NameTypStandardwertErforderlichBeschreibung
portinteger (min 1024, max 65535)9090neinHTTP port the Prometheus query and scrape endpoint listens on. Most operators should omit this and let the Recipe assign the default (9090).
publish_on_all_interfacesbooleanfalseneinPublishes the server's port on every host interface rather than on the host's loopback address only. Read only by the compose realization; false publishes the port on 127.0.0.1 only, and true on every host interface, where any machine that reaches the host reaches it — the OTLP receiver included while `values.otlp_receiver` is true, which authenticates no caller. The Kubernetes realizations ignore it.
external_base_urlstring—neinExternally reachable base URL of the metrics server, as assembled at the ingress tier, including any path the ingress serves it under — for example https://prometheus.example.com or https://tools.example.com/prometheus. The server composes from this the relative and absolute links back to itself that it writes. On its own the server would also move every endpoint under that address's path; the Recipes keep it serving at its root instead, so its health checks and every consumer reaching it through its published host and port are unaffected, and an ingress in front of it maps the address's path onto that root. Omitted, the server derives those links from its own host name and listening port.
engine_versionstringv3.5.0neinPrometheus container image tag. Selects the image tag on container targets; the chart-backed realization pins its own image tag.
source_versionstring—neinVersion of the Helm chart the chart-backed realization pulls. Read only by that realization; the workload-synthesis and Compose realizations pull no source artifact and ignore it. Changing it away from the Recipe's default does not guarantee value-mapping compatibility with the new chart.
computeobject—nein—
storageobject—nein—
overridesobject (open)—neinProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Ausgabevertrag

Werte, die diese Komponente über die uses-Topologie an Konsumenten veröffentlicht.

NameTypStandardwertErforderlichBeschreibung
hoststring—jaIn-cluster DNS name of the Service fronting the query endpoint. A dashboard or an alert rule evaluator points its data-source address at this name together with `port`.
portinteger—jaTCP port that Service serves the query endpoint on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default.
protocolstring—neinHow the published address is spoken to — `http`, so a consumer composes a data-source URL on that scheme.
otlp_http_endpointstring—neinThe OTLP HTTP base address metrics are received at — `http://<host>:<port>/api/v1/otlp` — while `values.otlp_receiver` is true; empty while it is false.
metrics_endpointstring—neinThe address Prometheus serves its own metrics at — `http://<host>:<port>/metrics`, on the query endpoint — for another scraper to scrape.

uses-Sockets

Die Abhängigkeits-Sockets, über die sich diese Komponente verbindet. Das Ziel jeder über einen Socket verdrahteten Verbindung muss dessen Label-Selektor erfüllen, und jede Verbindung kann in den Slots, die der Socket deklariert, eine Anbindung tragen. Einen erforderlichen Slot muss jede Verbindung füllen, die das Aggregate oder das Release über den Socket verdrahtet.

scrape_target

Selektor
component.aggrega.ai/type in (server, stateful-server, worker)
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
credentialfeature.aggrega.ai/kind=secretneinenv, filejaOptional credential Prometheus presents when it scrapes the target of this connection, as Authorization: Bearer followed by the attachment's value, so the attachment holds the bare token. It reaches the server by reference, as a file the scrape job reads on every scrape: on Kubernetes the Secret the credential publishes is mounted as a file, and a credential publishing no Secret name and data key halts the build; on Docker Compose the value arrives as the container variable PROMETHEUS_SCRAPE_<n>_CREDENTIAL, which the start-up command writes to the file. The scrape configuration names only the file. Prometheus scrapes the address the target publishes, which inside a Release is usually http, so the credential crosses the network unencrypted there. Unattached, the scrape presents none, and a target publishing metrics_credential_required true halts the build.

Anbindungs-Slots

Benannte Bindungspunkte, an denen ein Feature an diese Komponente angebunden wird. Der Selektor eines Slots schränkt ein, welches Feature ihn füllen darf, und seine inject-Liste benennt, wie das Feature sein Material liefern darf. Ein erforderlicher Slot muss auf jeder Instanz gebunden sein, durch eine Anbindung an der Instanz oder in einem darüberliegenden Geltungsbereich, und ein sensibler Slot ist für den Umgang mit geheimem Material deklariert. Ein Feature kann auch unter einem Namen angebunden werden, den kein Slot deklariert.

Keine Anbindungs-Slots deklariert.

Zulassungsliste für Selbstinjektion

env

Beziehungen

Typisierte Kanten zu und von anderen veröffentlichten Entitäten. Eine Referenz ohne veröffentlichtes Ziel wird als unterbrochene Kante statt als Link dargestellt.

Verwendet

Verwendet von

Konzeptreferenz zu Component →

Der Aggrega-Katalog — ein offener Index von Komponenten, Funktionen, Rezepten und den Plugins, die sie rendern.

Erstellt mit dem gemeinsamen Aggrega-Designsystem.

Datenschutz