Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve description of hardware network adapter #3133

Open
sebastien-rosset opened this issue Jan 23, 2023 · 0 comments
Open

Improve description of hardware network adapter #3133

sebastien-rosset opened this issue Jan 23, 2023 · 0 comments
Assignees
Labels
spec:metrics Related to the specification/metrics directory

Comments

@sebastien-rosset
Copy link
Contributor

sebastien-rosset commented Jan 23, 2023

What are you trying to achieve?

Improve the description of network adapter, which is currently defined as:

A physical network interface, or a network interface controller (NIC), excluding virtual adapters and loopbacks. Examples: an Ethernet adapter, an HBA, an fiber channel port or a Wi-Fi adapter.

https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/hardware-metrics.md#hwnetwork---network-adapter-metrics

What did you expect to see?

The definition excludes virtual adapters, which presumably refers to software-based network interfaces, such as virtual switches in a hypervisor or virtual interfaces in operating systems. That may have been implied, but since it's not explicit in the spec, that makes the spec ambiguous.

Many modern NICs (including smart NICs) have the ability to create virtualized network interfaces with hardware resources. The OS sees separate PCI devices. Since the whole section is about hardware, IMO network adapters should include adapters that are virtualized by the hardware.

Additional context.

Under common attributes, the spec states:

Physical system as opposed to a virtual system or a container. Examples: physical server, switch or disk array.

So presumably the network adapter metrics can be used for a server NIC, and also for Ethernet ports on switches, routers, firewalls, load balancers, etc. If that was the intent, it would be good to add examples in the description, because the name "network adapter" is seldom used for switches and routers. "Network adapter" tends to be used for hardware cards that are inserted in computers and appliances.

https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/hardware-metrics.md#hwhost---physical-host-metrics

Maybe the definition could be changed to:

A physical network interface, or a network interface controller (NIC), excluding software-based virtual adapters and loopbacks. For example, a physical network interface on a server, switch, router or firewall.

@sebastien-rosset sebastien-rosset added the spec:metrics Related to the specification/metrics directory label Jan 23, 2023
carlosalberto pushed a commit that referenced this issue Apr 11, 2023
…d attributes (#3344)

Fixes #3132, #3133

## Changes

In semantic conventions for hardware metrics:

* Updated network adapter description
* Changed `type` to `hw.error.type` for the `hw.errors` metric
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this issue Oct 31, 2024
… metrics, network metrics and attributes (open-telemetry#3344)

Fixes open-telemetry#3132, open-telemetry#3133

## Changes

In semantic conventions for hardware metrics:

* Updated network adapter description
* Changed `type` to `hw.error.type` for the `hw.errors` metric
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:metrics Related to the specification/metrics directory
Projects
None yet
Development

No branches or pull requests

2 participants