feat: Add support for event body fields (#297)

* feat: Add support for event body fields

* feat: Add event body spec to schema files

* - address review comments

* Update body definition to include
- type
- brief
- note
- stability
- examples

* Refactor Body to AnyValue

* Remove allow_custom_values, deprecated and type_display

* remove resolved and resolver `any_value.rs` just use AnyValueSpec in resolved schema
- simplify validate_any_value_examples
- Reduce the test yaml events to smaller set
- Removed observed file

* remove UnresolvedBody error and update ChangeLog.md

.gitignore

@@ -15,6 +15,9 @@ just.zsh
 .vscode/
 .devcontainer/
 
+# Visual Studio
+.vs/
+
 # Emacs
 *~
 \#*\#

CHANGELOG.md

@@ -10,6 +10,7 @@ What's changed
 * Add `enforce_trailing_dots` into the `comment_formats` configuration. ([#XXX](...) by lquerel).
 * Add support for `indent_type` in both the comment filter and the `comment_formats` configuration. ([#XXX](...) by lquerel).
 * Add `regex_replace` filter to support replacing text using regex. ([#XXX](...) by lquerel).
+* Add support log based `event` definitions with a `body` of new `AnyValue` type. ([#XXX](...) by MSNev).
 
 ## [0.9.2] - 2024-09-09
 

crates/weaver_forge/data/exception.yaml

@@ -0,0 +1,54 @@
+groups:
+  - id: registry.exception
+    type: attribute_group
+    prefix: exception
+    brief: >
+      This document defines the shared attributes used to
+      report a single exception associated with a span or log.
+    attributes:
+      - id: type
+        type: string
+        stability: stable
+        brief: >
+          The type of the exception (its fully-qualified class name, if applicable).
+          The dynamic type of the exception should be preferred over the static type
+          in languages that support it.
+        examples: ["java.net.ConnectException", "OSError"]
+      - id: message
+        type: string
+        stability: stable
+        brief: The exception message.
+        examples: ["Division by zero", "Can't convert 'int' object to str implicitly"]
+      - id: stacktrace
+        type: string
+        stability: stable
+        brief: >
+          A stacktrace as a string in the natural representation for the language runtime.
+          The representation is to be determined and documented by each language SIG.
+        examples: 'Exception in thread "main" java.lang.RuntimeException: Test exception\n
+        at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n
+        at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n
+        at com.example.GenerateTrace.main(GenerateTrace.java:5)'
+      - id: escaped
+        type: boolean
+        stability: stable
+        brief: >
+          SHOULD be set to true if the exception event is recorded at a point where
+          it is known that the exception is escaping the scope of the span.
+        note: |-
+          An exception is considered to have escaped (or left) the scope of a span,
+          if that span is ended while the exception is still logically "in flight".
+          This may be actually "in flight" in some languages (e.g. if the exception
+          is passed to a Context manager's `__exit__` method in Python) but will
+          usually be caught at the point of recording the exception in most languages.
+
+          It is usually not possible to determine at the point where an exception is thrown
+          whether it will escape the scope of a span.
+          However, it is trivial to know that an exception
+          will escape, if one checks for an active exception just before ending the span,
+          as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception).
+
+          It follows that an exception may still escape the scope of the span
+          even if the `exception.escaped` attribute was not set or set to false,
+          since the event might have been recorded at a time where it was not
+          clear whether the exception will escape.

crates/weaver_forge/data/mobile-events.yaml

@@ -1,21 +1,29 @@
 groups:
-  - id: ios.lifecycle.events
+  - id: device.app.lifecycle
+    stability: experimental
     type: event
-    prefix: ios
     name: device.app.lifecycle
     brief: >
-      This event represents an occurrence of a lifecycle transition on the iOS platform.
-    attributes:
-      - id: state
-        stability: experimental
-        requirement_level: "required"
-        note: >
-          The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902),
-          and from which the `OS terminology` column values are derived.
-        brief: >
-          This attribute represents the state the application has transitioned into at the occurrence of the event.
-        type:
-          allow_custom_values: false
+      This event represents an occurrence of a lifecycle transition on Android or iOS platform.
+    note: >
+      This event identifies the fields that are common to all lifecycle events for android and iOS using
+      the `android.state` and `ios.state` fields. The `android.state` and `ios.state` attributes are
+      mutually exclusive.
+    body:
+      type: map
+      id: device.app.lifecycle.fields
+      requirement_level: required
+      fields:
+        - id: ios.state
+          stability: experimental
+          requirement_level:
+            conditionally_required: if and only if `os.name` is `ios`
+          note: >
+            The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902),
+            and from which the `OS terminology` column values are derived.
+          brief: >
+            This attribute represents the state the application has transitioned into at the occurrence of the event.
+          type: enum
           members:
             - id: active
               value: 'active'
@@ -39,23 +47,16 @@ groups:
               value: 'terminate'
               brief: >
                 The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`.
-  - id: android.lifecycle.events
-    type: event
-    prefix: android
-    name: device.app.lifecycle
-    brief: >
-      This event represents an occurrence of a lifecycle transition on the Android platform.
-    attributes:
-      - id: state
-        stability: experimental
-        requirement_level: required
-        brief: >
-          This attribute represents the state the application has transitioned into at the occurrence of the event.
-        note: >
-          The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc),
-          and from which the `OS identifiers` are derived.
-        type:
-          allow_custom_values: false
+        - id: android.state
+          stability: experimental
+          requirement_level:
+            conditionally_required: if and only if `os.name` is `android`
+          brief: >
+            This attribute represents the state the application has transitioned into at the occurrence of the event.
+          note: >
+            The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc),
+            and from which the `OS identifiers` are derived.
+          type: enum
           members:
             - id: created
               value: 'created'

crates/weaver_forge/data/trace-exception.yaml

@@ -0,0 +1,16 @@
+groups:
+  - id: trace-exception
+    prefix: exception
+    type: event
+    brief: >
+      This document defines the attributes used to
+      report a single exception associated with a span.
+    attributes:
+      - ref: exception.type
+        requirement_level:
+          conditionally_required: Required if `exception.message` is not set, recommended otherwise.
+      - ref: exception.message
+        requirement_level:
+          conditionally_required: Required if `exception.type` is not set, recommended otherwise.
+      - ref: exception.stacktrace
+      - ref: exception.escaped

crates/weaver_forge/expected_output/semconv_jq_fn/semconv_events.json

@@ -0,0 +1 @@
+[{"attributes":[],"body":{"fields":[{"brief":"This attribute represents the state the application has transitioned into at the occurrence of the event.\n","id":"ios.state","members":[{"brief":"The app has become `active`. Associated with UIKit notification `applicationDidBecomeActive`.\n","deprecated":null,"id":"active","note":null,"stability":null,"value":"active"},{"brief":"The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`.\n","deprecated":null,"id":"inactive","note":null,"stability":null,"value":"inactive"},{"brief":"The app is now in the background. This value is associated with UIKit notification `applicationDidEnterBackground`.\n","deprecated":null,"id":"background","note":null,"stability":null,"value":"background"},{"brief":"The app is now in the foreground. This value is associated with UIKit notification `applicationWillEnterForeground`.\n","deprecated":null,"id":"foreground","note":null,"stability":null,"value":"foreground"},{"brief":"The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`.\n","deprecated":null,"id":"terminate","note":null,"stability":null,"value":"terminate"}],"note":"The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), and from which the `OS terminology` column values are derived.\n","requirement_level":{"conditionally_required":"if and only if `os.name` is `ios`"},"stability":"experimental","type":"enum"},{"brief":"This attribute represents the state the application has transitioned into at the occurrence of the event.\n","id":"android.state","members":[{"brief":"Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time.\n","deprecated":null,"id":"created","note":null,"stability":null,"value":"created"},{"brief":"Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state.\n","deprecated":null,"id":"background","note":null,"stability":null,"value":"background"},{"brief":"Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states.","deprecated":null,"id":"foreground","note":null,"stability":null,"value":"foreground"}],"note":"The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived.\n","requirement_level":{"conditionally_required":"if and only if `os.name` is `android`"},"stability":"experimental","type":"enum"}],"id":"device.app.lifecycle.fields","requirement_level":"required","type":"map"},"brief":"This event represents an occurrence of a lifecycle transition on Android or iOS platform.\n","event_namespace":"device.app","events":[],"id":"device.app.lifecycle","instrument":null,"lineage":{"source_file":"data/mobile-events.yaml"},"metric_name":null,"name":"device.app.lifecycle","note":"This event identifies the fields that are common to all lifecycle events for android and iOS using the `android.state` and `ios.state` fields. The `android.state` and `ios.state` attributes are mutually exclusive.\n","span_kind":null,"stability":"experimental","type":"event","unit":null},{"attributes":[{"brief":"A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG.\n","examples":"Exception in thread \"main\" java.lang.RuntimeException: Test exception\\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\\n at com.example.GenerateTrace.main(GenerateTrace.java:5)","name":"exception.stacktrace","requirement_level":"recommended","stability":"stable","type":"string"},{"brief":"SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span.\n","name":"exception.escaped","note":"An exception is considered to have escaped (or left) the scope of a span,\nif that span is ended while the exception is still logically \"in flight\".\nThis may be actually \"in flight\" in some languages (e.g. if the exception\nis passed to a Context manager\u0027s `__exit__` method in Python) but will\nusually be caught at the point of recording the exception in most languages.\n\nIt is usually not possible to determine at the point where an exception is thrown\nwhether it will escape the scope of a span.\nHowever, it is trivial to know that an exception\nwill escape, if one checks for an active exception just before ending the span,\nas done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception).\n\nIt follows that an exception may still escape the scope of the span\neven if the `exception.escaped` attribute was not set or set to false,\nsince the event might have been recorded at a time where it was not\nclear whether the exception will escape.","requirement_level":"recommended","stability":"stable","type":"boolean"},{"brief":"The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it.\n","examples":["java.net.ConnectException","OSError"],"name":"exception.type","requirement_level":{"conditionally_required":"Required if `exception.message` is not set, recommended otherwise."},"stability":"stable","type":"string"},{"brief":"The exception message.","examples":["Division by zero","Can\u0027t convert \u0027int\u0027 object to str implicitly"],"name":"exception.message","requirement_level":{"conditionally_required":"Required if `exception.type` is not set, recommended otherwise."},"stability":"stable","type":"string"}],"brief":"This document defines the attributes used to report a single exception associated with a span.\n","event_namespace":"other","events":[],"id":"trace-exception","instrument":null,"lineage":{"attributes":{"exception.escaped":{"inherited_fields":["brief","note","requirement_level","stability"],"source_group":"registry.exception"},"exception.message":{"inherited_fields":["brief","examples","note","stability"],"locally_overridden_fields":["requirement_level"],"source_group":"registry.exception"},"exception.stacktrace":{"inherited_fields":["brief","examples","note","requirement_level","stability"],"source_group":"registry.exception"},"exception.type":{"inherited_fields":["brief","examples","note","stability"],"locally_overridden_fields":["requirement_level"],"source_group":"registry.exception"}},"source_file":"data/trace-exception.yaml"},"metric_name":null,"name":null,"prefix":"exception","span_kind":null,"type":"event","unit":null}]

crates/weaver_forge/expected_output/test/attribute_group/exception.md

@@ -0,0 +1,79 @@
+## Namespace `exception`
+
+### Attributes
+
+
+#### Attribute `exception.escaped`
+
+SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span.
+
+
+An exception is considered to have escaped (or left) the scope of a span,
+if that span is ended while the exception is still logically "in flight".
+This may be actually "in flight" in some languages (e.g. if the exception
+is passed to a Context manager's `__exit__` method in Python) but will
+usually be caught at the point of recording the exception in most languages.
+
+It is usually not possible to determine at the point where an exception is thrown
+whether it will escape the scope of a span.
+However, it is trivial to know that an exception
+will escape, if one checks for an active exception just before ending the span,
+as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception).
+
+It follows that an exception may still escape the scope of the span
+even if the `exception.escaped` attribute was not set or set to false,
+since the event might have been recorded at a time where it was not
+clear whether the exception will escape.
+
+- Requirement Level: Recommended
+
+- Type: boolean
+
+- Stability: Stable
+
+
+#### Attribute `exception.message`
+
+The exception message.
+
+
+- Requirement Level: Recommended
+
+- Type: string
+- Examples: [
+    "Division by zero",
+    "Can't convert 'int' object to str implicitly",
+]
+
+- Stability: Stable
+
+
+#### Attribute `exception.stacktrace`
+
+A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG.
+
+
+- Requirement Level: Recommended
+
+- Type: string
+- Examples: Exception in thread "main" java.lang.RuntimeException: Test exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5)
+
+- Stability: Stable
+
+
+#### Attribute `exception.type`
+
+The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it.
+
+
+- Requirement Level: Recommended
+
+- Type: string
+- Examples: [
+    "java.net.ConnectException",
+    "OSError",
+]
+
+- Stability: Stable
+
+

crates/weaver_forge/expected_output/test/attribute_groups.md

@@ -472,6 +472,89 @@ Username for accessing the database.
 
 
 
+## Namespace `exception`
+
+### Attributes
+
+
+#### Attribute `exception.escaped`
+
+SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span.
+
+
+
+An exception is considered to have escaped (or left) the scope of a span,
+if that span is ended while the exception is still logically "in flight".
+This may be actually "in flight" in some languages (e.g. if the exception
+is passed to a Context manager's `__exit__` method in Python) but will
+usually be caught at the point of recording the exception in most languages.
+
+It is usually not possible to determine at the point where an exception is thrown
+whether it will escape the scope of a span.
+However, it is trivial to know that an exception
+will escape, if one checks for an active exception just before ending the span,
+as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception).
+
+It follows that an exception may still escape the scope of the span
+even if the `exception.escaped` attribute was not set or set to false,
+since the event might have been recorded at a time where it was not
+clear whether the exception will escape.
+
+- Requirement Level: Recommended
+
+- Type: boolean
+
+- Stability: Stable
+
+
+#### Attribute `exception.message`
+
+The exception message.
+
+
+- Requirement Level: Recommended
+
+- Type: string
+- Examples: [
+    "Division by zero",
+    "Can't convert 'int' object to str implicitly",
+]
+
+- Stability: Stable
+
+
+#### Attribute `exception.stacktrace`
+
+A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG.
+
+
+
+- Requirement Level: Recommended
+
+- Type: string
+- Examples: Exception in thread "main" java.lang.RuntimeException: Test exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5)
+
+- Stability: Stable
+
+
+#### Attribute `exception.type`
+
+The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it.
+
+
+
+- Requirement Level: Recommended
+
+- Type: string
+- Examples: [
+    "java.net.ConnectException",
+    "OSError",
+]
+
+- Stability: Stable
+
+
+
 ## Namespace `http`
 
 ### Attributes