New semconvgen templates prototype

src/OpenTelemetry.SemanticConventions/SemanticConventions/ClientAttributes.cs

@@ -0,0 +1,44 @@
+// <copyright file="ClientAttributes.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+// <auto-generated> This file has been auto generated from buildscripts/semantic-conventions/templates/Attributes.cs.j2</auto-generated>
+
+using System;
+
+namespace OpenTelemetry.SemanticConventions
+{
+    /// <summary>
+    /// Describes semantic conventions for attributes in the <c>client</c> namespace.
+    /// </summary>
+    public static class ClientAttributes
+    {
+        /// <summary>
+        /// Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
+        /// </summary>
+        /// <remarks>
+        /// When observed from the server side, and when communicating through an intermediary, <c>client.address</c> SHOULD represent the client address behind any intermediaries,  for example proxies, if it&amp;#39;s available.
+        /// </remarks>
+        public const string ClientAddress = "client.address";
+
+        /// <summary>
+        /// Client port number.
+        /// </summary>
+        /// <remarks>
+        /// When observed from the server side, and when communicating through an intermediary, <c>client.port</c> SHOULD represent the client port behind any intermediaries,  for example proxies, if it&amp;#39;s available.
+        /// </remarks>
+        public const string ClientPort = "client.port";
+    }
+}

src/OpenTelemetry.SemanticConventions/SemanticConventions/ErrorAttributes.cs

@@ -0,0 +1,55 @@
+// <copyright file="ErrorAttributes.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+// <auto-generated> This file has been auto generated from buildscripts/semantic-conventions/templates/Attributes.cs.j2</auto-generated>
+
+using System;
+
+namespace OpenTelemetry.SemanticConventions
+{
+    /// <summary>
+    /// Describes semantic conventions for attributes in the <c>error</c> namespace.
+    /// </summary>
+    public static class ErrorAttributes
+    {
+        /// <summary>
+        /// Describes a class of error the operation ended with.
+        /// </summary>
+        /// <remarks>
+        /// The <c>error.type</c> SHOULD be predictable and SHOULD have low cardinality.
+        /// Instrumentations SHOULD document the list of errors they report.The cardinality of <c>error.type</c> within one instrumentation library SHOULD be low.
+        /// Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
+        /// should be prepared for <c>error.type</c> to have high cardinality at query time when no
+        /// additional filters are applied.If the operation has completed successfully, instrumentations SHOULD NOT set <c>error.type</c>.If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
+        /// it&amp;#39;s RECOMMENDED to:<ul>
+        /// <li>Use a domain-specific attribute</li>
+        /// <li>Set <c>error.type</c> to capture all errors, regardless of whether they are defined within the domain-specific set or not</li>
+        /// </ul>.
+        /// </remarks>
+        public const string ErrorType = "error.type";
+
+        /// <summary>
+        /// Describes a class of error the operation ended with.
+        /// </summary>
+        public static class ErrorTypeValues
+        {
+            /// <summary>
+            /// A fallback error value to be used when the instrumentation doesn't define a custom value.
+            /// </summary>
+            public const string Other = "_OTHER";
+        }
+    }
+}

src/OpenTelemetry.SemanticConventions/SemanticConventions/HttpAttributes.cs

