Skip to content

Commit

Permalink
Contributing Geo fields from ECS
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderWert committed Sep 21, 2022
1 parent 9920d5e commit b0fbc25
Show file tree
Hide file tree
Showing 2 changed files with 132 additions and 0 deletions.
94 changes: 94 additions & 0 deletions semantic_conventions/resource/geo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
groups:
- id: geo
prefix: geo
type: resource
brief: >
Fields describing a location.
attributes:
- id: city_name
type: string
brief: >
City name.
examples: ["Montreal", "Berlin"]
- id: continent_code
type:
allow_custom_values: false
members:
- id: af
value: "AF"
brief: "Africa"
- id: an
value: "AN"
brief: "Antarctica"
- id: as
value: "AS"
brief: "Asia"
- id: eu
value: "EU"
brief: "Europe"
- id: na
value: "NA"
brief: "North America"
- id: oc
value: "OC"
brief: "Oceania"
- id: sa
value: "SA"
brief: "South America"
brief: >
Two-letter code representing continent’s name.
- id: continent_name
type: string
brief: >
Name of the continent.
examples: ["North America", "Europe"]
- id: country_iso_code
type: string
brief: >
Two-letter ISO Country Code (ISO 3166-1 alpha2).
examples: ["CA"]
- id: country_name
type: string
brief: >
Country name.
examples: ["Canada"]
- id: location.lon
type: double
brief: >
Longitude of the geo location.
examples: [-73.614830]
- id: location.lat
type: double
brief: >
Latitude of the geo location.
examples: [45.505918]
- id: name
type: string
brief: >
User-defined description of a location.
note: >
User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.
examples: ["boston-dc"]
- id: postal_code
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
type: string
brief: >
Region ISO code (ISO 3166-2).
examples: ["CA-QC"]
- id: region_name
type: string
brief: >
Region name.
examples: ["Quebec"]
- id: timezone
type: string
brief: >
The time zone of the location, such as IANA time zone name.
examples: ["America/Argentina/Buenos_Aires"]
38 changes: 38 additions & 0 deletions specification/resource/semantic_conventions/geo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Geo

**Status**: [Experimental](../../document-status.md)

**type:** `geo`

**Description**: Geo fields can carry data about a specific location related to a resource or event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied.

<!-- semconv geo -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `geo.city_name` | string | City name. | `Montreal`; `Berlin` | Recommended |
| `geo.continent_code` | string | Two-letter code representing continent’s name. | `AF` | Recommended |
| `geo.continent_name` | string | Name of the continent. | `North America`; `Europe` | Recommended |
| `geo.country_iso_code` | string | Two-letter ISO Country Code (ISO 3166-1 alpha2). | `CA` | Recommended |
| `geo.country_name` | string | Country name. | `Canada` | Recommended |
| `geo.location.lon` | double | Longitude of the geo location. | `-73.61483` | Recommended |
| `geo.location.lat` | double | Latitude of the geo location. | `45.505918` | Recommended |
| `geo.name` | string | User-defined description of a location. [1] | `boston-dc` | Recommended |
| `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` | Recommended |
| `geo.region_iso_code` | string | Region ISO code (ISO 3166-2). | `CA-QC` | Recommended |
| `geo.region_name` | string | Region name. | `Quebec` | Recommended |
| `geo.timezone` | string | The time zone of the location, such as IANA time zone name. | `America/Argentina/Buenos_Aires` | Recommended |

**[1]:** User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.

`geo.continent_code` MUST be one of the following:

| Value | Description |
|---|---|
| `AF` | Africa |
| `AN` | Antarctica |
| `AS` | Asia |
| `EU` | Europe |
| `NA` | North America |
| `OC` | Oceania |
| `SA` | South America |
<!-- endsemconv -->

0 comments on commit b0fbc25

Please sign in to comment.