From 6255dda2dfaa8c446ffc8cdba9ceb29b9f9b38b9 Mon Sep 17 00:00:00 2001 From: Laurent Tardif Date: Tue, 23 Jan 2024 21:16:07 +0100 Subject: [PATCH] typo with < & > in github md --- devops/OpenTelemetry/OpenTelemery.md | 23 +++++++++---------- .../OpenTelemetry/OpenTelermetryOneTable.md | 4 ++-- 2 files changed, 13 insertions(+), 14 deletions(-) diff --git a/devops/OpenTelemetry/OpenTelemery.md b/devops/OpenTelemetry/OpenTelemery.md index ae94cec..521ae89 100644 --- a/devops/OpenTelemetry/OpenTelemery.md +++ b/devops/OpenTelemetry/OpenTelemery.md @@ -44,8 +44,8 @@ doc : https://opentelemetry.io/docs/specs/semconv/attributes-registry/ |container.image.id|string|Runtime specific image identifier. Usually a hash algorithm followed by a UUID. [2]|sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f| |*container.image.name*|string|Name of the image the container was built on.|gcr.io/opentelemetry/operator| |*container.image.repo_digests*|string[]|Repo digests of the container image as provided by the container runtime. [3]|[example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb, internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578]| -|*container.image.tags*|string[]|Container image tags. An example can be found in Docker Image Inspect. Should be only the section of the full name for example from registry.example.com/my-org/my-image:.|[v1.27.1, 3.5.7-0]| -|*container.labels.*|string|Container labels, being the label name, the value being the label value.|container.labels.app=nginx +|*container.image.tags*|string[]|Container image tags. An example can be found in Docker Image Inspect. Should be only the <tag> section of the full name for example from registry.example.com/my-org/my-image:<tag>.|[v1.27.1, 3.5.7-0]| +|*container.labels.<key>*|string|Container labels, <key> being the label name, the value being the label value.|container.labels.app=nginx |*container.name*|string|Container name used by container runtime.|opentelemetry-autoconf| |*container.runtime*|string|The container runtime managing this container.|docker; containerd; rkt| @@ -93,7 +93,7 @@ Attribute |Type |Description |Examples |--------------|-----------|------------|------------| |db.elasticsearch.cluster.name |string |Represents the identifier of an Elasticsearch cluster. |e9106fc68e3044f0b1475b04bf4ffd5f| |db.elasticsearch.node.name |string |Represents the human-readable identifier of the node/instance to which a request was routed. |instance-0000000001| -|db.elasticsearch.path_parts. |string |A dynamic value in the url path. [1] |db.elasticsearch.path_parts.index=test-index; db.elasticsearch.path_parts.doc_id=123| +|db.elasticsearch.path_parts.<key> |string |A dynamic value in the url path. [1] |db.elasticsearch.path_parts.index=test-index; db.elasticsearch.path_parts.doc_id=123| ## JDBC Attributes @@ -156,7 +156,6 @@ These attributes may be used to describe the receiver of a network exchange/pack |--------------|-----------|------------|------------| |error.type|string|Stable |Describes a class of error the operation ended with. [1]|timeout; java.net.UnknownHostException;| - # Exception Attributes |Attribute|Type|Description|Examples| @@ -191,12 +190,12 @@ exception.stacktrace|string|A stacktrace as a string in the natural representati |Attribute|Type|Description|Examples| |--------------|-----------|------------|------------| |http.request.body.size|int|The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size.|3495| -|http.request.header.|string[]|Stable|HTTP request headers, being the normalized HTTP Header name (lowercase), the value being the header values. [1]|http.request.header.content-type=["application/json"]; http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"]| +|http.request.header.<key>|string[]|Stable|HTTP request headers, <key> being the normalized HTTP Header name (lowercase), the value being the header values. [1]|http.request.header.content-type=["application/json"]; http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"]| |http.request.method|string|Stable|HTTP request method. [2]|GET; POST; HEAD| |http.request.method_original|string|Stable|Original HTTP method sent by the client in the request line.|GeT; ACL; foo| |http.request.resend_count|int|Stable|The ordinal number of request resending attempt (for any reason, including redirects). [3]|3| |http.response.body.size|int|The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size.|3495| -|http.response.header.|string[]|Stable|HTTP response headers, being the normalized HTTP Header name (lowercase), the value being the header values. [4]|http.response.header.content-type=["application/json"]; http.response.header.my-custom-header=["abc", "def"]| +|http.response.header.<key>|string[]|Stable|HTTP response headers, <key> being the normalized HTTP Header name (lowercase), the value being the header values. [4]|http.response.header.content-type=["application/json"]; http.response.header.my-custom-header=["abc", "def"]| |http.response.status_code|int|Stable|HTTP response status code.|200| |http.route|string|Stable|The matched route, that is, the path template in the format used by the respective server framework. [5]|/users/:userID?; {controller}/{action}/{id?}| @@ -238,8 +237,8 @@ http.flavor has the following list of well-known values. If one of them applies, |k8s.namespace.name|string|The name of the namespace that the pod is running in.|default| |k8s.node.name|string|The name of the Node.|node-1| |k8s.node.uid|string|The UID of the Node.|1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2| -|k8s.pod.annotation.|string|The annotation key-value pairs placed on the Pod, the being the annotation name, the value being the annotation value.|k8s.pod.annotation.kubernetes.io/enforce-mountable-secrets=true; k8s.pod.annotation.mycompany.io/arch=x64; k8s.pod.annotation.data=| -|k8s.pod.labels.|string|The labels placed on the Pod, the being the label name, the value being the label value.|k8s.pod.labels.app=my-app; k8s.pod.labels.mycompany.io/arch=x64; k8s.pod.labels.data=| +|k8s.pod.annotation.<key>|string|The annotation key-value pairs placed on the Pod, the <key> being the annotation name, the value being the annotation value.|k8s.pod.annotation.kubernetes.io/enforce-mountable-secrets=true; k8s.pod.annotation.mycompany.io/arch=x64; k8s.pod.annotation.data=| +|k8s.pod.labels.<key>|string|The labels placed on the Pod, the <key> being the label name, the value being the label value.|k8s.pod.labels.app=my-app; k8s.pod.labels.mycompany.io/arch=x64; k8s.pod.labels.data=| |k8s.pod.name|string|The name of the Pod.|opentelemetry-pod-autoconf| |k8s.pod.uid|string|The UID of the Pod.|275ecb36-5aa8-4c2a-9c47-d8bb681b9aff| |k8s.replicaset.name|string|The name of the ReplicaSet.|opentelemetry| @@ -343,10 +342,10 @@ RPC attributes are intended to be used in the context of events related to remot |Attribute|Type|Description|Examples| |--------------|-----------|------------|------------| |rpc.connect_rpc.error_code|string|The error codes of the Connect request. Error codes are always string values.|cancelled| -|rpc.connect_rpc.request.metadata.|string[]|Connect request metadata, being the normalized Connect Metadata key (lowercase), the value being the metadata values. [1]|rpc.request.metadata.my-custom-metadata-attribute=["1.2.3.4", "1.2.3.5"]| -|rpc.connect_rpc.response.metadata.|string[]|Connect response metadata, being the normalized Connect Metadata key (lowercase), the value being the metadata values. [2]|rpc.response.metadata.my-custom-metadata-attribute=["attribute_value"]| -|rpc.grpc.request.metadata.|string[]|gRPC request metadata, being the normalized gRPC Metadata key (lowercase), the value being the metadata values. [3]|rpc.grpc.request.metadata.my-custom-metadata-attribute=["1.2.3.4", "1.2.3.5"]| -|rpc.grpc.response.metadata.|string[]|gRPC response metadata, being the normalized gRPC Metadata key (lowercase), the value being the metadata values. [4]|rpc.grpc.response.metadata.my-custom-metadata-attribute=["attribute_value"]| +|rpc.connect_rpc.request.metadata.<key>|string[]|Connect request metadata, <key> being the normalized Connect Metadata key (lowercase), the value being the metadata values. [1]|rpc.request.metadata.my-custom-metadata-attribute=["1.2.3.4", "1.2.3.5"]| +|rpc.connect_rpc.response.metadata.<key>|string[]|Connect response metadata, <key> being the normalized Connect Metadata key (lowercase), the value being the metadata values. [2]|rpc.response.metadata.my-custom-metadata-attribute=["attribute_value"]| +|rpc.grpc.request.metadata.<key>|string[]|gRPC request metadata, <key> being the normalized gRPC Metadata key (lowercase), the value being the metadata values. [3]|rpc.grpc.request.metadata.my-custom-metadata-attribute=["1.2.3.4", "1.2.3.5"]| +|rpc.grpc.response.metadata.<key>|string[]|gRPC response metadata, <key> being the normalized gRPC Metadata key (lowercase), the value being the metadata values. [4]|rpc.grpc.response.metadata.my-custom-metadata-attribute=["attribute_value"]| |rpc.grpc.status_code|int|The numeric status code of the gRPC request.|0| |rpc.jsonrpc.error_code|int|error.code property of response if it is an error response.|-32700; 100| |rpc.jsonrpc.error_message|string|error.| of response if it is an error response.|Parse error; User already exists| diff --git a/devops/OpenTelemetry/OpenTelermetryOneTable.md b/devops/OpenTelemetry/OpenTelermetryOneTable.md index ac4bd03..872842e 100644 --- a/devops/OpenTelemetry/OpenTelermetryOneTable.md +++ b/devops/OpenTelemetry/OpenTelermetryOneTable.md @@ -104,7 +104,7 @@ exception.stacktrace|string|A stacktrace as a string in the natural representati |http.scheme|string|Deprecated|Deprecated, use url.scheme instead.|http; https| |http.status_code|int|Deprecated|Deprecated, use http.response.status_code instead.|200| |http.target|string|Deprecated|Deprecated, use url.path and url.query instead.|/search?q=OpenTelemetry#SemConv| -|http.url|string|Deprecated|Deprecated, use url.full instead.|https://www.foo.bar/search?q=OpenTelemetry#SemConv| +|http.url|string|Deprecated|Deprecated, use url.full instead.|| |http.user_agent|string|Deprecated|Deprecated, use user_agent.original instead.|CERN-LineMode/2.15 libwww/2.17b3; Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1| |k8s.cluster.name|string|The name of the cluster.|opentelemetry-cluster| |k8s.cluster.uid|string|A pseudo-ID for the cluster, set to the UID of the kube-system namespace. [1]|218fc5a9-a5f1-4b54-aa05-46717d0ab26d| @@ -240,7 +240,7 @@ process.pid|int|Process identifier (PID).|1234| |tls.server.not_before|string|Date/Time indicating when server certificate is first considered valid.|1970-01-01T00:00:00.000Z| |tls.server.subject|string|Distinguished name of subject of the x.509 certificate presented by the server.|CN=myserver, OU=Documentation Team, DC=example, DC=com| |url.fragment|string|Stable|The URI fragment component|SemConv| -|url.full|string|Stable|Absolute URL describing a network resource according to RFC3986 [1]|https://www.foo.bar/search?q=OpenTelemetry#SemConv; //localhost| +|url.full|string|Stable|Absolute URL describing a network resource according to RFC3986 [1]|; //localhost| |url.path|string|Stable|The URI path component|/search| |url.query|string|Stable|The URI query component [2]|q=OpenTelemetry| |url.scheme|string|Stable|The URI scheme component identifying the used protocol.|https; ftp; telnet|