@@ -0,0 +1,137 @@
+// <copyright file="HttpAttributes.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+// <auto-generated> This file has been auto generated from buildscripts/semantic-conventions/templates/Attributes.cs.j2</auto-generated>
+
+using System;
+
+namespace OpenTelemetry.SemanticConventions
+{
+    /// <summary>
+    /// Describes semantic conventions for attributes in the <c>http</c> namespace.
+    /// </summary>
+    public static class HttpAttributes
+    {
+        /// <summary>
+        /// HTTP request headers, <c><key></c> being the normalized HTTP Header name (lowercase), the value being the header values.
+        /// </summary>
+        /// <remarks>
+        /// Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information.
+        /// The <c>User-Agent</c> header is already captured in the <c>user_agent.original</c> attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended.
+        /// The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers.
+        /// </remarks>
+        public const string HttpRequestHeaderTemplate = "http.request.header";
+
+        /// <summary>
+        /// HTTP request method.
+        /// </summary>
+        /// <remarks>
+        /// HTTP request method value SHOULD be &amp;#34;known&amp;#34; to the instrumentation.
+        /// By default, this convention defines &amp;#34;known&amp;#34; methods as the ones listed in <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-methods">RFC9110</a>
+        /// and the PATCH method defined in <a href="https://www.rfc-editor.org/rfc/rfc5789.html">RFC5789</a>.If the HTTP request method is not known to instrumentation, it MUST set the <c>http.request.method</c> attribute to <c>_OTHER</c>.If the HTTP instrumentation could end up converting valid HTTP request methods to <c>_OTHER</c>, then it MUST provide a way to override
+        /// the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named
+        /// OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods
+        /// (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults).HTTP method names are case-sensitive and <c>http.request.method</c> attribute value MUST match a known HTTP method name exactly.
+        /// Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent.
+        /// Tracing instrumentations that do so, MUST also set <c>http.request.method_original</c> to the original value.
+        /// </remarks>
+        public const string HttpRequestMethod = "http.request.method";
+
+        /// <summary>
+        /// Original HTTP method sent by the client in the request line.
+        /// </summary>
+        public const string HttpRequestMethodOriginal = "http.request.method_original";
+
+        /// <summary>
+        /// The ordinal number of request resending attempt (for any reason, including redirects).
+        /// </summary>
+        /// <remarks>
+        /// The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other).
+        /// </remarks>
+        public const string HttpRequestResendCount = "http.request.resend_count";
+
+        /// <summary>
+        /// HTTP response headers, <c><key></c> being the normalized HTTP Header name (lowercase), the value being the header values.
+        /// </summary>
+        /// <remarks>
+        /// Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information.
+        /// Users MAY explicitly configure instrumentations to capture them even though it is not recommended.
+        /// The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers.
+        /// </remarks>
+        public const string HttpResponseHeaderTemplate = "http.response.header";
+
+        /// <summary>
+        /// <a href="https://tools.ietf.org/html/rfc7231#section-6">HTTP response status code</a>.
+        /// </summary>
+        public const string HttpResponseStatusCode = "http.response.status_code";
+
+        /// <summary>
+        /// The matched route, that is, the path template in the format used by the respective server framework.
+        /// </summary>
+        /// <remarks>
+        /// MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it.
+        /// SHOULD include the <a href="/docs/http/http-spans.md#http-server-definitions">application root</a> if there is one.
+        /// </remarks>
+        public const string HttpRoute = "http.route";
+
+        /// <summary>
+        /// HTTP request method.
+        /// </summary>
+        public static class HttpRequestMethodValues
+        {
+            /// <summary>
+            /// CONNECT method.
+            /// </summary>
+            public const string Connect = "CONNECT";
+            /// <summary>
+            /// DELETE method.
+            /// </summary>
+            public const string Delete = "DELETE";
+            /// <summary>
+            /// GET method.
+            /// </summary>
+            public const string Get = "GET";
+            /// <summary>
+            /// HEAD method.
+            /// </summary>
+            public const string Head = "HEAD";
+            /// <summary>
+            /// OPTIONS method.
+            /// </summary>
+            public const string Options = "OPTIONS";
+            /// <summary>
+            /// PATCH method.
+            /// </summary>
+            public const string Patch = "PATCH";
+            /// <summary>
+            /// POST method.
+            /// </summary>
+            public const string Post = "POST";
+            /// <summary>
+            /// PUT method.
+            /// </summary>
+            public const string Put = "PUT";
+            /// <summary>
+            /// TRACE method.
+            /// </summary>
+            public const string Trace = "TRACE";
+            /// <summary>
+            /// Any HTTP method that the instrumentation has no prior knowledge of.
+            /// </summary>
+            public const string Other = "_OTHER";
+        }
+    }
+}

src/OpenTelemetry.SemanticConventions/SemanticConventions/NetworkAttributes.cs

