Review feedback + update to main

open-telemetry · Nov 18, 2024 · 9774c87 · 9774c87
1 parent b46e567
commit 9774c87
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 18 deletions.
diff --git a/docs/attributes-registry/geo.md b/docs/attributes-registry/geo.md
@@ -11,15 +11,15 @@
 Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied.
 Note: Geo attributes are typically used under another namespace, such as client.\* and describe the location of the corresponding entity (device, end-user, etc). Semantic conventions that reference geo attributes (as a root namespace) or embed them (under their own namespace) SHOULD document what geo attributes describe in the scope of that convention.
 
-| Attribute              | Type   | Description                                                                                                                                                           | Examples             | Stability                                                        |
-| ---------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ---------------------------------------------------------------- |
-| `geo.city.name`        | string | City name.                                                                                                                                                            | `Montreal`; `Berlin` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `geo.continent.code`   | string | Two-letter code representing continent’s name.                                                                                                                        | `AF`; `AN`; `AS`     | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `geo.country.iso_code` | string | Two-letter ISO Country Code ([ISO 3166-1 alpha2](https://en.wikipedia.org/wiki/ISO_3166-1#Codes)).                                                                    | `CA`                 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `geo.location.lat`     | double | Latitude of the geo location in [WGS84](https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84).                                                                   | `45.505918`          | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `geo.location.lon`     | double | Longitude of the geo location in [WGS84](https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84).                                                                  | `-73.61483`          | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `geo.postal_code`      | string | Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. | `94040`              | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `geo.region.iso_code`  | string | Region ISO code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).                                                                                             | `CA-QC`              | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| Attribute                                                                            | Type   | Description                                                                                                                                                           | Examples             | Stability                                                        |
+| ------------------------------------------------------------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ---------------------------------------------------------------- |
+| <a id="geo-continent-code" href="#geo-continent-code">`geo.continent.code`</a>       | string | Two-letter code representing continent’s name.                                                                                                                        | `AF`; `AN`; `AS`     | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="geo-country-iso-code" href="#geo-country-iso-code">`geo.country.iso_code`</a> | string | Two-letter ISO Country Code ([ISO 3166-1 alpha2](https://en.wikipedia.org/wiki/ISO_3166-1#Codes)).                                                                    | `CA`                 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="geo-locality-name" href="#geo-locality-name">`geo.locality.name`</a>          | string | Locality name. Represents the name of a city, town, village, or similar populated place.                                                                              | `Montreal`; `Berlin` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="geo-location-lat" href="#geo-location-lat">`geo.location.lat`</a>             | double | Latitude of the geo location in [WGS84](https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84).                                                                   | `45.505918`          | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="geo-location-lon" href="#geo-location-lon">`geo.location.lon`</a>             | double | Longitude of the geo location in [WGS84](https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84).                                                                  | `-73.61483`          | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="geo-postal-code" href="#geo-postal-code">`geo.postal_code`</a>                | string | Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. | `94040`              | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="geo-region-iso-code" href="#geo-region-iso-code">`geo.region.iso_code`</a>    | string | Region ISO code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).                                                                                             | `CA-QC`              | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 `geo.continent.code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
 

diff --git a/model/registry/geo.yaml → model/geo/registry.yaml b/model/registry/geo.yaml → model/geo/registry.yaml
@@ -1,7 +1,6 @@
 groups:
   - id: registry.geo
     type: attribute_group
-    prefix: geo
     brief: >
       Geo fields can carry data about a specific location related to an event.
       This geolocation information can be derived from techniques such as Geo IP, or be user-supplied.
@@ -11,13 +10,13 @@ groups:
       (under their own namespace) SHOULD document what geo attributes describe in the scope of that convention.
 
     attributes:
-      - id: city.name
+      - id: geo.locality.name
         stability: experimental
         type: string
         brief: >
-          City name.
+          Locality name. Represents the name of a city, town, village, or similar populated place.
         examples: [ 'Montreal', 'Berlin' ]
-      - id: continent.code
+      - id: geo.continent.code
         stability: experimental
         brief: >
           Two-letter code representing continent’s name.
@@ -51,32 +50,32 @@ groups:
               stability: experimental
               value: 'SA'
               brief: 'South America'
-      - id: country.iso_code
+      - id: geo.country.iso_code
         stability: experimental
         type: string
         brief: >
           Two-letter ISO Country Code ([ISO 3166-1 alpha2](https://en.wikipedia.org/wiki/ISO_3166-1#Codes)).
         examples: [ 'CA' ]
-      - id: location.lon
+      - id: geo.location.lon
         stability: experimental
         type: double
         brief: >
           Longitude of the geo location in [WGS84](https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84).
         examples: [ -73.614830 ]
-      - id: location.lat
+      - id: geo.location.lat
         stability: experimental
         type: double
         brief: >
           Latitude of the geo location in [WGS84](https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84).
         examples: [ 45.505918 ]
-      - id: postal_code
+      - id: geo.postal_code
         stability: experimental
         type: string
         brief: >
           Postal code associated with the location.
           Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.
         examples: [ '94040' ]
-      - id: region.iso_code
+      - id: geo.region.iso_code
         stability: experimental
         type: string
         brief: >