Skip to main content

Module conventions

Module conventions 

Source
Expand description

The built-in derivation conventions of the entity graph, embedded as conventions.yaml: the co-declared edge vocabulary, the virtual-destination candidates, and the implicit declarations of well-known Prometheus entity-descriptor metrics. The file is data shipped with the binary, not an operator-editable configuration surface; explicit greptime.semantic.entity.* declarations always override it.

StructsΒ§

Conventions
The parsed, validated conventions file.
EdgeRule
A same-row co-declaration rule: a source-table row carrying both entity identities witnesses src -rel-> dst.
ImplicitEntity
One implicit entity declaration: of a whitelisted Prometheus or OTel info metric, or of a trace-v1 table’s flattened resource attributes.
VirtualDstCandidate
A span-attribute column that may name an uninstrumented peer, and the connection_type its match implies.

ConstantsΒ§

CONNECTION_TYPES πŸ”’
CONNECTION_TYPE_DATABASE
The connection_type values a virtual-destination candidate may imply; the calls derivation branches on them when building edge attributes.
CONNECTION_TYPE_VIRTUAL_NODE
ENTITY_TYPES πŸ”’
ENTITY_TYPE_CONTAINER
ENTITY_TYPE_GEN_AI_AGENT
ENTITY_TYPE_GEN_AI_MODEL
ENTITY_TYPE_GEN_AI_TOOL
ENTITY_TYPE_HOST
ENTITY_TYPE_K8S_CONTAINER
ENTITY_TYPE_K8S_NODE
ENTITY_TYPE_K8S_POD
ENTITY_TYPE_K8S_SERVICE
ENTITY_TYPE_K8S_WORKLOAD
ENTITY_TYPE_PROCESS
ENTITY_TYPE_SERVICE
The built-in entity-type vocabulary. User-declared types are open-ended; the embedded conventions file must stay inside this set.
ENTITY_TYPE_SERVICE_INSTANCE
PROVENANCE_AGENT
PROVENANCE_ATTRIBUTE
PROVENANCE_DECLARED
PROVENANCE_TRACE
REL_TYPES πŸ”’
REL_TYPE_CALLS
The relationship vocabulary (the RFC’s rel_type table) and the edge provenances.
REL_TYPE_CONTAINS
REL_TYPE_DEPENDS_ON
REL_TYPE_INVOKES
REL_TYPE_OWNS
REL_TYPE_PART_OF
REL_TYPE_RUNS_ON
REL_TYPE_USES

StaticsΒ§

CONVENTIONS πŸ”’

FunctionsΒ§

conventions
The embedded conventions. Err means the embedded file is broken β€” pinned by unit test, and propagated by the derivation paths rather than panicking.
parse πŸ”’
validate πŸ”’