From ad217587afb96d2ff8a7ac04c376356b6676e443 Mon Sep 17 00:00:00 2001 From: Greg Kalapos Date: Fri, 29 Nov 2024 19:40:18 +0100 Subject: [PATCH 1/7] Merge geo.location.lon and geo.location.lat --- docs/attributes-registry/geo.md | 3 +-- model/geo/registry.yaml | 14 ++++---------- 2 files changed, 5 insertions(+), 12 deletions(-) diff --git a/docs/attributes-registry/geo.md b/docs/attributes-registry/geo.md index c86484d9b3..38d21e9eb2 100644 --- a/docs/attributes-registry/geo.md +++ b/docs/attributes-registry/geo.md @@ -16,8 +16,7 @@ Note: Geo attributes are typically used under another namespace, such as client. | `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://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://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://wikipedia.org/wiki/World_Geodetic_System#WGS84). | `-73.61483` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `geo.location` | double[] | Latitude and longitude (in that order) of the geo location in [WGS84](https://wikipedia.org/wiki/World_Geodetic_System#WGS84). | `[45.505918, -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://wikipedia.org/wiki/ISO_3166-2)). | `CA-QC` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/model/geo/registry.yaml b/model/geo/registry.yaml index e370fbd4df..8ec8360135 100644 --- a/model/geo/registry.yaml +++ b/model/geo/registry.yaml @@ -56,18 +56,12 @@ groups: brief: > Two-letter ISO Country Code ([ISO 3166-1 alpha2](https://wikipedia.org/wiki/ISO_3166-1#Codes)). examples: [ 'CA' ] - - id: geo.location.lon + - id: geo.location stability: experimental - type: double + type: double[] brief: > - Longitude of the geo location in [WGS84](https://wikipedia.org/wiki/World_Geodetic_System#WGS84). - examples: [ -73.614830 ] - - id: geo.location.lat - stability: experimental - type: double - brief: > - Latitude of the geo location in [WGS84](https://wikipedia.org/wiki/World_Geodetic_System#WGS84). - examples: [ 45.505918 ] + Latitude and longitude (in that order) of the geo location in [WGS84](https://wikipedia.org/wiki/World_Geodetic_System#WGS84). + examples: [ [45.505918, -73.614830] ] - id: geo.postal_code stability: experimental type: string From 3fd367f1047823ae86ba32cf242e82e2f4d6a49a Mon Sep 17 00:00:00 2001 From: Greg Kalapos Date: Fri, 29 Nov 2024 19:53:33 +0100 Subject: [PATCH 2/7] Create geo_merge_lat_lon.yaml --- .chloggen/geo_merge_lat_lon.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100755 .chloggen/geo_merge_lat_lon.yaml diff --git a/.chloggen/geo_merge_lat_lon.yaml b/.chloggen/geo_merge_lat_lon.yaml new file mode 100755 index 0000000000..c513ba89fa --- /dev/null +++ b/.chloggen/geo_merge_lat_lon.yaml @@ -0,0 +1,22 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: breaking + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: geo + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Merging `geo.location.lon` and `geo.location.lat` into a single `geo.location` field. + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: From 458f5956d1679dd82344510381eb99544caefe50 Mon Sep 17 00:00:00 2001 From: Greg Kalapos Date: Fri, 29 Nov 2024 19:54:14 +0100 Subject: [PATCH 3/7] Update geo_merge_lat_lon.yaml --- .chloggen/geo_merge_lat_lon.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.chloggen/geo_merge_lat_lon.yaml b/.chloggen/geo_merge_lat_lon.yaml index c513ba89fa..69711a6ec8 100755 --- a/.chloggen/geo_merge_lat_lon.yaml +++ b/.chloggen/geo_merge_lat_lon.yaml @@ -14,7 +14,7 @@ note: Merging `geo.location.lon` and `geo.location.lat` into a single `geo.loca # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. # The values here must be integers. -issues: [] +issues: [1638] # (Optional) One or more lines of additional information to render under the primary note. # These lines will be padded with 2 spaces and then inserted directly into the document. From c8b0d3e31350dbefd53125899da4af10a9368bc9 Mon Sep 17 00:00:00 2001 From: Greg Kalapos Date: Fri, 29 Nov 2024 20:05:51 +0100 Subject: [PATCH 4/7] Create registry-deprecated.yaml --- model/geo/deprecated/registry-deprecated.yaml | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 model/geo/deprecated/registry-deprecated.yaml diff --git a/model/geo/deprecated/registry-deprecated.yaml b/model/geo/deprecated/registry-deprecated.yaml new file mode 100644 index 0000000000..7f88cbbfe2 --- /dev/null +++ b/model/geo/deprecated/registry-deprecated.yaml @@ -0,0 +1,22 @@ +groups: + - id: registry.geo.deprecated + type: attribute_group + display_name: Deprecated geo Attributes + brief: > + "Describes deprecated geo attributes." + stability: experimental + attributes: + - id: geo.location.lon + stability: experimental + type: double + deprecated: "Use `geo.location` instead." + brief: > + Deprecated. Use `geo.location` instead. + examples: [ -73.614830 ] + - id: geo.location.lat + stability: experimental + type: double + deprecated: "Use `geo.location` instead." + brief: > + Deprecated. Use `geo.location` instead. + examples: [ 45.505918 ] \ No newline at end of file From 79b614d62cdd0a8a992dc3feba6509040ffe8960 Mon Sep 17 00:00:00 2001 From: Greg Kalapos Date: Fri, 29 Nov 2024 20:07:23 +0100 Subject: [PATCH 5/7] Update registry-deprecated.yaml --- model/geo/deprecated/registry-deprecated.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/model/geo/deprecated/registry-deprecated.yaml b/model/geo/deprecated/registry-deprecated.yaml index 7f88cbbfe2..1d3b30f82b 100644 --- a/model/geo/deprecated/registry-deprecated.yaml +++ b/model/geo/deprecated/registry-deprecated.yaml @@ -5,7 +5,7 @@ groups: brief: > "Describes deprecated geo attributes." stability: experimental - attributes: + attributes: - id: geo.location.lon stability: experimental type: double @@ -19,4 +19,4 @@ groups: deprecated: "Use `geo.location` instead." brief: > Deprecated. Use `geo.location` instead. - examples: [ 45.505918 ] \ No newline at end of file + examples: [ 45.505918 ] From 7121677c98c44e234ce7e7965a392c3a8813c2c5 Mon Sep 17 00:00:00 2001 From: Greg Kalapos Date: Fri, 29 Nov 2024 20:09:22 +0100 Subject: [PATCH 6/7] Update geo.md --- docs/attributes-registry/geo.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/attributes-registry/geo.md b/docs/attributes-registry/geo.md index 38d21e9eb2..fb2c28a7d8 100644 --- a/docs/attributes-registry/geo.md +++ b/docs/attributes-registry/geo.md @@ -6,6 +6,9 @@ # Geo +- [Geo Attributes](#geo-attributes) +- [Deprecated geo Attributes](#deprecated-geo-attributes) + ## Geo Attributes 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. @@ -33,3 +36,12 @@ Note: Geo attributes are typically used under another namespace, such as client. | `NA` | North America | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `OC` | Oceania | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `SA` | South America | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +## Deprecated geo Attributes + +"Describes deprecated geo attributes." + +| Attribute | Type | Description | Examples | Stability | +|---|---|---|---|---| +| `geo.location.lat` | double | Deprecated. Use `geo.location` instead. | `45.505918` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use `geo.location` instead. | +| `geo.location.lon` | double | Deprecated. Use `geo.location` instead. | `-73.61483` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use `geo.location` instead. | From 9d62fe3fa977d40556bf2d7d4fefdeeaaba74a1a Mon Sep 17 00:00:00 2001 From: Greg Kalapos Date: Mon, 2 Dec 2024 15:13:13 +0100 Subject: [PATCH 7/7] Change order to [lon,lat] --- docs/attributes-registry/geo.md | 2 +- model/geo/registry.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/attributes-registry/geo.md b/docs/attributes-registry/geo.md index fb2c28a7d8..5447e6158f 100644 --- a/docs/attributes-registry/geo.md +++ b/docs/attributes-registry/geo.md @@ -19,7 +19,7 @@ Note: Geo attributes are typically used under another namespace, such as client. | `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://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` | double[] | Latitude and longitude (in that order) of the geo location in [WGS84](https://wikipedia.org/wiki/World_Geodetic_System#WGS84). | `[45.505918, -73.61483]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `geo.location` | double[] | Longitude and latitude (in that order) of the geo location in [WGS84](https://wikipedia.org/wiki/World_Geodetic_System#WGS84). | `[45.505918, -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://wikipedia.org/wiki/ISO_3166-2)). | `CA-QC` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/model/geo/registry.yaml b/model/geo/registry.yaml index 8ec8360135..0c9eef1ff3 100644 --- a/model/geo/registry.yaml +++ b/model/geo/registry.yaml @@ -60,7 +60,7 @@ groups: stability: experimental type: double[] brief: > - Latitude and longitude (in that order) of the geo location in [WGS84](https://wikipedia.org/wiki/World_Geodetic_System#WGS84). + Longitude and latitude (in that order) of the geo location in [WGS84](https://wikipedia.org/wiki/World_Geodetic_System#WGS84). examples: [ [45.505918, -73.614830] ] - id: geo.postal_code stability: experimental