semantic-conventions/templates/registry/markdown
Daniel Dyla 05dca2da88
Add enum value separators (#1572)
2024-11-20 20:08:42 -08:00
..
attribute_macros.j2 Render events with bodies (#1464) 2024-10-18 15:07:22 -07:00
attribute_namespace.md.j2 [chore] Render attribute name on foot notes (#1583) 2024-11-18 11:14:30 +01:00
attribute_table.j2 [chore] Generate attr name on requirement level notes (#1589) 2024-11-18 18:03:29 +01:00
body_field_table.j2 [chore] Generate attr name on requirement level notes (#1589) 2024-11-18 18:03:29 +01:00
enum_macros.j2 Add enum value separators (#1572) 2024-11-20 20:08:42 -08:00
event_macros.j2 Render events with bodies (#1464) 2024-10-18 15:07:22 -07:00
examples_macros.j2 Render events with bodies (#1464) 2024-10-18 15:07:22 -07:00
metric_macros.j2 (feat) Migrate all markdown generation to use JINJA snippets (#1000) 2024-05-15 12:35:17 +00:00
metric_table.j2 [chore] Render attribute name on foot notes (#1583) 2024-11-18 11:14:30 +01:00
notes.j2 [chore] Render attribute name on foot notes (#1583) 2024-11-18 11:14:30 +01:00
readme.md.j2 [chore] Improve markdown gen for registry pages (#1496) 2024-10-21 07:32:21 -07:00
requirement.j2 [chore] Generate attr name on requirement level notes (#1589) 2024-11-18 18:03:29 +01:00
resource_macros.j2 Merge experimental and stable attributes per resource type. (#1423) 2024-11-06 08:24:28 -08:00
sampling_macros.j2 [chore] Use group name for generating snippets (#1049) 2024-05-21 08:51:41 -07:00
snippet.md.j2 Render events with bodies (#1464) 2024-10-18 15:07:22 -07:00
stability.j2 Merge experimental and stable attributes per resource type. (#1423) 2024-11-06 08:24:28 -08:00
weaver.yaml Add CloudFoundry Resource Attributes (#624) 2024-09-27 14:39:32 -07:00

readme.md.j2

{{- template.set_file_name("README.md") -}}
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Registry
weight: -2
--->

<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/readme.md.j2 -->

# Attribute Registry

The attributes registry is the place where attributes are defined. An attribute definition covers the following properties of an attribute:

- the `id` (the fully qualified name) of the attribute
- the `type` of the attribute
- the `stability` of the attribute
- a `brief` description of the attribute and optionally a longer `note`
- example values

Attributes defined in the registry can be used in different semantic conventions. Attributes should be included in this registry before they are used in semantic conventions. Semantic conventions may override all the properties of an attribute except for the `id` and `type` in case it's required for a particular context. In addition, semantic conventions specify the requirement level of an attribute in the corresponding context.

A definition of an attribute in the registry doesn't necessarily imply that the attribute is used in any of the semantic conventions.

If applicable, application developers are encouraged to use existing attributes from this registry. See also [these recommendations][developers recommendations] regarding attribute selection and attribute naming for custom use cases.

All registered attributes are listed by namespace in this registry.

> **Warning**
> The following registry overview is a work in progress.
>
> Further attribute namespaces are currently being migrated and will appear in this registry soon.

Currently, the following namespaces exist:

{% for bundle in ctx %}
{%- set my_file_name = bundle.id | kebab_case ~ ".md" -%}
- [{{ bundle.id | title_case | acronym }}]({{ my_file_name }})
{% endfor %}
[developers recommendations]: ../general/attribute-naming.md#recommendations-for-application-developers