From f8aa85c535b746d7508e9bb1c17db94e331f8f9a Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Sat, 28 Dec 2024 10:30:02 -0800 Subject: [PATCH] changelog and lint --- .chloggen/1716.yaml | 4 ++++ docs/database/database-spans.md | 2 -- docs/gen-ai/gen-ai-spans.md | 1 + docs/messaging/messaging-spans.md | 1 + docs/rpc/rpc-spans.md | 1 + 5 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .chloggen/1716.yaml diff --git a/.chloggen/1716.yaml b/.chloggen/1716.yaml new file mode 100644 index 0000000000..1044d68c14 --- /dev/null +++ b/.chloggen/1716.yaml @@ -0,0 +1,4 @@ +change_type: enhancement +component: docs, db +note: Add common guidance on recording errors on spans and metrics, clarify DB conventions. +issues: [1536, 1716] diff --git a/docs/database/database-spans.md b/docs/database/database-spans.md index 7b79747434..c291e36503 100644 --- a/docs/database/database-spans.md +++ b/docs/database/database-spans.md @@ -12,7 +12,6 @@ linkTitle: Client Calls - [Name](#name) - [Status](#status) - - [Recording exception events](#recording-exception-events) - [Common attributes](#common-attributes) - [Notes and well-known identifiers for `db.system`](#notes-and-well-known-identifiers-for-dbsystem) - [Sanitization of `db.query.text`](#sanitization-of-dbquerytext) @@ -418,4 +417,3 @@ More specific Semantic Conventions are defined for the following database techno * [SQL](sql.md): Semantic Conventions for *SQL* databases. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status -[SpanStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.39.0/specification/trace/api.md#set-status diff --git a/docs/gen-ai/gen-ai-spans.md b/docs/gen-ai/gen-ai-spans.md index 358e225c3a..eea7ff1bad 100644 --- a/docs/gen-ai/gen-ai-spans.md +++ b/docs/gen-ai/gen-ai-spans.md @@ -11,6 +11,7 @@ linkTitle: Generative AI traces - [Name](#name) + - [Status](#status) - [GenAI attributes](#genai-attributes) - [Capturing inputs and outputs](#capturing-inputs-and-outputs) diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md index bfab30f4b3..440cb2e3f0 100644 --- a/docs/messaging/messaging-spans.md +++ b/docs/messaging/messaging-spans.md @@ -22,6 +22,7 @@ - [Span name](#span-name) - [Operation types](#operation-types) - [Span kind](#span-kind) + - [Span status](#span-status) - [Trace structure](#trace-structure) - [Producer spans](#producer-spans) - [Consumer spans](#consumer-spans) diff --git a/docs/rpc/rpc-spans.md b/docs/rpc/rpc-spans.md index bdf82f7904..d6940b92c3 100644 --- a/docs/rpc/rpc-spans.md +++ b/docs/rpc/rpc-spans.md @@ -15,6 +15,7 @@ This document defines how to describe remote procedure calls - [Common remote procedure call conventions](#common-remote-procedure-call-conventions) - [Span name](#span-name) + - [Span status](#span-status) - [Service name](#service-name) - [Client attributes](#client-attributes) - [Server attributes](#server-attributes)