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.
Procedência
- Digest do conteúdo
- sha256:38e18a4b893d4aa8832ed40fc3c53cff0a0ded5f43d2917022d01a439bc1adf4
- Publicado
- 2026-11-10T10:13:14Z
- Identidade de assinatura
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Assinatura
- 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
Referência nesta versão
oci://hub.aggrega.ai/component/core/observability/prometheus:1.0.0Parâmetros do desenvolvedor
Valores que o desenvolvedor define no Aggregate.
| Nome | Tipo | Padrão | Obrigatório | Descrição |
|---|---|---|---|---|
| otlp_receiver | boolean | false | não | Turns 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. |
Dimensionamento do operador
Dimensionamento de infraestrutura que o operador ajusta por ambiente.
| Nome | Tipo | Padrão | Obrigatório | Descrição |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 9090 | não | HTTP 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_interfaces | boolean | false | não | Publishes 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_url | string | — | não | Externally 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_version | string | v3.5.0 | não | Prometheus container image tag. Selects the image tag on container targets; the chart-backed realization pins its own image tag. |
| source_version | string | — | não | Version 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. |
| compute | object | — | não | — |
| storage | object | — | não | — |
| overrides | object (open) | — | não | Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Contrato de saída
Valores que este componente publica para os consumidores pela topologia uses.
| Nome | Tipo | Padrão | Obrigatório | Descrição |
|---|---|---|---|---|
| host | string | — | sim | 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`. |
| port | integer | — | sim | 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. |
| protocol | string | — | não | How the published address is spoken to — `http`, so a consumer composes a data-source URL on that scheme. |
| otlp_http_endpoint | string | — | não | The 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_endpoint | string | — | não | The address Prometheus serves its own metrics at — `http://<host>:<port>/metrics`, on the query endpoint — for another scraper to scrape. |
Sockets uses
Os sockets de dependência pelos quais este componente se conecta. O destino de cada conexão ligada por um socket deve satisfazer o seletor de rótulos dele, e cada conexão pode carregar um acoplamento nos slots que o socket declara. Cada conexão que o Aggregate ou a Release liga pelo socket deve preencher os slots obrigatórios.
scrape_target
- Seletor
- component.aggrega.ai/type in (server, stateful-server, worker)
- Injeção
- env
Slots que cada conexão por este socket pode preencher
| Slot | Seletor | Obrigatório | Injeção | Sensível | Descrição |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | não | env, file | sim | 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 acoplamento
Pontos de vinculação nomeados nos quais uma Feature se acopla a este componente. O seletor de um slot restringe qual Feature pode preenchê-lo, e sua lista inject indica como o material da Feature pode ser entregue. Um slot obrigatório deve estar vinculado em cada instância, por um acoplamento na instância ou em um escopo acima dela, e um slot sensível é declarado para lidar com material secreto. Uma Feature também pode se acoplar com um nome que nenhum slot declara.
Nenhum slot de acoplamento declarado.
Lista de permissões de autoinjeção
env
Relações
Arestas tipadas de e para outras entidades publicadas. Uma referência sem destino publicado é exibida como uma aresta quebrada em vez de um link.
Usa
- usausa o socket «scrape_target»
component.aggrega.ai/type in (server, stateful-server, worker)
Slots de acoplamento: credential
core/ai-agent/agent-framework v1.0.0 →core/ai-agent/agent-framework v1.1.0 →core/ai-agent/agenta-api v1.0.0 →core/ai-agent/agenta-cron v1.0.0 →core/ai-agent/agenta-runner v1.0.0 →core/ai-agent/agenta-services v1.0.0 →core/ai-agent/agenta-web v1.0.0 →core/ai-agent/agenta-web-mobile v1.0.0 →core/ai-agent/agenta-worker-queues v1.0.0 →core/ai-agent/agenta-worker-streams v1.0.0 →core/ai-agent/autogen v1.0.0 →core/ai-agent/autogpt v1.0.0 →core/ai-agent/claude-agent-sdk v1.0.0 →core/ai-agent/crewai v1.0.0 →core/ai-agent/crewai v1.1.0 →core/ai-agent/dify v1.0.0 →core/ai-agent/dify v1.1.0 →core/ai-agent/dify-plugin-daemon v1.0.0 →core/ai-agent/dify-sandbox v1.0.0 →core/ai-agent/dify-ssrf-proxy v1.0.0 →core/ai-agent/dify-web v1.0.0 →core/ai-agent/dify-web v1.1.0 →core/ai-agent/dify-worker v1.0.0 →core/ai-agent/dify-worker v1.1.0 →core/ai-agent/dify-worker-beat v1.0.0 →core/ai-agent/dify-worker-beat v1.1.0 →core/ai-agent/dynamiq v1.0.0 →core/ai-agent/flowise v1.0.0 →core/ai-agent/flowise v1.1.0 →core/ai-agent/google-adk v1.0.0 →core/ai-agent/google-adk v1.1.0 →core/ai-agent/griptape v1.0.0 →core/ai-agent/haystack v1.0.0 →core/ai-agent/langflow v1.0.0 →core/ai-agent/langflow v1.1.0 →core/ai-agent/langgraph v1.0.0 →core/ai-agent/langgraph v1.1.0 →core/ai-agent/librechat v1.0.0 →core/ai-agent/librechat v1.1.0 →core/ai-agent/librechat v1.2.0 →core/ai-agent/livekit-agent-worker v1.0.0 →core/ai-agent/llamaindex v1.0.0 →core/ai-agent/mastra v1.0.0 →core/ai-agent/metagpt v1.0.0 →core/ai-agent/n8n v1.0.0 →core/ai-agent/n8n v1.1.0 →core/ai-agent/open-webui v1.0.0 →core/ai-agent/openai-agents-sdk v1.0.0 →core/ai-agent/openclaw v1.0.0 →core/ai-agent/openhands v1.0.0 →core/ai-agent/phidata v1.0.0 →core/ai-agent/promptflow v1.0.0 →core/ai-agent/pydantic-ai v1.0.0 →core/ai-agent/rivet v1.0.0 →core/ai-agent/semantic-kernel v1.0.0 →core/ai-agent/smolagents v1.0.0 →core/ai-model/docker-model-runner v1.0.0 →core/ai-model/litellm v1.0.0 →core/ai-model/nemoguard-content-safety v1.0.0 →core/ai-model/nvidia-nim v1.0.0 →core/ai-model/nvidia-nim-operator v1.0.0 →core/ai-model/ollama v1.0.0 →core/ai-model/tei v1.0.0 →core/ai-model/tgi v1.0.0 →core/ai-model/vllm v1.0.0 →core/ai-pipeline/argo-workflows v1.0.0 →core/ai-pipeline/temporal v1.0.0 →core/ai-tool/browser v1.0.0 →core/ai-tool/computer-use v1.0.0 →core/ai-tool/filesystem v1.0.0 →core/ai-tool/mcp v1.0.0 →core/ai-tool/mcp v1.1.0 →core/compute/keda v1.0.0 →core/compute/knative-serving v1.0.0 →core/compute/server v1.0.0 →core/compute/server v1.1.0 →core/compute/worker v1.0.0 →core/datastore/chroma v1.0.0 →core/datastore/cognee v1.0.0 →core/datastore/documentdb v1.0.0 →core/datastore/elasticsearch v1.0.0 →core/datastore/etcd v1.0.0 →core/datastore/ferretdb v1.0.0 →core/datastore/mariadb v1.0.0 →core/datastore/mariadb-operator v1.0.0 →core/datastore/memcached v1.0.0 →core/datastore/milvus v1.0.0 →core/datastore/mysql v1.0.0 →core/datastore/mysql-innodb-cluster v1.0.0 →core/datastore/mysql-operator v1.0.0 →core/datastore/opensearch v1.0.0 →core/datastore/pgvector v1.0.0 →core/datastore/postgres v1.0.0 →core/datastore/qdrant v1.0.0 →core/datastore/redis v1.0.0 →core/datastore/timescaledb v1.0.0 →core/datastore/valkey v1.0.0 →core/datastore/weaviate v1.0.0 →core/devtool/adminer v1.0.0 →core/devtool/harbor v1.0.0 →core/gateway/agentgateway v1.0.0 →core/gateway/apisix v1.0.0 →core/gateway/contour v1.0.0 →core/gateway/envoy-ai-gateway-operator v1.0.0 →core/gateway/envoy-gateway v1.0.0 →core/gateway/higress v1.0.0 →core/gateway/kong v1.0.0 →core/gateway/kong-enterprise v1.0.0 →core/gateway/litellm v1.0.0 →core/gateway/nginx v1.0.0 →core/gateway/traefik-hub v1.0.0 →core/gateway/tyk v1.0.0 →core/messaging/kafka v1.0.0 →core/messaging/livekit-server v1.0.0 →core/messaging/livekit-sip v1.0.0 →core/messaging/nats v1.0.0 →core/messaging/rabbitmq v1.0.0 →core/messaging/rabbitmq-cluster-operator v1.0.0 →core/messaging/strimzi-operator v1.0.0 →core/observability/fluent-bit v1.0.0 →core/observability/fluentd v1.0.0 →core/observability/grafana v1.0.0 →core/observability/jaeger v1.0.0 →core/observability/langfuse v1.0.0 →core/observability/loki v1.0.0 →core/observability/otel-collector v1.0.0 →core/observability/tempo v1.0.0 →core/observability/thanos-query v1.0.0 →core/observability/thanos-store v1.0.0 →core/security/cert-manager v1.0.0 →core/security/external-secrets v1.0.0 →core/security/fms-guardrails-orchestrator v1.0.0 →core/security/keycloak v1.0.0 →core/security/kong-ai-pii-service v1.0.0 →core/security/nemo-guardrails v1.0.0 →core/security/nemoguard-jailbreak-detect v1.0.0 →core/security/openbao v1.0.0 →core/security/presidio-analyzer v1.0.0 →core/security/presidio-anonymizer v1.0.0 →core/security/sealed-secrets v1.0.0 →core/security/supertokens v1.0.0 →core/security/trustyai-guardrails-gateway v1.0.0 →core/security/trustyai-huggingface-detector v1.0.0 →core/storage/barman-cloud-plugin v1.0.0 →core/storage/k8up v1.0.0 →core/storage/kasten v1.0.0 →core/storage/kubestash v1.0.0 →core/storage/velero v1.0.0 →example/compute/db-reader v1.0.0 →example/compute/gcp-credentialed-service v1.0.0 →example/compute/greeter v1.0.0 →example/compute/service v1.0.0 →example/gateway/nginx-reviewed v1.0.0 →
Usado por
usa o socket «backend»
usa o socket «databases»
usa o socket «etcd»
usa o socket «backend»
usa o socket «backend»
usa o socket «forward_target»
usa o socket «metrics»
usa o socket «backend»
usa o socket «database»
aplica-se a
aplica-se a
aplica-se a
implementa
implementa
implementa