diff --git a/docs/attributes-registry/geo.md b/docs/attributes-registry/geo.md index 5cd926f5f6..6e2167981e 100644 --- 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 | +| ------------------------------------------------------------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ---------------------------------------------------------------- | +| `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.locality.name` | 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) | +| `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) | `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 b/model/geo/registry.yaml similarity index 90% rename from model/registry/geo.yaml rename to model/geo/registry.yaml index a5214aac5f..41cb4afb38 100644 --- a/model/registry/geo.yaml +++ b/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: >