Skip to content

Commit fd0d16f

Browse files
authored
Update metrics name to fall into clear categories (cvmfs-contrib#15)
Fixes cvmfs-contrib#14
1 parent a018790 commit fd0d16f

File tree

2 files changed

+301
-60
lines changed

2 files changed

+301
-60
lines changed

README.md

Lines changed: 60 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -88,45 +88,68 @@ curl http://localhost:9868
8888

8989
## Metrics Summary
9090

91-
The exporter collects the following categories of metrics:
92-
93-
### Cache Metrics
94-
- `cvmfs_cached_bytes` - Currently cached data size
95-
- `cvmfs_pinned_bytes` - Pinned cache data size
96-
- `cvmfs_total_cache_size_bytes` - Configured cache limit
97-
- `cvmfs_physical_cache_size_bytes` - Physical cache volume size
98-
- `cvmfs_physical_cache_avail_bytes` - Available cache space
99-
- `cvmfs_hitrate` - Cache hit rate percentage
100-
- `cvmfs_ncleanup24` - Cache cleanups in last 24 hours
101-
102-
### Network & Download Metrics
103-
- `cvmfs_rx_total` - Total bytes downloaded since mount
104-
- `cvmfs_ndownload_total` - Total files downloaded since mount
105-
- `cvmfs_speed` - Average download speed
106-
- `cvmfs_proxy` - Available proxy servers
107-
- `cvmfs_active_proxy` - Currently active proxy
108-
- `cvmfs_timeout` - Proxy connection timeout
109-
- `cvmfs_timeout_direct` - Direct connection timeout
110-
111-
### Repository Status Metrics
91+
The exporter collects the following categories of metrics with consistent naming:
92+
93+
### Cache Metrics (`cvmfs_cache_*`)
94+
- `cvmfs_cache_cached_bytes` - Currently cached data size
95+
- `cvmfs_cache_pinned_bytes` - Pinned cache data size
96+
- `cvmfs_cache_total_size_bytes` - Configured cache limit
97+
- `cvmfs_cache_physical_size_bytes` - Physical cache volume size
98+
- `cvmfs_cache_physical_avail_bytes` - Available cache space
99+
- `cvmfs_cache_hitrate` - Cache hit rate percentage
100+
- `cvmfs_cache_ncleanup24` - Cache cleanups in last 24 hours
101+
- `cvmfs_cache_mode` - Cache mode (0=unknown, 1=read-write, 2=read-only)
102+
103+
### Network & Download Metrics (`cvmfs_net_*`)
104+
- `cvmfs_net_rx_total` - Total bytes downloaded since mount
105+
- `cvmfs_net_ndownload_total` - Total files downloaded since mount
106+
- `cvmfs_net_speed` - Average download speed
107+
- `cvmfs_net_proxy` - Available proxy servers
108+
- `cvmfs_net_active_proxy` - Currently active proxy
109+
- `cvmfs_net_timeout` - Proxy connection timeout
110+
- `cvmfs_net_timeout_direct` - Direct connection timeout
111+
112+
### Repository Status Metrics (`cvmfs_repo_*`)
112113
- `cvmfs_repo` - Repository version and revision information
113-
- `cvmfs_uptime_seconds` - Time since repository mount
114-
- `cvmfs_mount_epoch_timestamp` - Repository mount timestamp
114+
- `cvmfs_repo_uptime_seconds` - Time since repository mount
115+
- `cvmfs_repo_mount_epoch_timestamp` - Repository mount timestamp
115116
- `cvmfs_repo_expires_seconds` - Root catalog expiration time
116-
117-
### System Resource Metrics
118-
- `cvmfs_cpu_user_total` - CPU time in userspace
119-
- `cvmfs_cpu_system_total` - CPU time in kernel space
120-
- `cvmfs_maxfd` - Maximum file descriptors available
121-
- `cvmfs_usedfd` - Currently used file descriptors
122-
- `cvmfs_ndiropen` - Number of open directories
123-
- `cvmfs_pid` - CVMFS process ID
124-
125-
### Error & Monitoring Metrics
126-
- `cvmfs_nioerr_total` - Total I/O errors encountered
127-
- `cvmfs_timestamp_last_ioerr` - Timestamp of last I/O error
128-
- `cvmfs_nclg` - Number of loaded nested catalogs
129-
- `cvmfs_inode_max` - Highest possible inode number
117+
- `cvmfs_repo_version` - Numeric repository version for easier querying
118+
- `cvmfs_repo_revision` - Repository revision number
119+
- `cvmfs_repo_nclg` - Number of loaded nested catalogs
120+
121+
### System Resource Metrics (`cvmfs_sys_*`)
122+
- `cvmfs_sys_cpu_user_total` - CPU time in userspace
123+
- `cvmfs_sys_cpu_system_total` - CPU time in kernel space
124+
- `cvmfs_sys_maxfd` - Maximum file descriptors available
125+
- `cvmfs_sys_usedfd` - Currently used file descriptors
126+
- `cvmfs_sys_useddirp` - File descriptors issued to clients
127+
- `cvmfs_sys_ndiropen` - Number of open directories
128+
- `cvmfs_sys_pid` - CVMFS process ID
129+
- `cvmfs_sys_inode_max` - Highest possible inode number
130+
- `cvmfs_sys_memory_usage_bytes` - CVMFS process memory usage
131+
- `cvmfs_sys_nioerr_total` - Total I/O errors encountered
132+
- `cvmfs_sys_timestamp_last_ioerr` - Timestamp of last I/O error
133+
- `cvmfs_sys_drainout_mode` - Drainout mode status
134+
- `cvmfs_sys_maintenance_mode` - Maintenance mode status
135+
- `cvmfs_sys_nfs_mode` - NFS mode enabled status
136+
137+
### Internal Affairs Metrics (`cvmfs_internal_*`)
138+
- `cvmfs_internal_pathstring_*` - PathString statistics
139+
- `cvmfs_internal_namestring_*` - NameString statistics
140+
- `cvmfs_internal_linkstring_*` - LinkString statistics
141+
- `cvmfs_internal_inode_tracker_*` - Inode tracker statistics
142+
- `cvmfs_internal_dentry_tracker_*` - Dentry tracker statistics
143+
- `cvmfs_internal_page_cache_tracker_*` - Page cache tracker statistics
144+
- `cvmfs_internal_sqlite_*` - SQLite internal statistics
145+
146+
## Version Compatibility
147+
148+
The script automatically detects the CVMFS version and adapts accordingly:
149+
150+
- **CVMFS 2.13.2+**: Uses the native `cvmfs_talk metrics prometheus` command with consistent metric naming
151+
- **CVMFS 2.13.2 (exact)**: Applies postprocessing to rename metrics for consistency
152+
- **Older versions**: Uses legacy extended attribute collection with consistent naming
130153

131154
## Configuration
132155

0 commit comments

Comments
 (0)