greptimedb/operator/statement/semantic_graph/conventions/index.html

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="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."><title>operator::statement::semantic_graph::conventions - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="operator" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module conventions</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../operator/index.html">operator</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module conventions</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#statics" title="Statics">Statics</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In operator::<wbr>statement::<wbr>semantic_<wbr>graph</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">operator</a>::<wbr><a href="../../index.html">statement</a>::<wbr><a href="../index.html">semantic_graph</a></div><h1>Module <span>conventions</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../../src/operator/statement/semantic_graph/conventions.rs.html#15-378">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The built-in derivation conventions of the entity graph, embedded as
<a href="./conventions.yaml"><code>conventions.yaml</code></a>: 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
<code>greptime.semantic.entity.*</code> declarations always override it.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Conventions.html" title="struct operator::statement::semantic_graph::conventions::Conventions">Conventions</a></dt><dd>The parsed, validated conventions file.</dd><dt><a class="struct" href="struct.EdgeRule.html" title="struct operator::statement::semantic_graph::conventions::EdgeRule">Edge<wbr>Rule</a></dt><dd>A same-row co-declaration rule: a source-table row carrying both entity
identities witnesses <code>src -rel-&gt; dst</code>.</dd><dt><a class="struct" href="struct.ImplicitEntity.html" title="struct operator::statement::semantic_graph::conventions::ImplicitEntity">Implicit<wbr>Entity</a></dt><dd>One implicit entity declaration: of a whitelisted Prometheus or OTel info
metric, or of a Trace V1/V2 table’s resource attributes.</dd><dt><a class="struct" href="struct.VirtualDstCandidate.html" title="struct operator::statement::semantic_graph::conventions::VirtualDstCandidate">Virtual<wbr>DstCandidate</a></dt><dd>A span-attribute column that may name an uninstrumented peer, and the
<code>connection_type</code> its match implies.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.CONNECTION_TYPES.html" title="constant operator::statement::semantic_graph::conventions::CONNECTION_TYPES">CONNECTION_<wbr>TYPES</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.CONNECTION_TYPE_DATABASE.html" title="constant operator::statement::semantic_graph::conventions::CONNECTION_TYPE_DATABASE">CONNECTION_<wbr>TYPE_<wbr>DATABASE</a></dt><dd>The <code>connection_type</code> values a virtual-destination candidate may imply;
the calls derivation branches on them when building edge attributes.</dd><dt><a class="constant" href="constant.CONNECTION_TYPE_VIRTUAL_NODE.html" title="constant operator::statement::semantic_graph::conventions::CONNECTION_TYPE_VIRTUAL_NODE">CONNECTION_<wbr>TYPE_<wbr>VIRTUAL_<wbr>NODE</a></dt><dt><a class="constant" href="constant.ENTITY_TYPES.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPES">ENTITY_<wbr>TYPES</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.ENTITY_TYPE_CONTAINER.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_CONTAINER">ENTITY_<wbr>TYPE_<wbr>CONTAINER</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_GEN_AI_AGENT.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_GEN_AI_AGENT">ENTITY_<wbr>TYPE_<wbr>GEN_<wbr>AI_<wbr>AGENT</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_GEN_AI_MODEL.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_GEN_AI_MODEL">ENTITY_<wbr>TYPE_<wbr>GEN_<wbr>AI_<wbr>MODEL</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_GEN_AI_TOOL.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_GEN_AI_TOOL">ENTITY_<wbr>TYPE_<wbr>GEN_<wbr>AI_<wbr>TOOL</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_HOST.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_HOST">ENTITY_<wbr>TYPE_<wbr>HOST</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_K8S_CONTAINER.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_K8S_CONTAINER">ENTITY_<wbr>TYPE_<wbr>K8S_<wbr>CONTAINER</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_K8S_NODE.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_K8S_NODE">ENTITY_<wbr>TYPE_<wbr>K8S_<wbr>NODE</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_K8S_POD.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_K8S_POD">ENTITY_<wbr>TYPE_<wbr>K8S_<wbr>POD</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_K8S_SERVICE.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_K8S_SERVICE">ENTITY_<wbr>TYPE_<wbr>K8S_<wbr>SERVICE</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_K8S_WORKLOAD.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_K8S_WORKLOAD">ENTITY_<wbr>TYPE_<wbr>K8S_<wbr>WORKLOAD</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_PROCESS.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_PROCESS">ENTITY_<wbr>TYPE_<wbr>PROCESS</a></dt><dt><a class="constant" href="constant.ENTITY_TYPE_SERVICE.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_SERVICE">ENTITY_<wbr>TYPE_<wbr>SERVICE</a></dt><dd>The built-in entity-type vocabulary. User-declared types are open-ended;
the embedded conventions file must stay inside this set.</dd><dt><a class="constant" href="constant.ENTITY_TYPE_SERVICE_INSTANCE.html" title="constant operator::statement::semantic_graph::conventions::ENTITY_TYPE_SERVICE_INSTANCE">ENTITY_<wbr>TYPE_<wbr>SERVICE_<wbr>INSTANCE</a></dt><dt><a class="constant" href="constant.PROVENANCE_AGENT.html" title="constant operator::statement::semantic_graph::conventions::PROVENANCE_AGENT">PROVENANCE_<wbr>AGENT</a></dt><dt><a class="constant" href="constant.PROVENANCE_ATTRIBUTE.html" title="constant operator::statement::semantic_graph::conventions::PROVENANCE_ATTRIBUTE">PROVENANCE_<wbr>ATTRIBUTE</a></dt><dt><a class="constant" href="constant.PROVENANCE_DECLARED.html" title="constant operator::statement::semantic_graph::conventions::PROVENANCE_DECLARED">PROVENANCE_<wbr>DECLARED</a></dt><dt><a class="constant" href="constant.PROVENANCE_TRACE.html" title="constant operator::statement::semantic_graph::conventions::PROVENANCE_TRACE">PROVENANCE_<wbr>TRACE</a></dt><dt><a class="constant" href="constant.REL_TYPES.html" title="constant operator::statement::semantic_graph::conventions::REL_TYPES">REL_<wbr>TYPES</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.REL_TYPE_CALLS.html" title="constant operator::statement::semantic_graph::conventions::REL_TYPE_CALLS">REL_<wbr>TYPE_<wbr>CALLS</a></dt><dd>The relationship vocabulary (the RFC’s rel_type table) and the edge
provenances.</dd><dt><a class="constant" href="constant.REL_TYPE_CONTAINS.html" title="constant operator::statement::semantic_graph::conventions::REL_TYPE_CONTAINS">REL_<wbr>TYPE_<wbr>CONTAINS</a></dt><dt><a class="constant" href="constant.REL_TYPE_DEPENDS_ON.html" title="constant operator::statement::semantic_graph::conventions::REL_TYPE_DEPENDS_ON">REL_<wbr>TYPE_<wbr>DEPENDS_<wbr>ON</a></dt><dt><a class="constant" href="constant.REL_TYPE_INVOKES.html" title="constant operator::statement::semantic_graph::conventions::REL_TYPE_INVOKES">REL_<wbr>TYPE_<wbr>INVOKES</a></dt><dt><a class="constant" href="constant.REL_TYPE_OWNS.html" title="constant operator::statement::semantic_graph::conventions::REL_TYPE_OWNS">REL_<wbr>TYPE_<wbr>OWNS</a></dt><dt><a class="constant" href="constant.REL_TYPE_PART_OF.html" title="constant operator::statement::semantic_graph::conventions::REL_TYPE_PART_OF">REL_<wbr>TYPE_<wbr>PART_<wbr>OF</a></dt><dt><a class="constant" href="constant.REL_TYPE_RUNS_ON.html" title="constant operator::statement::semantic_graph::conventions::REL_TYPE_RUNS_ON">REL_<wbr>TYPE_<wbr>RUNS_<wbr>ON</a></dt><dt><a class="constant" href="constant.REL_TYPE_USES.html" title="constant operator::statement::semantic_graph::conventions::REL_TYPE_USES">REL_<wbr>TYPE_<wbr>USES</a></dt></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.CONVENTIONS.html" title="static operator::statement::semantic_graph::conventions::CONVENTIONS">CONVENTIONS</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.conventions.html" title="fn operator::statement::semantic_graph::conventions::conventions">conventions</a></dt><dd>The embedded conventions. <code>Err</code> means the embedded file is broken — pinned
by unit test, and propagated by the derivation paths rather than panicking.</dd><dt><a class="fn" href="fn.parse.html" title="fn operator::statement::semantic_graph::conventions::parse">parse</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.validate.html" title="fn operator::statement::semantic_graph::conventions::validate">validate</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>