Add a datacenter resource. #1413

hdost · 2024-09-17T12:25:39Z

The purpose of this is to allow for people running in a hybrid environment.

Relates #1409

Changes

Please provide a brief description of the changes here.

Note: if the PR is touching an area that is not listed in the existing areas, or the area does not have sufficient domain experts coverage, the PR might be tagged as experts needed and move slowly until experts are identified.

Merge requirement checklist

CONTRIBUTING.md guidelines followed.
Change log entry added, according to the guidelines in When to add a changelog entry.
- If your PR does not need a change log, start the PR title with [chore]
schema-next.yaml updated with changes to existing conventions.

docs/attributes-registry/datacenter.md

model/datacenter/resources.yaml

model/datacenter/registry.yaml

model/datacenter/resources.yaml

github-actions · 2024-10-11T03:21:08Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

hdost · 2024-10-12T14:38:19Z

This is a bit of an anti pattern ... stale because i haven't received a review?

Also check failure is unrelated to this change.

The purpose of this is to allow for people running in a hybrid environment.

joaopgrassi · 2024-10-14T14:45:53Z

docs/attributes-registry/dc.md

+<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
+<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
+
+# DC


Not sure it is a good idea to use the abbreviation here. I'd be more inclined to go with "Data Center" instead.

lmolkova · 2024-10-18T17:11:09Z

model/dc/registry.yaml

+      - id: dc.site
+        type: string
+        stability: experimental
+        brief: 'Name of the datacenter site'
+        note: >
+          The name of the physical building.
+        examples: ['site-1']
+      - id: dc.suite
+        type: string
+        stability: experimental
+        brief: 'Name of the datacenter suite'
+        note: >
+          Typically the room in the building where the server cages are located.
+        examples: ['suite-5']


this is a good case to reuse future geo namespace #1116

cc @trisch-me @gregkalapos

I'd postpone adding those two since physical address is not a datacenter-specific thing and we need to be able to express it in a generic way.

This is not necessarily related to geolocation it's relative to the building it's in.

lmolkova · 2024-10-18T17:12:28Z

model/dc/registry.yaml

+        stability: experimental
+        brief: 'Type of datacenter'
+        examples: ['cloud', 'colocation', 'internal']
+      - id: dc.device.type


we already have a few attributes that can describe a device id/name #1474 - is there some we can reuse instead of adding a new one?

I could see a scenario where you might need both a device ID and a hw component id in a parent child relationship. Maybe a server with a network card which you're measuring tx/rx.

lmolkova · 2024-10-18T17:57:27Z

model/dc/registry.yaml

+      - id: dc.cage
+        type: string
+        stability: experimental
+        brief: 'Name of the cage'


Is this a standard property described somewhere we can link to? Also, let's add an additional layer saying what it is. E.g. dc.cage.name or dc.cage.id so that there is a room to record different properties of the cage and also the attribute name is descriptive.

I can multiply it. I could see people using one, either , both.

lmolkova · 2024-10-18T17:58:23Z

model/dc/registry.yaml

+        note: >
+          This is a literal cage which is used to protect servers from potential intruders.
+        examples: ['cage-1']
+      - id: dc.pod


same as for the cage - please link some external documentation and also update the name to be more specific (dc.pod.name, or dc.pod.id or something else)

lmolkova · 2024-10-18T17:58:45Z

model/dc/registry.yaml

+        note: >
+          This is a grouping of many servers typically several racks of servers.
+        examples: ['pod-4']
+      - id: dc.chassis


same here, please link docs and provide specific property in the name

lmolkova · 2024-10-18T17:59:55Z

model/dc/resources.yaml

+    type: resource
+    name: dc
+    brief: >
+      Generic DataCenter infrastructure tagging.


I think we should call out that it's intended for the telemetry that describes datacenters themselves (and not the user code running somewhere that data center)

Until we sort out Entity / Resource fully - I think you should be really explicit who looks up this data and reports it.

Is this something you want an SDK to fill out? This feels like something that belongs in an entity side-channel signal...

cc @tigrannajaryan (and rest of Entities SiG) for thoughts

trask · 2024-10-20T16:47:15Z

model/dc/registry.yaml

+    brief: >
+      Generic DataCenter infrastructure tagging.
+    attributes:
+      - id: dc.name


it may be better to spell this out, check out the attribute name abbreviation guidelines

github-actions · 2024-11-05T03:20:56Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

hdost · 2024-11-09T11:56:45Z

Unstale please 🙏 bot

jsuereth · 2024-11-12T16:30:37Z

docs/resource/datacenter.md

+| Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
+|---|---|---|---|---|---|
+| [`cloud.provider`](/docs/attributes-registry/cloud.md) | string | Name of the cloud provider. | `alibaba_cloud`; `aws`; `azure` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| [`dc.cage`](/docs/attributes-registry/dc.md) | string | Name of the cage [1] | `cage-1` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |


