Add a platform for Performance Co-Pilot (PCP) metrics
This introduces an initial platform for extracting metrics
using the PCP performance metrics API - PMAPI(3). It can
be used via the --enable-pcp=yes configure option.
So far I've added support for live localhost metrics only,
and only using pre-defined metrics already found in htop.
If available, all sampling is performed by pmcd(1) - else,
we fallback to htop doing the metric sampling itself (all
below the PMAPI). When pmcd is used, it may be configured
to run children with elevated privileges, so htop does not
need to be setuid (authentication with pmcd is available).
Additionally, the PMAPI allows us to support archives (for
historical analysis and for automated regression tests in
htop). We'll need platform-specific command line argument
additions, which isn't yet feasible in htop (not difficult
to add though).
The goal of this first version is minimal impact in terms
of modifying the htop codebase, to introduce key ideas in
PCP (metric namespace, metadata, APIs and so on) and give
us something to discuss, experiment with and build on.
2021-02-17 03:43:56 +00:00
|
|
|
#ifndef HEADER_PCPProcess
|
|
|
|
|
#define HEADER_PCPProcess
|
|
|
|
|
/*
|
|
|
|
|
htop - PCPProcess.h
|
|
|
|
|
(C) 2014 Hisham H. Muhammad
|
|
|
|
|
(C) 2020 htop dev team
|
|
|
|
|
(C) 2020-2021 Red Hat, Inc. All Rights Reserved.
|
|
|
|
|
Released under the GNU GPLv2, see the COPYING file
|
|
|
|
|
in the source distribution for its full text.
|
|
|
|
|
*/
|
|
|
|
|
|
2021-04-14 01:34:47 +00:00
|
|
|
#include "config.h" // IWYU pragma: keep
|
Add a platform for Performance Co-Pilot (PCP) metrics
This introduces an initial platform for extracting metrics
using the PCP performance metrics API - PMAPI(3). It can
be used via the --enable-pcp=yes configure option.
So far I've added support for live localhost metrics only,
and only using pre-defined metrics already found in htop.
If available, all sampling is performed by pmcd(1) - else,
we fallback to htop doing the metric sampling itself (all
below the PMAPI). When pmcd is used, it may be configured
to run children with elevated privileges, so htop does not
need to be setuid (authentication with pmcd is available).
Additionally, the PMAPI allows us to support archives (for
historical analysis and for automated regression tests in
htop). We'll need platform-specific command line argument
additions, which isn't yet feasible in htop (not difficult
to add though).
The goal of this first version is minimal impact in terms
of modifying the htop codebase, to introduce key ideas in
PCP (metric namespace, metadata, APIs and so on) and give
us something to discuss, experiment with and build on.
2021-02-17 03:43:56 +00:00
|
|
|
|
|
|
|
|
#include <stdbool.h>
|
|
|
|
|
|
|
|
|
|
#include "Object.h"
|
|
|
|
|
#include "Process.h"
|
|
|
|
|
#include "Settings.h"
|
|
|
|
|
|
PCP: support for 'dynamic columns' added at runtime
Implements support for arbitrary Performance Co-Pilot
metrics with per-process instance domains to form new
htop columns. The column-to-metric mappings are setup
using configuration files which will be documented via
man pages as part of a follow-up commit.
We provide an initial set of column configurations so
as to provide new capabilities to pcp-htop: including
configs for containers, open fd counts, scheduler run
queue time, tcp/udp bytes/calls sent/recv, delay acct,
virtual machine guests, detailed virtual memory, swap.
Note there is a change to the configuration file path
resolution algorithm introduced for 'dynamic meters'.
First, look in any custom PCP_HTOP_DIR location. Then
iterate, in priority order, users home directory, then
local sysadmins files in /etc/pcp/htop, then readonly
configuration files below /usr/share/pcp/htop. This
final location becomes the preferred place for our own
shipped meter and column files.
The Settings file (htoprc) writing code is updated to
not using the numeric identifier for dynamic columns.
The same strategy used for dynamic meters is used here
where we write Dynamic(name) so the name can be setup
once more at start. Regular (static) columns writing
to htoprc - i.e. numerically indexed - is unchanged.
2021-07-11 01:11:29 +00:00
|
|
|
#include "pcp/Platform.h"
|
|
|
|
|
|
2021-04-14 01:34:47 +00:00
|
|
|
|
Add a platform for Performance Co-Pilot (PCP) metrics
This introduces an initial platform for extracting metrics
using the PCP performance metrics API - PMAPI(3). It can
be used via the --enable-pcp=yes configure option.
So far I've added support for live localhost metrics only,
and only using pre-defined metrics already found in htop.
If available, all sampling is performed by pmcd(1) - else,
we fallback to htop doing the metric sampling itself (all
below the PMAPI). When pmcd is used, it may be configured
to run children with elevated privileges, so htop does not
need to be setuid (authentication with pmcd is available).
Additionally, the PMAPI allows us to support archives (for
historical analysis and for automated regression tests in
htop). We'll need platform-specific command line argument
additions, which isn't yet feasible in htop (not difficult
to add though).
The goal of this first version is minimal impact in terms
of modifying the htop codebase, to introduce key ideas in
PCP (metric namespace, metadata, APIs and so on) and give
us something to discuss, experiment with and build on.
2021-02-17 03:43:56 +00:00
|
|
|
#define PROCESS_FLAG_LINUX_CGROUP 0x0800
|
|
|
|
|
#define PROCESS_FLAG_LINUX_OOM 0x1000
|
|
|
|
|
#define PROCESS_FLAG_LINUX_SMAPS 0x2000
|
|
|
|
|
#define PROCESS_FLAG_LINUX_CTXT 0x4000
|
|
|
|
|
#define PROCESS_FLAG_LINUX_SECATTR 0x8000
|
|
|
|
|
|
|
|
|
|
typedef struct PCPProcess_ {
|
|
|
|
|
Process super;
|
PCP: support for 'dynamic columns' added at runtime
Implements support for arbitrary Performance Co-Pilot
metrics with per-process instance domains to form new
htop columns. The column-to-metric mappings are setup
using configuration files which will be documented via
man pages as part of a follow-up commit.
We provide an initial set of column configurations so
as to provide new capabilities to pcp-htop: including
configs for containers, open fd counts, scheduler run
queue time, tcp/udp bytes/calls sent/recv, delay acct,
virtual machine guests, detailed virtual memory, swap.
Note there is a change to the configuration file path
resolution algorithm introduced for 'dynamic meters'.
First, look in any custom PCP_HTOP_DIR location. Then
iterate, in priority order, users home directory, then
local sysadmins files in /etc/pcp/htop, then readonly
configuration files below /usr/share/pcp/htop. This
final location becomes the preferred place for our own
shipped meter and column files.
The Settings file (htoprc) writing code is updated to
not using the numeric identifier for dynamic columns.
The same strategy used for dynamic meters is used here
where we write Dynamic(name) so the name can be setup
once more at start. Regular (static) columns writing
to htoprc - i.e. numerically indexed - is unchanged.
2021-07-11 01:11:29 +00:00
|
|
|
|
|
|
|
|
/* default result offset to use for searching proc metrics */
|
|
|
|
|
unsigned int offset;
|
|
|
|
|
|
Add a platform for Performance Co-Pilot (PCP) metrics
This introduces an initial platform for extracting metrics
using the PCP performance metrics API - PMAPI(3). It can
be used via the --enable-pcp=yes configure option.
So far I've added support for live localhost metrics only,
and only using pre-defined metrics already found in htop.
If available, all sampling is performed by pmcd(1) - else,
we fallback to htop doing the metric sampling itself (all
below the PMAPI). When pmcd is used, it may be configured
to run children with elevated privileges, so htop does not
need to be setuid (authentication with pmcd is available).
Additionally, the PMAPI allows us to support archives (for
historical analysis and for automated regression tests in
htop). We'll need platform-specific command line argument
additions, which isn't yet feasible in htop (not difficult
to add though).
The goal of this first version is minimal impact in terms
of modifying the htop codebase, to introduce key ideas in
PCP (metric namespace, metadata, APIs and so on) and give
us something to discuss, experiment with and build on.
2021-02-17 03:43:56 +00:00
|
|
|
unsigned long int cminflt;
|
|
|
|
|
unsigned long int cmajflt;
|
|
|
|
|
unsigned long long int utime;
|
|
|
|
|
unsigned long long int stime;
|
|
|
|
|
unsigned long long int cutime;
|
|
|
|
|
unsigned long long int cstime;
|
|
|
|
|
long m_share;
|
|
|
|
|
long m_pss;
|
|
|
|
|
long m_swap;
|
|
|
|
|
long m_psswp;
|
|
|
|
|
long m_trs;
|
|
|
|
|
long m_drs;
|
|
|
|
|
long m_lrs;
|
|
|
|
|
long m_dt;
|
|
|
|
|
|
|
|
|
|
/* Data read (in kilobytes) */
|
|
|
|
|
unsigned long long io_rchar;
|
|
|
|
|
|
|
|
|
|
/* Data written (in kilobytes) */
|
|
|
|
|
unsigned long long io_wchar;
|
|
|
|
|
|
|
|
|
|
/* Number of read(2) syscalls */
|
|
|
|
|
unsigned long long io_syscr;
|
|
|
|
|
|
|
|
|
|
/* Number of write(2) syscalls */
|
|
|
|
|
unsigned long long io_syscw;
|
|
|
|
|
|
|
|
|
|
/* Storage data read (in kilobytes) */
|
|
|
|
|
unsigned long long io_read_bytes;
|
|
|
|
|
|
|
|
|
|
/* Storage data written (in kilobytes) */
|
|
|
|
|
unsigned long long io_write_bytes;
|
|
|
|
|
|
|
|
|
|
/* Storage data cancelled (in kilobytes) */
|
|
|
|
|
unsigned long long io_cancelled_write_bytes;
|
|
|
|
|
|
|
|
|
|
/* Point in time of last io scan (in seconds elapsed since the Epoch) */
|
|
|
|
|
unsigned long long io_last_scan_time;
|
|
|
|
|
|
|
|
|
|
double io_rate_read_bps;
|
|
|
|
|
double io_rate_write_bps;
|
|
|
|
|
char* cgroup;
|
|
|
|
|
unsigned int oom;
|
|
|
|
|
unsigned long long int delay_read_time;
|
|
|
|
|
unsigned long long cpu_delay_total;
|
|
|
|
|
unsigned long long blkio_delay_total;
|
|
|
|
|
unsigned long long swapin_delay_total;
|
|
|
|
|
float cpu_delay_percent;
|
|
|
|
|
float blkio_delay_percent;
|
|
|
|
|
float swapin_delay_percent;
|
|
|
|
|
unsigned long ctxt_total;
|
|
|
|
|
unsigned long ctxt_diff;
|
|
|
|
|
char* secattr;
|
|
|
|
|
unsigned long long int last_mlrs_calctime;
|
|
|
|
|
} PCPProcess;
|
|
|
|
|
|
|
|
|
|
extern const ProcessFieldData Process_fields[LAST_PROCESSFIELD];
|
|
|
|
|
|
|
|
|
|
extern const ProcessClass PCPProcess_class;
|
|
|
|
|
|
|
|
|
|
Process* PCPProcess_new(const Settings* settings);
|
|
|
|
|
|
|
|
|
|
void Process_delete(Object* cast);
|
|
|
|
|
|
|
|
|
|
bool Process_isThread(const Process* this);
|
|
|
|
|
|
|
|
|
|
#endif
|