Skip to content

Commit

Permalink
change opcm -> intel pointers where applicable
Browse files Browse the repository at this point in the history
Change-Id: I5eab47f10b4530473eb85c4bbe58b7857bd3db9e
  • Loading branch information
rdementi committed May 3, 2024
1 parent 4d60a50 commit b2a742b
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ PCM provides a number of command-line utilities for real-time monitoring:

- **pcm-sensor-server** : pcm collector exposing metrics over http in JSON or Prometheus (exporter text based) format ([how-to](doc/PCM-EXPORTER.md)). Also available as a [docker container](doc/DOCKER_README.md). More info about Global PCM events is [here](doc/PCM-SENSOR-SERVER-README.md).
- **pcm-memory** : monitor memory bandwidth (per-channel and per-DRAM DIMM rank)
![pcm-memory output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-memory.x.JPG)
![pcm-memory output](https://raw.githubusercontent.com/wiki/intel/pcm/pcm-memory.x.JPG)
- **pcm-accel** : [monitor Intel® In-Memory Analytics Accelerator (Intel® IAA), Intel® Data Streaming Accelerator (Intel® DSA) and Intel® QuickAssist Technology (Intel® QAT) accelerators](doc/PCM_ACCEL_README.md)
![image](https://user-images.githubusercontent.com/25432609/218480696-42ade94f-e0c3-4000-9dd8-39a0e75a210e.png)

- **pcm-latency** : monitor L1 cache miss and DDR/PMM memory latency
- **pcm-pcie** : monitor PCIe bandwidth per-socket
- **pcm-iio** : monitor PCIe bandwidth per PCIe device

![pcm-iio output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-iio.png)
![pcm-iio output](https://raw.githubusercontent.com/wiki/intel/pcm/pcm-iio.png)
- **pcm-numa** : monitor local and remote memory accesses
- **pcm-power** : monitor sleep and energy states of processor, Intel(r) Quick Path Interconnect, DRAM memory, reasons of CPU frequency throttling and other energy-related metrics
- **pcm-tsx**: monitor performance metrics for Intel(r) Transactional Synchronization Extensions
Expand All @@ -50,7 +50,7 @@ PCM provides a number of command-line utilities for real-time monitoring:

Graphical front ends:
- **pcm Grafana dashboard** : front-end for Grafana (in [scripts/grafana](scripts/grafana) directory). Full Grafana Readme is [here](scripts/grafana/README.md)
![pcm grafana output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-dashboard.png)
![pcm grafana output](https://raw.githubusercontent.com/wiki/intel/pcm/pcm-dashboard.png)
- **pcm-sensor** : front-end for KDE KSysGuard
- **pcm-service** : front-end for Windows perfmon

Expand All @@ -65,7 +65,7 @@ Building PCM Tools
Clone PCM repository with submodules:

```
git clone --recursive https://github.com/opcm/pcm.git
git clone --recursive https://github.com/intel/pcm.git
```

or clone the repository first, and then update submodules with:
Expand Down
6 changes: 3 additions & 3 deletions doc/DOCKER_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ How To Run Intel(r) Performance Counter Monitor Server Container from GitHub Con

As root user:
1. ``modprobe msr``
2. ``docker run -d --name pcm --privileged -p 9738:9738 ghcr.io/opcm/pcm`` (GitHub Container repository) or ``docker run -d --name pcm --privileged -p 9738:9738 opcm/pcm`` (Dockerhub repository)
- the container can also be run with limited capabilities without the privileged mode: ``docker run -d --name pcm --cap-add=SYS_ADMIN --cap-add=SYS_RAWIO --device=/dev/cpu --device=/dev/mem -v /sys/firmware/acpi/tables/MCFG:/pcm/sys/firmware/acpi/tables/MCFG:ro -v /proc/bus/pci/:/pcm/proc/bus/pci/ -v /proc/sys/kernel/nmi_watchdog:/pcm/proc/sys/kernel/nmi_watchdog -v /sys:/sys:rw -p 9738:9738 ghcr.io/opcm/pcm`` (there is also a docker-compose file containing these options: https://raw.githubusercontent.com/opcm/pcm/master/docker-compose.yml)
2. ``docker run -d --name pcm --privileged -p 9738:9738 ghcr.io/intel/pcm`` (GitHub Container repository) or ``docker run -d --name pcm --privileged -p 9738:9738 opcm/pcm`` (Dockerhub repository)
- the container can also be run with limited capabilities without the privileged mode: ``docker run -d --name pcm --cap-add=SYS_ADMIN --cap-add=SYS_RAWIO --device=/dev/cpu --device=/dev/mem -v /sys/firmware/acpi/tables/MCFG:/pcm/sys/firmware/acpi/tables/MCFG:ro -v /proc/bus/pci/:/pcm/proc/bus/pci/ -v /proc/sys/kernel/nmi_watchdog:/pcm/proc/sys/kernel/nmi_watchdog -v /sys:/sys:rw -p 9738:9738 ghcr.io/intel/pcm`` (there is also a docker-compose file containing these options: https://raw.githubusercontent.com/intel/pcm/master/docker-compose.yml)

This will start pcm-sensor-server container exposing CPU metrics from the whole system at port 9738

The URLs of the docker container repositories:
- https://github.com/opcm/pcm/pkgs/container/pcm
- https://github.com/intel/pcm/pkgs/container/pcm
- https://hub.docker.com/r/opcm/pcm
6 changes: 3 additions & 3 deletions doc/PCM-EXPORTER.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
pcm-sensor-server is a collector exposing Intel processor metrics over http in JSON or Prometheus (exporter text based) format. Also [available as a docker container](DOCKER_README.md).

Installation on target system to be analyzed:
1. [Build](https://github.com/opcm/pcm#building-pcm-tools) or [download](https://github.com/opcm/pcm#downloading-pre-compiled-pcm-tools) pcm tools
2. As root, start pcm-sensor-server: `sudo ./pcm-sensor-server` or as non-root https://github.com/intel-innersource/applications.analyzers.pcm#executing-pcm-tools-under-non-root-user-on-linux
1. [Build](https://github.com/intel/pcm#building-pcm-tools) or [download](https://github.com/intel/pcm#downloading-pre-compiled-pcm-tools) pcm tools
2. As root, start pcm-sensor-server: `sudo ./pcm-sensor-server` or as non-root https://github.com/intel/pcm#executing-pcm-tools-under-non-root-user-on-linux

Alternatively one can start [pcm-sensor-server as a container from docker hub](DOCKER_README.md).

Expand Down Expand Up @@ -33,4 +33,4 @@ The default output of pcm-sensor-server endpoint in a browser:

The PCM exporter can be used together with Grafana to obtain these Intel processor metrics (see [how-to](../scripts/grafana/README.md)):

![pcm grafana output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-dashboard-full.png)
![pcm grafana output](https://raw.githubusercontent.com/wiki/intel/pcm/pcm-dashboard-full.png)
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: '2.0'
services:
pcm:
image: opcm/pcm
image: ghcr.io/intel/pcm:latest
ports:
- "9738:9738"
volumes:
Expand Down
2 changes: 1 addition & 1 deletion pcm-kubernetes.yaml.experimental
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ spec:
spec:
automountServiceAccountToken: false
containers:
- image: ghcr.io/opcm/pcm:latest
- image: ghcr.io/intel/pcm:latest
env:
- name: PCM_NO_MSR
value: "1"
Expand Down
2 changes: 1 addition & 1 deletion pcm.spec
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Release: 0
Summary: Intel(r) Performance Counter Monitor
Group: System/Monitoring
License: BSD-3-Clause
Url: https://github.com/opcm/pcm/archive
Url: https://github.com/intel/pcm/archive
Source: master.zip
BuildRoot: %{_tmppath}/%{name}-%{version}-build
AutoReqProv: on
Expand Down
2 changes: 1 addition & 1 deletion scripts/grafana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ Installation of the grafana front-end (can be on any *host* system with connecti
5. You can also stop and delete the containers when needed: `sudo sh stop.sh`
![pcm grafana output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-dashboard-full.png)
![pcm grafana output](https://raw.githubusercontent.com/wiki/intel/pcm/pcm-dashboard-full.png)

0 comments on commit b2a742b

Please sign in to comment.