@@ -0,0 +1,120 @@
+// <copyright file="NetworkAttributes.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+// <auto-generated> This file has been auto generated from buildscripts/semantic-conventions/templates/Attributes.cs.j2</auto-generated>
+
+using System;
+
+namespace OpenTelemetry.SemanticConventions
+{
+    /// <summary>
+    /// Describes semantic conventions for attributes in the <c>network</c> namespace.
+    /// </summary>
+    public static class NetworkAttributes
+    {
+        /// <summary>
+        /// Local address of the network connection - IP address or Unix domain socket name.
+        /// </summary>
+        public const string NetworkLocalAddress = "network.local.address";
+
+        /// <summary>
+        /// Local port number of the network connection.
+        /// </summary>
+        public const string NetworkLocalPort = "network.local.port";
+
+        /// <summary>
+        /// Peer address of the network connection - IP address or Unix domain socket name.
+        /// </summary>
+        public const string NetworkPeerAddress = "network.peer.address";
+
+        /// <summary>
+        /// Peer port number of the network connection.
+        /// </summary>
+        public const string NetworkPeerPort = "network.peer.port";
+
+        /// <summary>
+        /// <a href="https://osi-model.com/application-layer/">OSI application layer</a> or non-OSI equivalent.
+        /// </summary>
+        /// <remarks>
+        /// The value SHOULD be normalized to lowercase.
+        /// </remarks>
+        public const string NetworkProtocolName = "network.protocol.name";
+
+        /// <summary>
+        /// Version of the protocol specified in <c>network.protocol.name</c>.
+        /// </summary>
+        /// <remarks>
+        /// <c>network.protocol.version</c> refers to the version of the protocol used and might be different from the protocol client&amp;#39;s version. If the HTTP client has a version of <c>0.27.2</c>, but sends HTTP version <c>1.1</c>, this attribute should be set to <c>1.1</c>.
+        /// </remarks>
+        public const string NetworkProtocolVersion = "network.protocol.version";
+
+        /// <summary>
+        /// <a href="https://osi-model.com/transport-layer/">OSI transport layer</a> or <a href="https://wikipedia.org/wiki/Inter-process_communication">inter-process communication method</a>.
+        /// </summary>
+        /// <remarks>
+        /// The value SHOULD be normalized to lowercase.Consider always setting the transport when setting a port number, since
+        /// a port number is ambiguous without knowing the transport. For example
+        /// different processes could be listening on TCP port 12345 and UDP port 12345.
+        /// </remarks>
+        public const string NetworkTransport = "network.transport";
+
+        /// <summary>
+        /// <a href="https://osi-model.com/network-layer/">OSI network layer</a> or non-OSI equivalent.
+        /// </summary>
+        /// <remarks>
+        /// The value SHOULD be normalized to lowercase.
+        /// </remarks>
+        public const string NetworkType = "network.type";
+
+        /// <summary>
+        /// <a href="https://osi-model.com/transport-layer/">OSI transport layer</a> or <a href="https://wikipedia.org/wiki/Inter-process_communication">inter-process communication method</a>.
+        /// </summary>
+        public static class NetworkTransportValues
+        {
+            /// <summary>
+            /// TCP.
+            /// </summary>
+            public const string Tcp = "tcp";
+            /// <summary>
+            /// UDP.
+            /// </summary>
+            public const string Udp = "udp";
+            /// <summary>
+            /// Named or anonymous pipe.
+            /// </summary>
+            public const string Pipe = "pipe";
+            /// <summary>
+            /// Unix domain socket.
+            /// </summary>
+            public const string Unix = "unix";
+        }
+
+        /// <summary>
+        /// <a href="https://osi-model.com/network-layer/">OSI network layer</a> or non-OSI equivalent.
+        /// </summary>
+        public static class NetworkTypeValues
+        {
+            /// <summary>
+            /// IPv4.
+            /// </summary>
+            public const string Ipv4 = "ipv4";
+            /// <summary>
+            /// IPv6.
+            /// </summary>
+            public const string Ipv6 = "ipv6";
+        }
+    }
+}