Esta página se tradujo automáticamente. Leer el original en inglés.

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.

Procedencia

OficialFirmado por una identidad de firma que este catálogo reconoce como editor oficial.
Digest del contenido
sha256:38e18a4b893d4aa8832ed40fc3c53cff0a0ded5f43d2917022d01a439bc1adf4
Publicado
2026-11-10T10:13:14Z
Identidad de firma
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Firma

  • Oficialapplication/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

Referencia en esta versión

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

Parámetros del desarrollador

Valores que el desarrollador establece en el Aggregate.

NombreTipoPredeterminadoObligatorioDescripción
otlp_receiverbooleanfalsenoTurns 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.

Dimensionamiento del operador

Dimensionamiento de la infraestructura que el operador ajusta para cada entorno.

NombreTipoPredeterminadoObligatorioDescripción
portinteger (min 1024, max 65535)9090noHTTP 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_interfacesbooleanfalsenoPublishes 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—noExternally 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.0noPrometheus container image tag. Selects the image tag on container targets; the chart-backed realization pins its own image tag.
source_versionstring—noVersion 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—no—
storageobject—no—
overridesobject (open)—noProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Contrato de salida

Valores que este componente publica para los consumidores a través de la topología uses.

NombreTipoPredeterminadoObligatorioDescripción
hoststring—síIn-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—síTCP 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—noHow the published address is spoken to — `http`, so a consumer composes a data-source URL on that scheme.
otlp_http_endpointstring—noThe 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—noThe address Prometheus serves its own metrics at — `http://<host>:<port>/metrics`, on the query endpoint — for another scraper to scrape.

Sockets uses

Los sockets de dependencia a través de los cuales se conecta este componente. El destino de cada conexión cableada a través de un socket debe satisfacer su selector de etiquetas, y cada conexión puede llevar un acoplamiento en los slots que declara el socket. Cada conexión que el Aggregate o la Release cablea a través del socket debe llenar los slots obligatorios.

scrape_target

Selector
component.aggrega.ai/type in (server, stateful-server, worker)
Inyección
env

Slots que cada conexión a través de este socket puede llenar

SlotSelectorObligatorioInyecciónSensibleDescripción
credentialfeature.aggrega.ai/kind=secretnoenv, filesíOptional 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.

Slots de acoplamiento

Puntos de enlace con nombre en los que una Feature se acopla a este componente. El selector de un slot restringe qué Feature puede llenarlo y su lista inject indica cómo puede entregarse el material de la Feature. Un slot obligatorio debe estar enlazado en cada instancia, mediante un acoplamiento en la instancia o en un ámbito superior, y un slot sensible se declara para manejar material secreto. Una Feature también puede acoplarse con un nombre que ningún slot declara.

No se declararon slots de acoplamiento.

Lista de permitidos de autoinyección

env

Relaciones

Aristas tipadas hacia y desde otras entidades publicadas. Una referencia sin un destino publicado se muestra como una arista rota en lugar de como un enlace.

Usa

Usado por

Referencia del concepto Component →

El catálogo de Aggrega — un índice abierto de componentes, funcionalidades, recetas y los plugins que los renderizan.

Creado con el sistema de diseño compartido de Aggrega.

Privacidad