Add documentation hints to SpanAttributeName constants 📖

Author: slashmo

Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+EndUser.swift

@@ -14,8 +14,11 @@
 import TracingInstrumentation
 
 extension SpanAttributeName {
+    /// - See: EndUserAttributes
     public static let endUserID = "enduser.id"
+    /// - See: EndUserAttributes
     public static let endUserRole = "enduser.role"
+    /// - See: EndUserAttributes
     public static let endUserScope = "enduser.scope"
 }
 

Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+HTTPSemantics.swift

@@ -14,21 +14,37 @@
 import TracingInstrumentation
 
 extension SpanAttributeName {
+    /// - See: HTTPAttributes
     public static let httpMethod = "http.method"
+    /// - See: HTTPAttributes
     public static let httpURL = "http.url"
+    /// - See: HTTPAttributes
     public static let httpTarget = "http.target"
+    /// - See: HTTPAttributes
     public static let httpHost = "http.host"
+    /// - See: HTTPAttributes
     public static let httpScheme = "http.scheme"
+    /// - See: HTTPAttributes
     public static let httpStatusCode = "http.status_code"
+    /// - See: HTTPAttributes
     public static let httpStatusText = "http.status_text"
+    /// - See: HTTPAttributes
     public static let httpFlavor = "http.flavor"
+    /// - See: HTTPAttributes
     public static let httpUserAgent = "http.user_agent"
+    /// - See: HTTPAttributes
     public static let httpRequestContentLength = "http.request_content_length"
+    /// - See: HTTPAttributes
     public static let httpRequestContentLengthUncompressed = "http.request_content_length_uncompressed"
+    /// - See: HTTPAttributes
     public static let httpResponseContentLength = "http.response_content_length"
+    /// - See: HTTPAttributes
     public static let httpResponseContentLengthUncompressed = "http.response_content_length_uncompressed"
+    /// - See: HTTPAttributes
     public static let httpServerName = "http.server_name"
+    /// - See: HTTPAttributes
     public static let httpServerRoute = "http.route"
+    /// - See: HTTPAttributes
     public static let httpServerClientIP = "http.client_ip"
 }
 

Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+NetSemantics.swift

@@ -14,12 +14,19 @@
 import TracingInstrumentation
 
 extension SpanAttributeName {
+    /// - See: NetAttributes
     public static let netTransport = "net.transport"
+    /// - See: NetAttributes
     public static let netPeerIP = "net.peer.ip"
+    /// - See: NetAttributes
     public static let netPeerPort = "net.peer.port"
+    /// - See: NetAttributes
     public static let netPeerName = "net.peer.name"
+    /// - See: NetAttributes
     public static let netHostIP = "net.host.ip"
+    /// - See: NetAttributes
     public static let netHostPort = "net.host.port"
+    /// - See: NetAttributes
     public static let netHostName = "net.host.name"
 }
 

Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+PeerSemantics.swift

@@ -14,6 +14,7 @@
 import TracingInstrumentation
 
 extension SpanAttributeName {
+    /// - See: PeerAttributes
     public static let peerService = "peer.service"
 }