Final restructuring cleanup (#158)

open-telemetry · Jul 5, 2023 · ded7a09 · ded7a09
1 parent 37f38fe
commit ded7a09
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 43 deletions.
diff --git a/specification/README.md b/specification/README.md
@@ -6,22 +6,23 @@ The benefit to using Semantic Conventions is in following a common naming scheme
 
 Semantic Conventions are defined for the following areas:
 
-* [General](general/README.md): General Semantic Conventions.
-* [Exceptions](exceptions/README.md): Semantic Conventions for Exceptions.
-* [FaaS](faas/README.md): Semantic Conventions for Function as a Service (FaaS) operations.
+* **[General](general/README.md): General Semantic Conventions**.
 * [CloudEvents](cloudevents/README.md): Semantic Conventions for the CloudEvents specification.
-* [Feature Flags](http/README.md): Semantic Conventions for feature flag evaluations.
-* [HTTP](http/README.md): Semantic Conventions for HTTP client and server operations.
+* [Cloud Providers](cloud-providers/README.md): Semantic Conventions for cloud providers libraries.
 * [Database](database/README.md): Semantic Conventions for database operations.
+* [Exceptions](exceptions/README.md): Semantic Conventions for exceptions.
+* [FaaS](faas/README.md): Semantic Conventions for Function as a Service (FaaS) operations.
+* [Feature Flags](http/README.md): Semantic Conventions for feature flag evaluations.
+* [HTTP](feature-flags/README.md): Semantic Conventions for HTTP client and server operations.
+* [Messaging](messaging/README.md): Semantic Conventions for messaging operations and systems.
+* [Object Stores](object-stores/README.md): Semantic Conventions for object stores operations.
 * [RPC](rpc/README.md): Semantic Conventions for RPC client and server operations.
-* [Messaging](messaging/README.md): Semantic Conventions for Messaging operations and systems.
 * [System](system/README.md): System Semantic Conventions.
-* *Other areas can be found in the signal specific Semantic Conventions below*
 
 Semantic Conventions by signals:
 
+* [Events](general/events-general.md): Semantic Conventions for event data.
+* [Logs](general/logs-general.md): Semantic Conventions for logs data.
+* [Metrics](general/metrics-general.md): Semantic Conventions for metrics.
 * [Resource](resource/semantic_conventions/README.md): Semantic Conventions for resources.
 * [Trace](general/trace-general.md): Semantic Conventions for traces and spans.
-* [Metrics](general/metrics-general.md): Semantic Conventions for metrics.
-* [Logs](general/logs-general.md): Semantic Conventions for logs data.
-* [Events](general/events-general.md): Semantic Conventions for event data.
diff --git a/specification/general/README.md b/specification/general/README.md
@@ -4,11 +4,11 @@ This document defines general Semantic Conventions for spans, metrics, logs and
 
 The following general Semantic Conventions are defined:
 
-* [General attributes](general-attributes.md): General semantic attributes.
-* [Spans](trace-general.md): General Semantic Conventions for traces / spans.
-* [Metrics](metrics-general.md): General Semantic Conventions for metrics.
-* [Logs](logs-general.md): General Semantic Conventions for logs.
+* **[General attributes](general-attributes.md): General semantic attributes**.
 * [Events](events-general.md): General Semantic Conventions for events.
+* [Logs](logs-general.md): General Semantic Conventions for logs.
+* [Metrics](metrics-general.md): General Semantic Conventions for metrics.
+* [Spans](trace-general.md): General Semantic Conventions for traces / spans.
 
 ## Event Name Reuse Prohibition
 

diff --git a/specification/general/events-general.md b/specification/general/events-general.md
@@ -7,7 +7,7 @@ in the data model by `LogRecord`s.
 
 The following semantic conventions for events are defined:
 
-* [General](#general-event-attributes): General semantic attributes that may be used in describing Events.
+* **[General](#general-event-attributes): General semantic attributes that may be used in describing Events.**
 * [Exceptions](/specification/exceptions/exceptions-logs.md): Semantic attributes that may be used in describing exceptions as events.
 
 ## General event attributes

diff --git a/specification/general/logs-general.md b/specification/general/logs-general.md
@@ -18,7 +18,7 @@ They may be used in any Log Record they apply to.
 
 The following semantic conventions for logs are defined:
 
-* [General](#general-log-identification-attributes): General semantic attributes that may be used in describing Log Records.
+* **[General](#general-log-identification-attributes): General semantic attributes that may be used in describing Log Records.**
 * [Exceptions](/specification/exceptions/exceptions-logs.md): Semantic attributes that may be used in describing exceptions in logs.
 * [Feature Flags](/specification/feature-flags/feature-flags-logs.md): Semantic attributes that may be used in describing feature flag evaluations in logs.
 

diff --git a/specification/general/metrics-general.md b/specification/general/metrics-general.md
@@ -19,10 +19,11 @@
 
 The following semantic conventions surrounding metrics are defined:
 
-* [HTTP](/specification/http/http-metrics.md): For HTTP client and server metrics.
-* [RPC](/specification/rpc/rpc-metrics.md): For RPC client and server metrics.
+* **[General Guidelines](#general-guidelines): General metrics guidelines.**
 * [Database](/specification/database/database-metrics.md): For SQL and NoSQL client metrics.
 * [FaaS](/specification/faas/faas-metrics.md): For [Function as a Service](https://en.wikipedia.org/wiki/Function_as_a_service) metrics.
+* [HTTP](/specification/http/http-metrics.md): For HTTP client and server metrics.
+* [RPC](/specification/rpc/rpc-metrics.md): For RPC client and server metrics.
 * **System metrics**
   * [System](/specification/system/system-metrics.md): For standard system metrics.
   * [Hardware](/specification/system/hardware-metrics.md): For hardware-related metrics.

diff --git a/specification/general/trace-general.md b/specification/general/trace-general.md
@@ -15,20 +15,18 @@ can still be easily correlated and cross-analyzed.
 
 The following semantic conventions for spans are defined:
 
-* [General](general-attributes.md): General semantic attributes that may be used in describing different kinds of operations.
-* [HTTP](/specification/http/http-spans.md): For HTTP client and server spans.
+* **[General](general-attributes.md): General semantic attributes that may be used in describing different kinds of operations.**
+* [Compatibility](trace-compatibility.md): For spans generated by compatibility components, e.g. OpenTracing Shim layer.
+* [CloudEvents](/specification/cloudevents/README.md): Semantic Conventions for the CloudEvents spans.
+* [Cloud Providers](/specification/cloud-providers/README.md): Semantic Conventions for cloud providers spans.
 * [Database](/specification/database/database-spans.md): For SQL and NoSQL client call spans.
-* [RPC/RMI](/specification/rpc/rpc-spans.md): For remote procedure call (e.g., gRPC) spans.
-* [Messaging](/specification/messaging/messaging-spans.md): For messaging systems (queues, publish/subscribe, etc.) spans.
-* [FaaS](/specification/faas/faas-spans.md): For [Function as a Service](https://en.wikipedia.org/wiki/Function_as_a_service) (e.g., AWS Lambda) spans.
 * [Exceptions](/specification/exceptions/exceptions-spans.md): For recording exceptions associated with a span.
-* [Compatibility](trace-compatibility.md): For spans generated by compatibility components, e.g. OpenTracing Shim layer.
+* [FaaS](/specification/faas/faas-spans.md): For [Function as a Service](https://en.wikipedia.org/wiki/Function_as_a_service) (e.g., AWS Lambda) spans.
 * [Feature Flags](/specification/feature-flags/feature-flags-spans.md): For recording feature flag evaluations associated with a span.
-
-The following library-specific semantic conventions are defined:
-
-* [AWS Lambda](/specification/faas/aws-lambda.md): For AWS Lambda spans.
-* [AWS SDK](/specification/cloud-providers/aws-sdk.md): For AWS SDK spans.
+* [HTTP](/specification/http/http-spans.md): For HTTP client and server spans.
+* [Messaging](/specification/messaging/messaging-spans.md): For messaging systems (queues, publish/subscribe, etc.) spans.
+* [Object Stores](/specification/object-stores/README.md): Semantic Conventions for object stores spans.
+* [RPC/RMI](/specification/rpc/rpc-spans.md): For remote procedure call (e.g., gRPC) spans.
 
 Apart from semantic conventions for traces, [metrics](metrics-general.md), [logs](logs-general.md), and [events](events-general.md),
 OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.21.0/specification/resource/sdk.md) with their own

diff --git a/specification/logs/semantic_conventions/README.md b/specification/logs/semantic_conventions/README.md
diff --git a/specification/metrics/semantic_conventions/README.md b/specification/metrics/semantic_conventions/README.md
diff --git a/specification/trace/semantic_conventions/README.md b/specification/trace/semantic_conventions/README.md