From 736f85986160a513cb5d51b782bd0bbdba00cae4 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 27 Jan 2025 07:53:26 -0800 Subject: [PATCH] Fix links (#1814) Co-authored-by: Liudmila Molkova --- docs/exceptions/exceptions-logs.md | 2 +- docs/gen-ai/gen-ai-events.md | 4 ++-- docs/general/events.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/exceptions/exceptions-logs.md b/docs/exceptions/exceptions-logs.md index 38f3643f72..69028af2cd 100644 --- a/docs/exceptions/exceptions-logs.md +++ b/docs/exceptions/exceptions-logs.md @@ -7,7 +7,7 @@ linkTitle: Logs **Status**: [Stable][DocumentStatus] This document defines semantic conventions for recording exceptions on -[logs](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/specification/logs/api.md#emit-a-logrecord) and [events](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/specification/logs/api.md#emit-an-event) +[logs](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/specification/logs/api.md#emit-a-logrecord) emitted through the [Logger API](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/specification/logs/api.md#logger). diff --git a/docs/gen-ai/gen-ai-events.md b/docs/gen-ai/gen-ai-events.md index d237b398a5..3b91ec5112 100644 --- a/docs/gen-ai/gen-ai-events.md +++ b/docs/gen-ai/gen-ai-events.md @@ -23,10 +23,10 @@ linkTitle: Generative AI events -GenAI instrumentations MAY capture user inputs sent to the model and responses received from it as [events](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/specification/logs/api.md#emit-an-event). +GenAI instrumentations MAY capture user inputs sent to the model and responses received from it as [events](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.41.0/specification/logs/data-model.md#events). > Note: -> Event API is experimental and not yet available in some languages. Check [spec-compliance matrix](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/spec-compliance-matrix.md#logs) to see the implementation status in corresponding language. +> Events are experimental and not yet available in some languages. Check [spec-compliance matrix](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/spec-compliance-matrix.md#logs) to see the implementation status in corresponding language. Instrumentations MAY capture inputs and outputs if and only if application has enabled the collection of this data. This is for three primary reasons: diff --git a/docs/general/events.md b/docs/general/events.md index 87ad5c8629..05008881b3 100644 --- a/docs/general/events.md +++ b/docs/general/events.md @@ -50,7 +50,7 @@ Recommendations for defining events: collection of [standard](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/specification/common#attribute) attributes. * Events SHOULD be generated / produced / recorded using the - [Emit Event API](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/specification/logs/api.md#emit-an-event) + [Log API](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/specification/logs/api.md#emit-a-logrecord) to ensure that the event is created using the configured SDK instance. * The Emit Event API is not yet available in all OpenTelemetry SDKs. Check [spec-compliance matrix](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/spec-compliance-matrix.md#logs) to see the implementation status in corresponding language. * It's NOT RECOMMENDED to prefix the _payload_ (body) _fields_ with the `EventName` to