Should these be conditionally recommended based on availability?
Should these be opt-in or on by default?

E.g. do cloud providers give you this data?

jsuereth · 2024-11-12T16:31:59Z

docs/resource/datacenter.md

+|---|---|---|---|---|---|
+| [`cloud.provider`](/docs/attributes-registry/cloud.md) | string | Name of the cloud provider. | `alibaba_cloud`; `aws`; `azure` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| [`dc.cage`](/docs/attributes-registry/dc.md) | string | Name of the cage [1] | `cage-1` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| [`dc.name`](/docs/attributes-registry/dc.md) | string | Name of datacenter. | `dc-name` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |


How do you get this information on a cloud?

is it correlated with cloud.availability_zone or cloud.region ?

jsuereth · 2024-11-12T16:33:50Z

model/dc/registry.yaml

+      - id: dc.site
+        type: string
+        stability: experimental
+        brief: 'Name of the datacenter site'


Can you outline more what this means and how to generate this field? Can I discover these from within a datacenter or do I need to look it up?

jsuereth · 2024-11-12T16:36:11Z

model/dc/resources.yaml

+    type: resource
+    name: dc
+    brief: >
+      Generic DataCenter infrastructure tagging.


Until we sort out Entity / Resource fully - I think you should be really explicit who looks up this data and reports it.

Is this something you want an SDK to fill out? This feels like something that belongs in an entity side-channel signal...

cc @tigrannajaryan (and rest of Entities SiG) for thoughts

Autogenerated code is up-to-date. Still concerns around documentation of how to fill things out and interaction with other semconv attributes.

hdost requested review from a team September 17, 2024 12:25

github-actions bot assigned jsuereth Sep 17, 2024

hdost force-pushed the feat/1458-adding-datacenter-convention branch from 1ae444e to eb6b348 Compare September 17, 2024 12:58

jsuereth previously requested changes Sep 18, 2024

View reviewed changes

docs/attributes-registry/datacenter.md Outdated Show resolved Hide resolved

model/datacenter/resources.yaml Outdated Show resolved Hide resolved

hdost requested review from a team as code owners September 22, 2024 16:23

lmolkova reviewed Sep 22, 2024

View reviewed changes

hdost force-pushed the feat/1458-adding-datacenter-convention branch 3 times, most recently from 2369cb4 to 01b85e3 Compare September 22, 2024 20:50

hdost requested a review from jsuereth September 25, 2024 19:06

gberche-orange mentioned this pull request Oct 9, 2024

Semantic conventions for virtual machine resources #1084

Open

github-actions bot added the Stale label Oct 11, 2024

hdost added 3 commits October 12, 2024 16:38

Add a datacenter resource.

4d9dea3

The purpose of this is to allow for people running in a hybrid environment.

fixups: Add Experimental flag and missing name.

cfaadd3

Manually add file (which is required)

48cfd1c

hdost force-pushed the feat/1458-adding-datacenter-convention branch from 10b7e40 to 48cfd1c Compare October 12, 2024 14:38

github-actions bot removed the Stale label Oct 13, 2024

joaopgrassi reviewed Oct 14, 2024

View reviewed changes

Merge branch 'main' into feat/1458-adding-datacenter-convention

f1122b7

lmolkova reviewed Oct 18, 2024

View reviewed changes

trask reviewed Oct 20, 2024

View reviewed changes

github-actions bot added the Stale label Nov 5, 2024

github-actions bot removed the Stale label Nov 10, 2024

jsuereth reviewed Nov 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a datacenter resource. #1413

Add a datacenter resource. #1413

hdost commented Sep 17, 2024 •

edited

Loading

github-actions bot commented Oct 11, 2024

hdost commented Oct 12, 2024 •

edited

Loading

joaopgrassi Oct 14, 2024

lmolkova Oct 18, 2024

hdost Oct 20, 2024 •

edited

Loading

lmolkova Oct 18, 2024

hdost Oct 20, 2024

lmolkova Oct 18, 2024

hdost Oct 20, 2024

lmolkova Oct 18, 2024

lmolkova Oct 18, 2024

lmolkova Oct 18, 2024

jsuereth Nov 12, 2024

trask Oct 20, 2024

github-actions bot commented Nov 5, 2024

hdost commented Nov 9, 2024

jsuereth Nov 12, 2024

jsuereth Nov 12, 2024

jsuereth Nov 12, 2024

jsuereth Nov 12, 2024

Add a datacenter resource. #1413

Are you sure you want to change the base?

Add a datacenter resource. #1413

Conversation

hdost commented Sep 17, 2024 • edited Loading

Changes

Merge requirement checklist

github-actions bot commented Oct 11, 2024

hdost commented Oct 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hdost Oct 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 5, 2024

hdost commented Nov 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hdost commented Sep 17, 2024 •

edited

Loading

hdost commented Oct 12, 2024 •

edited

Loading

hdost Oct 20, 2024 •

edited

Loading