prometheus / prometheus/node_exporter

Feature request: tls metrics from /proc/net/tls_stat

Open
#2,290 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
13.8k
Forks
2.7k
Avg merge
1d 23h
Merged PRs (30d)
8

Description

Linux kernel with loaded tls module exposes the following per-namespace statistics (/proc/net/tls_stat):

  • TlsCurrTxSw, TlsCurrRxSw - number of TX and RX sessions currently installed where host handles cryptography
  • TlsCurrTxDevice, TlsCurrRxDevice - number of TX and RX sessions currently installed where NIC handles cryptography
  • TlsTxSw, TlsRxSw - number of TX and RX sessions opened with host cryptography
  • TlsTxDevice, TlsRxDevice - number of TX and RX sessions opened with NIC cryptography
  • TlsDecryptError - record decryption failed (e.g. due to incorrect authentication tag)
  • TlsDeviceRxResync - number of RX resyncs sent to NICs handling cryptography

https://www.kernel.org/doc/html/latest/networking/tls.html#statistics

If this gets accepted, I can provide a PR for this.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Linux kernel TLS statistics documentation and inspect node_exporter's existing procfs collectors for the entry point that reads per-namespace files. Use /proc/net/tls_stat as the source and consider the work done when all listed TLS statistics are exposed as exporter metrics with suitable coverage in the existing collector tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, linux
Domain
observability-sre, operating-systems
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.