From 5e4ff9730b9fabf0273b2bd68221acbcf83e88d6 Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Tue, 22 Apr 2025 15:28:33 -0700 Subject: [PATCH] Fix semconv generation to support acronyms/initialisms and normative key words (#6684) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Split off work from https://github.com/open-telemetry/opentelemetry-go/pull/6683 --------- Co-authored-by: Robert Pająk --- semconv/helpers.j2 | 37 ++++++++++++++++++++++++++---- semconv/v1.31.0/attribute_group.go | 23 +++++++++---------- 2 files changed, 43 insertions(+), 17 deletions(-) diff --git a/semconv/helpers.j2 b/semconv/helpers.j2 index 58db72b6e..80c900ddf 100644 --- a/semconv/helpers.j2 +++ b/semconv/helpers.j2 @@ -31,12 +31,39 @@ Examples: {{ attr.examples | trim("[]") }} {%- endif %} {%- endmacro -%} -{%- macro it_reps(brief) -%} -{%- set brief = brief | trim() -%} -It represents {% if brief[:2] == "A " or brief[:3] == "An " or brief[:4] == "The " -%} - {{ brief[0]|lower }}{{ brief[1:] | trim(".") }}. +{%- macro lower_first(line) -%} +{%- if line[0] is upper and line[1] is upper -%} +{#- Assume an acronym -#} +{{ line }} {%- else -%} - the {{ brief[0]|lower }}{{ brief[1:] | trim(".") }}. +{{ line[0]|lower }}{{ line[1:] }} +{%- endif -%} +{%- endmacro -%} + +{%- macro first_word(line, delim=" ") -%} +{%- for c in line -%} +{%- if c == delim -%} +{{ line[:loop.index0] }} +{%- set line = "" -%} +{%- endif -%} +{%- endfor -%} +{%- endmacro -%} + +{%- macro it_reps(brief) -%} +{%- set norms = [ + "MUST", "REQUIRED", "SHALL", + "SHOULD", "RECOMMENDED", + "MAY", "OPTIONAL" +] -%} +{%- set brief = brief | trim() | trim(".") -%} +{%- if first_word(brief) is in norms -%} +It {{ brief }}. +{%- else -%} +It represents {% if brief[:2] == "A " or brief[:3] == "An " or brief[:4] == "The " -%} + {{ lower_first(brief) }}. +{%- else -%} + the {{ lower_first(brief) }}. +{%- endif -%} {%- endif -%} {%- endmacro -%} diff --git a/semconv/v1.31.0/attribute_group.go b/semconv/v1.31.0/attribute_group.go index 47fe92e04..950b27fe8 100644 --- a/semconv/v1.31.0/attribute_group.go +++ b/semconv/v1.31.0/attribute_group.go @@ -6082,7 +6082,7 @@ const ( HostIDKey = attribute.Key("host.id") // HostImageIDKey is the attribute Key conforming to the "host.image.id" - // semantic conventions. It represents the vM image ID or host OS image ID. For + // semantic conventions. It represents the VM image ID or host OS image ID. For // Cloud, this value is from the provider. // // Type: string @@ -6224,7 +6224,7 @@ func HostID(val string) attribute.KeyValue { } // HostImageID returns an attribute KeyValue conforming to the "host.image.id" -// semantic conventions. It represents the vM image ID or host OS image ID. For +// semantic conventions. It represents the VM image ID or host OS image ID. For // Cloud, this value is from the provider. func HostImageID(val string) attribute.KeyValue { return HostImageIDKey.String(val) @@ -6331,7 +6331,7 @@ const ( HTTPRequestBodySizeKey = attribute.Key("http.request.body.size") // HTTPRequestMethodKey is the attribute Key conforming to the - // "http.request.method" semantic conventions. It represents the hTTP request + // "http.request.method" semantic conventions. It represents the HTTP request // method. // // Type: Enum @@ -9992,9 +9992,8 @@ const ( RPCMessageCompressedSizeKey = attribute.Key("rpc.message.compressed_size") // RPCMessageIDKey is the attribute Key conforming to the "rpc.message.id" - // semantic conventions. It represents the mUST be calculated as two different - // counters starting from `1` one for sent messages and one for received - // message. + // semantic conventions. It MUST be calculated as two different counters + // starting from `1` one for sent messages and one for received message. // // Type: int // RequirementLevel: Recommended @@ -10112,8 +10111,8 @@ func RPCMessageCompressedSize(val int) attribute.KeyValue { } // RPCMessageID returns an attribute KeyValue conforming to the "rpc.message.id" -// semantic conventions. It represents the mUST be calculated as two different -// counters starting from `1` one for sent messages and one for received message. +// semantic conventions. It MUST be calculated as two different counters starting +// from `1` one for sent messages and one for received message. func RPCMessageID(val int) attribute.KeyValue { return RPCMessageIDKey.Int(val) } @@ -11288,7 +11287,7 @@ const ( TLSCipherKey = attribute.Key("tls.cipher") // TLSClientCertificateKey is the attribute Key conforming to the - // "tls.client.certificate" semantic conventions. It represents the pEM-encoded + // "tls.client.certificate" semantic conventions. It represents the PEM-encoded // stand-alone certificate offered by the client. This is usually // mutually-exclusive of `client.certificate_chain` since this value also exists // in that list. @@ -11496,7 +11495,7 @@ const ( TLSResumedKey = attribute.Key("tls.resumed") // TLSServerCertificateKey is the attribute Key conforming to the - // "tls.server.certificate" semantic conventions. It represents the pEM-encoded + // "tls.server.certificate" semantic conventions. It represents the PEM-encoded // stand-alone certificate offered by the server. This is usually // mutually-exclusive of `server.certificate_chain` since this value also exists // in that list. @@ -11628,7 +11627,7 @@ func TLSCipher(val string) attribute.KeyValue { } // TLSClientCertificate returns an attribute KeyValue conforming to the -// "tls.client.certificate" semantic conventions. It represents the pEM-encoded +// "tls.client.certificate" semantic conventions. It represents the PEM-encoded // stand-alone certificate offered by the client. This is usually // mutually-exclusive of `client.certificate_chain` since this value also exists // in that list. @@ -11759,7 +11758,7 @@ func TLSResumed(val bool) attribute.KeyValue { } // TLSServerCertificate returns an attribute KeyValue conforming to the -// "tls.server.certificate" semantic conventions. It represents the pEM-encoded +// "tls.server.certificate" semantic conventions. It represents the PEM-encoded // stand-alone certificate offered by the server. This is usually // mutually-exclusive of `server.certificate_chain` since this value also exists // in that list.