> Source: https://www.ymotongpoo.com/works/otel-specs-ja/semconv/nfs/nfs-metrics/ # NFSメトリクスに関するセマンティック規約 **ステータス**: [Development][DocumentStatus] この文書では、NFSおよびNFSDのメトリクスに関するInstrumentと属性を記述します。 ## NFSメトリクス ### メトリクス: `nfs.client.net.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.client.net.count` | Counter | `{record}` | 処理された、カーネルのNFSクライアントTCPセグメントとUDPデータグラムの数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、Linuxカーネルの`svc_stat.netudpcnt`と`svc_stat.nettcpcnt`から取得されます。 **Attributes:** | Key | Stability | [Requirement Level](/works/otel-specs-ja/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`network.transport`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/network/) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | [OSIトランスポート層](https://wikipedia.org/wiki/Transport_layer)または[プロセス間通信の方式](https://wikipedia.org/wiki/Inter-process_communication)。[1] | `tcp`; `udp` | **[1] `network.transport`:** この値は小文字に正規化されるべきです（SHOULD）。 ポート番号を設定する際は、常にトランスポートも設定することを検討してください。トランスポートが分からなければ、ポート番号は曖昧になるためです。たとえば、異なるプロセスがTCPポート12345とUDPポート12345の両方でリスンしている場合があります。 --- `network.transport`には、次のよく知られた値の一覧があります。これらのいずれかが該当する場合は、対応する値を使用しなければなりません（MUST）。そうでない場合は、独自の値を使用してもかまいません（MAY）。 | Value | Description | Stability | | --- | --- | --- | | `pipe` | 名前付き、または匿名のパイプ。 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `quic` | QUIC | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `tcp` | TCP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | UNIXドメインソケット | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | ### メトリクス: `nfs.client.net.tcp.connection.accepted` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.client.net.tcp.connection.accepted` | Counter | `{connection}` | 受け付けられた、カーネルのNFSクライアントTCP接続数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、Linuxカーネルの`svc_stat.nettcpconn`から取得されます。 ### メトリクス: `nfs.client.rpc.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.client.rpc.count` | Counter | `{request}` | サーバーによって受理・拒否されたかにかかわらず、送信された、カーネルのNFSクライアントRPC数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、Linuxカーネルの`svc_stat.rpccnt`から取得されます。 ### メトリクス: `nfs.client.rpc.retransmit.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.client.rpc.retransmit.count` | Counter | `{retransmit}` | カーネルのNFSクライアントRPC再送数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、Linuxカーネルの`svc_stat.rpcretrans`から取得されます。 ### メトリクス: `nfs.client.rpc.authrefresh.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.client.rpc.authrefresh.count` | Counter | `{authrefresh}` | カーネルのNFSクライアントRPC認証リフレッシュ数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、Linuxカーネルの`svc_stat.rpcauthrefresh`から取得されます。 ### メトリクス: `nfs.client.operation.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.client.operation.count` | Counter | `{operation}` | カーネルのNFSv4+クライアント操作数を報告します。 | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **Attributes:** | Key | Stability | [Requirement Level](/works/otel-specs-ja/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`nfs.operation.name`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/nfs/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | NFSv4+の操作名。 | `OPEN`; `READ`; `GETATTR` | | [`onc_rpc.version`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/onc-rpc/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | ONC/Sun RPCのプログラムバージョン。 | | ### メトリクス: `nfs.client.procedure.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.client.procedure.count` | Counter | `{procedure}` | カーネルのNFSクライアントプロシージャ数を報告します。 | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **Attributes:** | Key | Stability | [Requirement Level](/works/otel-specs-ja/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`onc_rpc.procedure.name`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/onc-rpc/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | ONC/Sun RPCのプロシージャ名。 | `OPEN`; `READ`; `GETATTR` | | [`onc_rpc.version`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/onc-rpc/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | ONC/Sun RPCのプログラムバージョン。 | | ## NFSDメトリクス ### メトリクス: `nfs.server.repcache.requests` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.server.repcache.requests` | Counter | `{request}` | キャッシュヒットの状態別に、カーネルのNFSサーバーリプライキャッシュのリクエスト数を報告します。 | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **Attributes:** | Key | Stability | [Requirement Level](/works/otel-specs-ja/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`nfs.server.repcache.status`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/nfs/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Linux: "hit"（NFSD_STATS_RC_HITS）、"miss"（NFSD_STATS_RC_MISSES）、"nocache"（NFSD_STATS_RC_NOCACHE、キャッシュ不可）のいずれか。 | `hit` | ### メトリクス: `nfs.server.fh.stale.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.server.fh.stale.count` | Counter | `{fh}` | カーネルのNFSサーバーの無効なファイルハンドル数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、`nfsd_net`構造体内のLinuxカーネルの`NFSD_STATS_FH_STALE`カウンタから取得されます。 ### メトリクス: `nfs.server.io` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.server.io` | Counter | `By` | 受信・送信（読み取り・書き込み）リクエストに対して返された、カーネルのNFSサーバーのバイト数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、`nfsd_net`構造体内のLinuxカーネルの`NFSD_STATS_IO_READ`カウンタと`NFSD_STATS_IO_WRITE`カウンタから取得されます。 **Attributes:** | Key | Stability | [Requirement Level](/works/otel-specs-ja/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`network.io.direction`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/network/) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | 観測を行うホストの物理・仮想ネットワークインターフェースの視点から見た通信の方向。ステートフルな接続やネットワークフローの論理的な方向を表すために使用すべきではありません（should not）。 | `transmit` | --- `network.io.direction`には、次のよく知られた値の一覧があります。これらのいずれかが該当する場合は、対応する値を使用しなければなりません（MUST）。そうでない場合は、独自の値を使用してもかまいません（MAY）。 | Value | Description | Stability | | --- | --- | --- | | `receive` | receive | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `transmit` | transmit | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | ### メトリクス: `nfs.server.thread.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.server.thread.count` | UpDownCounter | `{thread}` | カーネルのNFSサーバーの利用可能なスレッド数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、Linuxカーネルの`nfsd_th_cnt`変数から取得されます。 ### メトリクス: `nfs.server.net.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.server.net.count` | Counter | `{record}` | 処理された、カーネルのNFSサーバーTCPセグメントとUDPデータグラムの数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、Linuxカーネルの`svc_stat.nettcpcnt`と`svc_stat.netudpcnt`から取得されます。 **Attributes:** | Key | Stability | [Requirement Level](/works/otel-specs-ja/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`network.transport`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/network/) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | [OSIトランスポート層](https://wikipedia.org/wiki/Transport_layer)または[プロセス間通信の方式](https://wikipedia.org/wiki/Inter-process_communication)。[1] | `tcp`; `udp` | **[1] `network.transport`:** この値は小文字に正規化されるべきです（SHOULD）。 ポート番号を設定する際は、常にトランスポートも設定することを検討してください。トランスポートが分からなければ、ポート番号は曖昧になるためです。たとえば、異なるプロセスがTCPポート12345とUDPポート12345の両方でリスンしている場合があります。 --- `network.transport`には、次のよく知られた値の一覧があります。これらのいずれかが該当する場合は、対応する値を使用しなければなりません（MUST）。そうでない場合は、独自の値を使用してもかまいません（MAY）。 | Value | Description | Stability | | --- | --- | --- | | `pipe` | 名前付き、または匿名のパイプ。 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `quic` | QUIC | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `tcp` | TCP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | UNIXドメインソケット | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | ### メトリクス: `nfs.server.net.tcp.connection.accepted` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.server.net.tcp.connection.accepted` | Counter | `{connection}` | 受け付けられた、カーネルのNFSサーバーTCP接続数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、Linuxカーネルの`svc_stat.nettcpconn`から取得されます。 ### メトリクス: `nfs.server.rpc.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.server.rpc.count` | Counter | `{request}` | 処理された、カーネルのNFSサーバーRPC数を報告します。[1] | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **[1]:** Linux: このメトリクスは、正常なRPC数であるLinuxカーネルの`svc_stat.rpccnt`から取得されます。このメトリクスは、`svc_stat.badfmt`、`svc_stat.badauth`、`svc_stat.badclnt`について、それぞれ"format"、"auth"、"client"の`error.type`を持つ場合があります。 **Attributes:** | Key | Stability | [Requirement Level](/works/otel-specs-ja/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`error.type`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/error/) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | 操作が終了したエラーのクラスを記述します。[1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | **[1] `error.type`:** `error.type`は予測可能であるべきであり（SHOULD）、カーディナリティが低いべきです（SHOULD）。 `error.type`に型（たとえば例外の型）を設定する場合、そのアーティファクト内でその型を識別する正規のクラス名を使用すべきです（SHOULD）。 記録されたエラー型が、失敗の分類にとって意味を持たないラッパーである場合、計装は内側のエラーの型を代わりに使用してもかまいません（MAY）。たとえばGoでは、ラッパー型が失敗の分類に役立たない場合、`%w`を使って`fmt.Errorf`で作成されたエラーをアンラップしてもかまいません（MAY）。 計装は、報告するエラーの一覧を文書化すべきです（SHOULD）。 1つの計装ライブラリ内における`error.type`のカーディナリティは低くあるべきです（SHOULD）。複数の計装ライブラリやアプリケーションからのデータを集約するテレメトリーの利用者は、追加のフィルタが適用されない場合、クエリ実行時に`error.type`が高いカーディナリティを持つことを想定しておくべきです（should）。 操作が正常に完了した場合、計装は`error.type`を設定すべきではありません（SHOULD NOT）。 特定のドメインが独自のエラー識別子の集合（HTTPやRPCのステータスコードなど）を定義している場合、次のことが推奨されます（RECOMMENDED）。 - ドメイン固有の属性を使用する。 - そのドメイン固有の集合に定義されているかどうかにかかわらず、すべてのエラーを捕捉するように`error.type`を設定する。 --- `error.type`には、次のよく知られた値の一覧があります。これらのいずれかが該当する場合は、対応する値を使用しなければなりません（MUST）。そうでない場合は、独自の値を使用してもかまいません（MAY）。 | Value | Description | Stability | | --- | --- | --- | | `_OTHER` | 計装が独自の値を定義していない場合に使用するフォールバック用のエラー値。 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | ### メトリクス: `nfs.server.operation.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.server.operation.count` | Counter | `{operation}` | カーネルのNFSv4+サーバー操作数を報告します。 | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **Attributes:** | Key | Stability | [Requirement Level](/works/otel-specs-ja/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`nfs.operation.name`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/nfs/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | NFSv4+の操作名。 | `OPEN`; `READ`; `GETATTR` | | [`onc_rpc.version`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/onc-rpc/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | ONC/Sun RPCのプログラムバージョン。 | | ### メトリクス: `nfs.server.procedure.count` このメトリクスは[recommended][MetricRecommended]です。 | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `nfs.server.procedure.count` | Counter | `{procedure}` | カーネルのNFSサーバープロシージャ数を報告します。 | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](https://opentelemetry.io/docs/specs/semconv/registry/entities/host/#host) | **Attributes:** | Key | Stability | [Requirement Level](/works/otel-specs-ja/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`onc_rpc.procedure.name`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/onc-rpc/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | ONC/Sun RPCのプロシージャ名。 | `OPEN`; `READ`; `GETATTR` | | [`onc_rpc.version`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/onc-rpc/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | ONC/Sun RPCのプログラムバージョン。 | | [MetricRecommended]: /works/otel-specs-ja/semconv/general/metric-requirement-level/#recommended [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status