Skip to content

Commit

Permalink
feat: Document net and network stable attributes
Browse files Browse the repository at this point in the history
resolves #21
  • Loading branch information
AbhiPrasad committed Nov 29, 2024
1 parent 024957f commit 2d6b29b
Show file tree
Hide file tree
Showing 25 changed files with 264 additions and 6 deletions.
14 changes: 14 additions & 0 deletions model/trace/net/net__host__ip.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.host.ip",
"brief": "Local address of the network connection - IP address or Unix domain socket name.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "192.168.0.1",
"deprecation": {
"replacement": "network.local.address"
},
"alias": ["network.local.address"]
}
14 changes: 14 additions & 0 deletions model/trace/net/net__host__name.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.host.name",
"brief": "Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "example.com",
"deprecation": {
"replacement": "server.address"
},
"alias": ["server.address"]
}
2 changes: 1 addition & 1 deletion model/trace/net/net__host__port.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@
"deprecation": {
"replacement": "server.port"
},
"alias": ["server.port", "url.port"]
"alias": ["server.port"]
}
14 changes: 14 additions & 0 deletions model/trace/net/net__peer__ip.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.peer.ip",
"brief": "Peer address of the network connection - IP address or Unix domain socket name.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "192.168.0.1",
"deprecation": {
"replacement": "network.peer.address"
},
"alias": ["network.peer.address"]
}
14 changes: 14 additions & 0 deletions model/trace/net/net__peer__name.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.peer.name",
"brief": "Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "example.com",
"deprecation": {
"replacement": "server.address",
"reason": "Deprecated, use server.address on client spans and client.address on server spans."
}
}
14 changes: 14 additions & 0 deletions model/trace/net/net__peer__port.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.peer.port",
"brief": "Peer port number.",
"type": "integer",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": 1337,
"deprecation": {
"replacement": "server.port",
"reason": "Deprecated, use server.port on client spans and client.port on server spans."
}
}
14 changes: 14 additions & 0 deletions model/trace/net/net__protocol__name.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.protocol.name",
"brief": "OSI application layer or non-OSI equivalent.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "http",
"deprecation": {
"replacement": "network.protocol.name"
},
"alias": ["network.protocol.name"]
}
14 changes: 14 additions & 0 deletions model/trace/net/net__protocol_version.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.protocol.version",
"brief": "The actual version of the protocol used for network communication.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "1.1",
"deprecation": {
"replacement": "network.protocol.version"
},
"alias": ["network.protocol.version"]
}
14 changes: 14 additions & 0 deletions model/trace/net/net__sock__family.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.protocol.name",
"brief": "OSI transport and network layer",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "inet",
"deprecation": {
"replacement": "network.transport",
"reason": "Deprecated, use network.transport and network.type."
}
}
14 changes: 14 additions & 0 deletions model/trace/net/net__sock__host__addr.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.sock.host.addr",
"brief": "Local address of the network connection mapping to Unix domain socket name.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "/var/my.sock",
"deprecation": {
"replacement": "network.local.address"
},
"alias": ["network.local.address"]
}
14 changes: 14 additions & 0 deletions model/trace/net/net__sock__host__port.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.sock.host.port",
"brief": "Local port number of the network connection.",
"type": "integer",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": 8080,
"deprecation": {
"replacement": "network.local.port"
},
"alias": ["network.local.port"]
}
14 changes: 14 additions & 0 deletions model/trace/net/net__sock__peer__addr.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.sock.peer.addr",
"brief": "Peer address of the network connection - IP address",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "192.168.0.1",
"deprecation": {
"replacement": "network.peer.address"
},
"alias": ["network.peer.address"]
}
13 changes: 13 additions & 0 deletions model/trace/net/net__sock__peer__port.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"key": "net.sock.peer.port",
"brief": "Peer port number of the network connection.",
"type": "integer",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": 8080,
"deprecation": {
"replacement": "network.peer.port"
}
}
14 changes: 14 additions & 0 deletions model/trace/net/net__sock__peer_name.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.sock.peer.name",
"brief": "Peer address of the network connection - Unix domain socket name",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "/var/my.sock",
"deprecation": {
"replacement": "",
"reason": "Deprecated, no replacement at this time"
}
}
14 changes: 14 additions & 0 deletions model/trace/net/net__transport.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"key": "net.transport",
"brief": "OSI transport layer or inter-process communication method.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "tcp",
"deprecation": {
"replacement": "network.transport"
},
"alias": ["network.transport"]
}
11 changes: 11 additions & 0 deletions model/trace/network/network__local__address.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"key": "network.local.address",
"brief": "Local address of the network connection - IP address or Unix domain socket name.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "10.1.2.80",
"alias": ["net.host.ip", "net.sock.host.addr"]
}
11 changes: 11 additions & 0 deletions model/trace/network/network__local__port.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"key": "network.local.port",
"brief": "Local port number of the network connection.",
"type": "integer",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": 65400,
"alias": ["net.sock.host.port"]
}
10 changes: 10 additions & 0 deletions model/trace/network/network__peer__address.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"key": "network.peer.address",
"brief": "Peer address of the network connection - IP address or Unix domain socket name.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "10.1.2.80"
}
10 changes: 10 additions & 0 deletions model/trace/network/network__peer__port.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"key": "network.peer.port",
"brief": "Peer port number of the network connection.",
"type": "integer",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": 65400
}
3 changes: 2 additions & 1 deletion model/trace/network/network__protocol__name.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@
"key": "false"
},
"is_in_otel": true,
"example": "http"
"example": "http",
"alias": ["net.protocol.name"]
}
2 changes: 1 addition & 1 deletion model/trace/network/network__protocol__version.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
},
"is_in_otel": true,
"example": "1.1",
"alias": ["http.flavor"]
"alias": ["http.flavor", "net.protocol.version"]
}
11 changes: 11 additions & 0 deletions model/trace/network/network__transport.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"key": "network.transport",
"brief": "OSI transport layer or inter-process communication method.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "tcp",
"alias": ["net.transport"]
}
10 changes: 10 additions & 0 deletions model/trace/network/network__type.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"key": "network.type",
"brief": "OSI network layer or non-OSI equivalent.",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": true,
"example": "ipv4"
}
2 changes: 1 addition & 1 deletion model/trace/server/server__address.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
},
"is_in_otel": true,
"example": "example.com",
"alias": ["http.server_name"]
"alias": ["http.server_name", "net.host.name"]
}
3 changes: 1 addition & 2 deletions model/trace/url/url__port.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,5 @@
"key": "false"
},
"is_in_otel": true,
"example": 1337,
"alias": ["net.host.port"]
"example": 1337
}

0 comments on commit 2d6b29b

Please sign in to comment.